接口功能介绍
创建 NAT 网关
接口约束
URI
POST /v4/vpc/create-nat-gateway
请求参数
请求体 body 参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 |
|---|---|---|---|---|
| regionID | String | 是 | 区域id | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| vpcID | String | 是 | 需要创建 NAT 网关的 VPC 的 ID | vpc-bp1xxxu |
| spec | Integer | 是 | 规格 1~4, 1表示小型, 2表示中型, 3表示大型, 4表示超大型 | 1 |
| name | String | 是 | 支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 - 32 | acl11 |
| description | String | 否 | 支持拉丁字母、中文、数字, 特殊字符：~!@#$%^&*()_-+= <>?:"{} | ,./;'[]·~！@#￥%……&*（） ——-+={} |
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| cycleType | String | 是 | 订购类型：month / year/ on_demand | month |
| cycleCount | Integer | 否 | 订购时长, 当 cycleType = month, 支持续订 1 - 11 个月; 当 cycleType = year, 支持续订 1 - 3 年 | 1 |
| azName | String | 是 | 可用区名称 | az1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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 | object | 返回创建结果。 |
表 returnObj
| 参数名 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| masterOrderID | String | 55d531d7bf2d47658897c42ffb918423 | 订单id。 |
| masterOrderNO | String | 20221021191602644224 | 订单编号, 可以为 null。 |
| masterResourceStatus | String | started | 资源状态。 |
| masterResourceID | String | d48cace2da7b4c81b4c0444768a04608 | 可以为 null。 |
| regionID | String | 81f7728662dd11ec810800155d307d5b | 可用区id。 |
| natGatewayID | String | nat 网关 ID | natgw-xxxx |
请求示例
POST /v4/vpc/create-nat-gateway
请求体 body
{
"name": "提测测试流程",
"description": "开始提测了",
"vpcID": "vpc-xxxxx",
"spec": 1,
"regionID": "81f7728662dd11ec810800155d307d5b",
"clientToken": "xxxxxx",
"cycleType": "month",
"cycleCount": 1,
"azName": "az1"
}
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": {
"masterOrderID": "ee508bcc586211ed961bacde48001122",
"masterOrderNO": null,
"masterResourceID": "d48cace2da7b4c81b4c0444768a04608",
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"natGatewayID": "natgw-xxxx"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
