接口功能介绍
创建SNAT规则
接口约束
需要先创建私网NAT
接口是否审批
否
URI
POST /v4/privatenat/create-snat
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
请求体body参数|
参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 区域id 79fa97e3-c48b-xxxx-9f46-6a13d8163678 natGatewayID 是 String 私网NAT ID natgw-aldjlfsfd snatIPs 是 Array of Strings IP地址,必须在中转网段指定的网络范围内 ["192.168.8.56"] sourceCIDR 否 String 源CIDR和sourceSubnetID必须传一个 192.168.2.0/24 sourceSubnetID 否 String 源子网ID和sourceCIDR必须传一个 subnet-xxxx description 否 String 支持拉丁字母、中文、数字, 特殊字符:!@#$%^&\*()\_\-+= <>?:\"{}\|,.\/;'[\]·@#¥%……&\*() ——\-+={} | 《》?:“”【】、;‘',。、,不能以 http: / https: 开头,长度 0 - 128 这是一个描述
响应参数
响应参数 | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | ||
message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | ||
description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | ||
errorCode | String | statusCode为900时为业务细分错误码,三段式:product.module.code; statusCode为800时为SUCCESS | SUCCESS | ||
returnObj | Object | 返回创建结果 |
表 returnObj | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | ||
message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | ||
description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | ||
errorCode | String | statusCode为900时为业务细分错误码,三段式:product.module.code; statusCode为800时为SUCCESS | SUCCESS | ||
returnObj | Object | 返回创建结果 | |||
snatID | String | SNAT规则的ID。 | sgwr-xxxx |
枚举参数
无
请求头header示例
无
请求url示例
POST /openapi/v4/privatenat/create-snat
请求体body示例
{
"natGatewayID":"natgw-1o5sdqb7i2",
"snatIPs":[
"192.168.1.22"
],
"sourceCIDR":[
"10.0.11.0/24"
],
"description":"This is a description",
"regionID":"81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description":"成功",
"returnObj":{
"snatID":"sgwr-xxxxx"
}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
请参考 错误码说明。