調用DescribePublicIpAddress介面查詢指定地區中位於專用網路的公網IP地址的範圍。
使用說明
您不能通過DescribePublicIpAddress介面查詢位於傳統網路中的公網IP的範圍。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
Action | String | 是 | DescribePublicIpAddress | 系統規定參數。取值:DescribePublicIpAddress。 |
PageNumber | Integer | 否 | 1 | 列表的頁碼,預設值為1。 |
PageSize | Integer | 否 | 100 | 分頁查詢時每頁的行數。 取值範圍:1~100。預設值:100。 |
RegionId | String | 是 | cn-hangzhou | 指定查詢的地區。 您可以通過調用DescribeRegions介面擷取地區ID。 |
返回資料
名稱 | 類型 | 樣本值 | 描述 |
RequestId | String | 54B48E3D-DF70-471B-AA93-08E683A1B45 | 請求ID。 |
Success | Boolean | true | 是否查詢成功。
|
Code | String | 200 | 狀態代碼。 |
Message | String | test | 響應資訊。 |
PageSize | Integer | 100 | 分頁查詢時每頁的行數。 |
PageNumber | Integer | 1 | 列表的頁碼。 |
TotalCount | Integer | 1 | 列表條目數。 |
RegionId | String | cn-hangzhou | 公網IP所屬地區ID。 |
PublicIpAddress | Array of String | 101.37.XX.XX/24 | 指定地區中位於專用網路的公網IP地址的範圍。 |
樣本
請求樣本
http(s)://[Endpoint]/?Action=DescribePublicIpAddress
&PageNumber=1
&PageSize=100
&RegionId=cn-hangzhou
&公用請求參數
正常返回樣本
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribePublicIpAddressResponse>
<RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
<Success>true</Success>
<Code>200</Code>
<Message>test</Message>
<PageSize>100</PageSize>
<PageNumber>1</PageNumber>
<TotalCount>1</TotalCount>
<RegionId>cn-hangzhou</RegionId>
<PublicIpAddress>101.37.XX.XX/24</PublicIpAddress>
</DescribePublicIpAddressResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B45",
"Success" : true,
"Code" : "200",
"Message" : "test",
"PageSize" : 100,
"PageNumber" : 1,
"TotalCount" : 1,
"RegionId" : "cn-hangzhou",
"PublicIpAddress" : [ "101.37.XX.XX/24" ]
}
錯誤碼
HttpCode | 錯誤碼 | 錯誤資訊 | 描述 |
403 | Forbidden | User not authorized to operate on the specified resource. | 您沒有許可權操作指定資源,請申請許可權後再操作。 |
訪問錯誤中心查看更多錯誤碼。