调用ListNatIpCidrs接口查询NAT IP地址段列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 需要查询的NAT IP地址段所属VPC NAT网关的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 | eu-central-1 |
NatGatewayId | string | 是 | 要查询NAT IP地址段的VPC NAT网关的实例ID。 | ngw-gw8v16wgvtq26vh59**** |
NatIpCidr | string | 否 | 要查询的NAT IP地址段。 | 172.16.0.0/24 |
DryRun | boolean | 否 | 是否只预检此次请求,取值:
| false |
ClientToken | string | 否 | 客户端Token,用于保证请求的幂等性。 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。 说明
若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
| 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
NatIpCidrStatus | string | 否 | 要查询的NAT IP地址段的状态。取值:Available,表示可用状态。 | Available |
NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:
| caeba0bbb2be03f84eb48b699f0a4883 |
MaxResults | string | 否 | 分批次查询时每次显示的条目数。取值范围:1~100,默认值为20。 | 20 |
NatIpCidrName | array | 否 | 要查询的NAT IP地址段的名称。N取值为1~20。 | |
string | 否 | 要查询的NAT IP地址段的名称。N取值为1~20。 | cidrname | |
NatIpCidrs | array | 否 | 要查询的NAT IP地址段。N取值为1~20。 | |
string | 否 | 要查询的NAT IP地址段。N取值为1~20。 | 172.16.0.0/24 |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "7479A224-4A28-4895-9604-11F48BCE6A88",
"TotalCount": "1",
"NatIpCidrs": [
{
"CreationTime": "2021-06-28T20:50Z",
"NatIpCidrId": "vpcnatcidr-gw8ov42ei6xh1jys2****",
"IsDefault": true,
"NatIpCidrStatus": "Available",
"NatIpCidrName": "Name",
"NatIpCidr": "172.16.0.0/24",
"NatGatewayId": "ngw-gw8v16wgvtq26vh59****",
"NatIpCidrDescription": "test"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-03-01 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|