调用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 | Forbbiden | User not authorized to operate on the specified resource. | 您没有权限操作该资源,请您申请操作权限后再试。 |
访问错误中心查看更多错误码。