接口功能介绍
查询私网NAT
接口约束
无
接口是否审批
否
URI
GET /v4/privatenat/list
Content-Type
application/json
路径参数
无
Query参数
| Query参数 | 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域id | 81f7728662dd11ec810800155d307d5b | |
| natGatewayID | 否 | String | 要查询的私网NAT的ID。 | ngw-bp1uewa15k4iy5770 | |
| pageNumber | 否 | Integer | 列表的页码，默认值为1。 | 11 | |
| pageNo | 否 | Integer | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 | |
| pageSize | 否 | Integer | 分页查询时每页的行数，最大值为50，默认值为10。 | 10 |
请求头header参数
无
请求体body参数
无
响应参数
| 响应参数 | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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 | Array of Objects | 返回结果 | returnObj | ||
| totalCount | Integer | 列表条目数 | 20 | ||
| currentCount | Integer | 分页查询时每页的行数。 | 4 | ||
| totalPage | Integer | 总页数 | 5 |
| 表 returnObj | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| natGatewayID | String | nat 网关 id | natgw-5t4c4gvwhb | ||
| name | String | nat 网关名字 | natgw-xxx | ||
| description | String | nat 网关描述 | xxxx | ||
| vpcID | String | 虚拟私有云 id | vpc-xxx | ||
| vpcName | String | 虚拟私有云名字 | test-vpc | ||
| subnetID | String | 子网 id | subnet-xxxxx | ||
| subnetName | String | 子网名称 | test-subnet | ||
| state | String | 私网运行状态: running 表示运行中，freeze表示冻结，expired表示已过期 | running | ||
| spec | String | 规格取值: small, medium, large, xlarge | large | ||
| projectID | String | 项目ID | 0 | ||
| projectName | String | 项目名称 | test | ||
| azID | String | 可用区ID | 0 | ||
| createDate | String | 过期时间 | 2022-11-02T02:29:43Z |
枚举参数
无
请求头header示例
无
请求url示例
GET /v4/privatenat/list?regionID=81f7728662dd11ec810800155d307d5b
请求体body示例
无
响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description":"",
"returnObj":[
{
"ID":"natgw-5t4c4gvwhb",
"name":"natgw-jojo",
"description":"",
"natGatewayID":"natgw-5t4c4gvwhb",
"azID":"az1",
"state":"running",
"vpcID":"vpc-px0u1h710i",
"vpcName":"jojo-vpc",
"spec":"large",
"subnetID":"subnet-xxxxxxx",
"subnetName":"subnet-name",
"createDate":"2022-10-02T02:29:43Z",
"projectID":"0",
"projectName":"default"
}
],
"totalPage":1,
"currentCount":1,
"totalCount":1
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
请参考 错误码说明。
