1)接口功能介绍
查询DNAT条目
2)接口约束
查询要添加必传字段nodeCode
3)URI
GET /v1/describeForwardTableEntries
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘集群Id | cn-guangzhou3 | |
natGatewayId | 是 | String | NAT网关Id , 通过DescribeNatGateways接口获取 | 234 | |
eip | 否 | String | 按照公网Ip查找 , 注意是弹性公网IP的ip字段,不是id字段 | 192.168.1.105 | |
internalIp | 否 | String | 按照私网Ip查找 。私网Ip,即某EVM实例的内网IP。由DescribeInstances虚机实例查询接口获取,字段:DescribeInstancesResponse.data.vmInfoList.networkInfo.subnetInfo.ip | 10.0.0.3 | |
state | 否 | String | 按照DNAT状态查找。取值范围:ACTIVE--运行中(默认值),DESTROYING--删除中,CAN_NOT_USE_FOR_NOW--暂不可用,ALL--所有状态。详见DescribeForwardTableEntriesRequest.DNatStateType常量类 | ACTIVE | |
protocolType | 否 | String | 按协议类型查找。取值范围:DNAT_PROTOCOL_ALL--查询所有协议类型,DNAT_PROTOCOL_ANY--全端口协议,DNAT_PROTOCOL_TCP--TCP协议,DNAT_PROTOCOL_UDP--UDP协议。 | DNAT_PROTOCOL_ANY | |
page | 否 | Integer | 当前页数 | 1 | |
perPageNum | 否 | Integer | 每页显示的记录条数 | 5 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | ||
data | 是 | object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | string | 状态描述 | Success | |
code | 是 | string | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalPage | 是 | Integer | 1 | 总页数 | |
total | 是 | Integer | 6 | 记录总个数 | |
page | 是 | Integer | 1 | 当前页数 | |
perPageNum | 是 | Integer | 10 | 每页显示的记录条数 | |
dNatEntries | 是 | List\ | * | NAT网关信息列表 | dNatEntries |
表 dNatEntries
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
forwardEntryId | 是 | String | DNAT条目ID | 1523 | |
protocolType | 是 | String | 协议类型 | DNAT_PROTOCOL_TCP | |
eip | 是 | String | 公网IP | 192.168.1.105 | |
dport | 是 | String | 公网端口.取值范围:0-65535,0代表所有端口。 | 8080 | |
internalIp | 是 | String | 私网IP | 10.0.0.3 | |
internalPort | 是 | String | 私网端口号.取值范围:0-65535,0代表所有端口。 | 8080 | |
state | 是 | String | DNAT条目状态 | ACTIVE | |
description | 是 | String | DNAT条目描述 | 11 | |
createTime | 是 | String | 创建时间,(Unix时间戳,秒) | 1611041175 |
6)请求示例
https://host/v1/describeForwardTableEntries?natGatewayId=&nodeCode=&eip=&internalIp=&state=&protocolType=&page=&perPageNum=
7)响应示例
{
"data": {
"page": 1,
"perPageNum": 10,
"totalPage": 1,
"natList": [
{
"natGatewayId": "42",
"name": "myTestGateWay01",
"state": "ACTIVE",
"vpcName": "vpc-sze2",
"createTime": 1611826261,
"priceType": "ANNUAL_OR_MONTHLY",
"description": "ecxSdkExample"
},
{
"natGatewayId": "47",
"name": "myTestGateWay02",
"state": "ACTIVE",
"vpcName": "vpc-gheb",
"createTime": 1611141313,
"priceType": "ANNUAL_OR_MONTHLY",
"description": ""
}
]
},
"requestId": "01edea53-d489-48cc-95c7-01f2d598793e",
"status": {
"code": "Success",
"message": "Success"
}
}
8)状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |