調(diào)用ListNatIps接口查詢NAT IP地址列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無授權(quán)信息透出。
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 要查詢的 NAT IP 地址列表所屬 NAT 網(wǎng)關(guān)實(shí)例的地域 ID。 您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 | eu-central-1 |
NatGatewayId | string | 是 | 要查詢 NAT IP 地址所屬 NAT 網(wǎng)關(guān)實(shí)例 ID。 | ngw-gw8v16wgvtq26vh59**** |
NatIpCidr | string | 否 | 要查詢的 NAT IP 地址所在的地址段。 | 192.168.0.0/24 |
DryRun | boolean | 否 | 是否只預(yù)檢此次請(qǐng)求。取值:
| false |
ClientToken | string | 否 | 客戶端 Token,用于保證請(qǐng)求的冪等性。 由客戶端生成該參數(shù)值,要保證在不同請(qǐng)求間唯一,最大值不超過 64 個(gè) ASCII 字符。 說明
若您未指定,則系統(tǒng)自動(dòng)使用 API 請(qǐng)求的 RequestId 作為 ClientToken 標(biāo)識(shí)。每次 API 請(qǐng)求的 RequestId 可能不一樣。
| 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
NatIpStatus | string | 否 | 查詢的 NAT IP 地址的狀態(tài)。取值:
| Available |
NextToken | string | 否 | 是否擁有下一次查詢的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd****f84eb48b699f0a4883 |
MaxResults | string | 否 | 分批次查詢時(shí)每次顯示的條目數(shù)。取值范圍:1~100,默認(rèn)值為 20。 | 20 |
NatIpName | array | 否 | 要查詢的 NAT IP 地址的名稱。N 取值為 1~20。 | |
string | 否 | 要查詢的 NAT IP 地址的名稱。N 取值為 1~20。 | test | |
NatIpIds | array | 否 | 要查詢的 NAT IP 地址實(shí)例 ID。N 取值為 1~20。 | |
string | 否 | 要查詢的 NAT IP 地址實(shí)例 ID。N 取值為 1~20。 | vpcnatcidr-gw8ov42ei6xh1jys2**** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "7E78CEEA-BF8F-44D1-9DCD-D9141135B71E",
"TotalCount": "1",
"NatIps": [
{
"IsDefault": true,
"NatIp": "192.168.0.126",
"NatIpCidr": "192.168.0.0/24",
"NatIpId": "vpcnatip-gw8a863sut1zijxh0****",
"NatIpDescription": "default",
"NatGatewayId": "ngw-gw8v16wgvtq26vh59****",
"NatIpName": "default",
"NatIpStatus": "Available"
}
]
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-07-23 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-03-01 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |