1)接口功能介绍
查询NAT网关。
2)接口约束
查询nodeCode边缘集群Id必须正确。
3)URI
GET /v1/describeNatGateways。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id | cn-guangzhou3 | |
page | 否 | Integer | 当前页数,默认值为1 | 1 | |
perPageNum | 否 | Integer | 每页显示的记录条数,默认值为10 | 10 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalPage | 是 | Integer | 1 | 总页数 | |
total | 是 | Integer | 6 | 记录总个数 | |
page | 是 | Integer | 1 | 当前页数 | |
perPageNum | 是 | Integer | 10 | 每页显示的记录条数 | |
natList | 是 | List | * | NAT网关信息列表 | natList |
表 natList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
natGatewayId | 是 | String | NAT网关ID | 42 | |
name | 是 | String | NAT网关名称 | myNatGateway01 | |
state | 是 | String | Nat状态,ACTIVE-使用中,DELETED-已删除,CREATING-创建中,FAILED-创建失败,DELETING-删除中 | ACTIVE | |
createTime | 是 | String | 创建时间,(Unix时间戳,秒) | 1610612834 | |
priceType | 是 | String | NAT网关计费方式,ANNUAL_OR_MONTHLY-包年包月,PAY_FOR_USE-按需付费,FREE-免费 | PAY_FOR_USE | |
description | 是 | String | 描述 | 测试网关 | |
regionCluster | 是 | String | 集群地域信息 | ECX测试网关 | |
vpcId | 是 | Integer | vpcId | 10 | |
vpcName | 是 | String | vpc名称 | vpc-test01 |
6)请求示例
GET https://{host}/v1/describeNatGateways?nodeCode=yn-lincang-1&page=1&perPageNum=10
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"natList": [
{
"vpcId": 1145,
"natGatewayUid": "nat-ce1lbjmi15ho6kq6qjpg",
"name": "nat-eop-test",
"regionCluster": "云南-临沧1",
"state": "ACTIVE",
"natGatewayId": "1772",
"vpcName": "vpc-do-not-bond-vm",
"createTime": "1669551567",
"priceType": "FREE",
"description": ""
}
],
"totalRecord": 1,
"totalPage": 1,
"page": 1,
"perPageNum": 10
},
"requestId": "c34ca1e1-a829-4214-b39e-59c7f65b036c"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |