调用 DescribeNatIps 接口,查询满足指定条件的中转IP。
说明
私网NAT网关正在邀测中,如需试用,请联系客户经理。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeNatIps | 要执行的操作,取值:DescribeNatIps。 |
Version | String | 是 | 2020-04-01 | API的版本信息,当前版本为:2020-04-01。 |
NatGatewayId | String | 是 | ngw-2feq5xhimd88w59gp686**** | 私网NAT网关ID。 |
NatIpName | String | 否 | nat_ip_1 | 中转IP的名称。 |
NatIpIds.N | String | 否 | NatIpIds.1= vpcnatip-3a4b****&NatIpIds.2=vpcnat-5b4d7f**** | 中转IP的ID。
|
PageNumber | Integer | 否 | 1 | 列表的页码,默认值为1。 |
PageSize | Integer | 否 | 20 | 分页查询时每页的行数。取值范围:1~100。 默认值为20。 |
参数名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 2021062415303301022514515207C4**** | 请求ID。 |
TotalCount | Integer | 2 | 符合条件的中转IP总数。 |
PageNumber | Integer | 1 | 当前分页的页码。 |
PageSize | Integer | 20 | 当前分页的行数。 |
NatIps | Array of struct | - | 中转IP的详细信息。具体请参见下表“NatIps结构”。 |
NatIps 结构
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
NatIpId | String | vpcnatip-gw8y7q3cpk3fggs87**** | 中转IP的ID。 |
NatGatewayId | String | ngw-2feq5xhimd88w59gp686**** | 私网NAT网关ID。 |
NatIpName | String | nat_ip_1 | 中转IP的名称。 |
NatIpDescription | String | natip-1 | 中转IP的描述。 |
NatIp | String | 192.168.XX.34 | 中转IP的IP地址。 |
IsDefault | Bool | true | 是否为默认中转IP。
|
Status | String | Creating | 中转IP的状态。
|
GET /?Action=DescribeNatIps&Version=2020-04-01&NatGatewayId=ngw-2feq5xhimd88w59gp686**** HTTP/1.1 Host: open.volcengineapi.com ServiceName: natgateway Region: cn-beijing
{ "ResponseMetadata": { "RequestId": "2021062415303301022514515207C4****", "Action": "DescribeNatIps", "Version": "2020-04-01", "Service": "natgateway", "Region": "cn-beijing" }, "Result": { "RequestId": "2021062415303301022514515207C4****", "TotalCount": 2, "PageNumber": 1, "PageSize": 20, "NatIps": [ { "NatIpId": "vpcnatip-gw8y7q3cpk3fggs87****", "NatGatewayId": "ngw-2feq5xhimd88w59gp686****", "NatIpName": "nat_ip_1", "NatIpDescription": "natip-1", "NatIp":"192.168.XX.34", "IsDefault": true }, { "NatIpId": "vpcnatip-gw8y7q3cpk3fg666****", "NatGatewayId": "ngw-2feq5xhimd88w59gp686****", "NatIpName": "nat_ip_2", "NatIpDescription": "natip-2", "NatIp":"192.168.XX.12", "IsDefault": false, "Status":"Available" } ] } }
公共错误码,请参见 公共错误码 。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidPage.Malformed | The specified page is malformed. | 指定的分页参数不合法。 |
400 | LimitExceeded.NatIpId | You've reached the limit on the number of nat ip IDs that you can describe. | 已达到可查询的NAT IP地址ID数量上限。 |