接口功能介绍
创建私网NAT
接口约束
无
接口是否审批
否
URI
POST /v4/privatenat/create
Content-Type
application/json
路径参数
无
Query参数
无
请求头header参数
无
请求体body参数
参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 区域 id 79fa97e3-c48b-xxxx-9f46-6a13d8163678 projectID 是 String 项目ID 2256c561639d4ed9b9fb9009398914ad vpcID 是 String 需要创建 私网NAT 网关的 VPC 的ID vpc-bp1xxxu subnetID 是 String 需要创建私网NBAT网关的Subnet的ID subnet-xxxxx spec 是 String 规格, small 表示小型, medium 表示中型, large 表示大型, xlarge 表示超大型 small name 是 String 支持拉丁字母、中文、数字,下划线,连字符,中文 / 英文字母开头,不能以 http: / https: 开头,长度 2 - 32 acl11 description 否 String 支持拉丁字母、中文、数字, 特殊字符:!@#$%^&\*()\_\-+= <>?:\"{}\|,.\/;'[\]·@#¥%……&\*() ——\-+={} | 《》?:“”【】、;‘',。、,不能以 http: / https: 开头,长度 0 - 128 acl clientToken 是 String 客户端存根,用于保证订单幂等性, 长度 1 - 64 79fa97e3-c48b-xxxx-9f46-6a13d8163678 cycleType 是 String 订购类型:month / year month cycleCount 是 Integer 订购时长 3 azName 是 String 可用区名称 az1 autoRenew 否 Boolean 是否自动续约 true billMode 是 Integer 付费模式:2 - 按需,1 - 保周期 2 payVoucherPrice 否 String 代金券金额,支持到小数点后两位 1
响应参数
响应参数 | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
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 | 订单 id。 | 55d531d7bf2d47658897c42ffb918423 | ||
masterOrderNO | String | 订单编号, 可以为 null。 | 20221021191602644224 | ||
masterResourceStatus | String | 资源状态: started(启用) / renewed(续订) / refunded(退订) / destroyed(销毁) / failed(失败) / starting(正在启用) / changed(变配)/ expired(过期)/ unknown(未知) | started | ||
masterResourceID | String | 可以为 null。 | d48cace2da7b4c81b4c0444768a04608 | ||
regionID | String | 可用区 id。 | 81f7728662dd11ec810800155d307d5b | ||
natGatewayID | String | nat 网关 ID | natgw-xxx |
枚举参数
无
请求头header示例
无
请求url示例
无
请求体body示例
{
"name":"提测测试流程",
"description":"开始提测了",
"vpcID":"vpc-xxxxx",
"subnetID":"subnet-xxxxx",
"spec":"small",
"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 | 表示请求成功。 |
错误码
请参考错误码