接口功能介绍
创建 SNAT 规则
接口约束
需要先创建 NAT 网关
URI
POST /v4/vpc/create-snat-entry
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 区域id | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| natGatewayID | String | 是 | NAT网关ID | natgw-aldjlfsfd |
| sourceSubnetID | String | 否 | 子网id，【非自定义情况必传 sourceCIDR和sourceSubnetID二选一必传】｜ 5fe30709-93ef-522f-a1a0-d8c8f6803e0d | |
| sourceCIDR | String | 否 | 自定义输入VPC、交换机或ECS实例的网段，还可以输入任意网段。【自定义子网信息必传】】 | 10.1.1.0/24 |
| snatIps | Array of String | 是 | ["eip-p8cdvc4srg"] | 弹性公网IP集合 |
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| description | String | 否 | 支持拉丁字母、中文、数字, 特殊字符：~!@#$%^&*()_-+= <>?:"{} | ,./;'[]·~！@#￥%……&*（） ——-+={} |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| snat | Object | 业务数据 | 见下表 |
表 snat
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| status | String | 绑定状态，取值 in_progress / done | in_progress |
| message | String | 绑定状态提示信息 | 请使用相同请求，进行重试 |
| snatID | String | snat id, 当 status != done 时，snatID 为 null | null |
请求示例
POST /v4/vpc/create-snat-entry
请求体body
{
"natGatewayID":"natgw-1o5sdqb7i2",
"snatIps": ["eip-p8cdvc4srg"],
"sourceSubnetID":"5fe30709-93ef-522f-a1a0-d8c8f6803e0d",
"sourceCIDR":"",
"description":"aaa",
"regionID": "81f7728662dd11ec810800155d307d5b"
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"snat": {
"status": "in_progress",
"message": "请使用相同请求，进行重试",
"snatID": null
}
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
