文档

DescribePublicIpAddress - 查询专有网络中公网IP地址的范围

更新时间:

调用DescribePublicIpAddress接口查询指定地域中位于专有网络的公网IP地址的范围。

接口说明

您不能通过 DescribePublicIpAddress 接口查询位于经典网络中的公网 IP 的范围。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

分页查询时每页的行数。

取值范围:1~100。默认值:100

100
RegionIdstring

指定查询的地域。 您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
IpVersionstring

IP 协议的版本。取值:

  • ipv4(默认值):IPv4 协议。

  • ipv6:IPv6 协议。

ipv4

返回参数

名称类型描述示例值
object

返回请求列表。

RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
Successboolean

是否查询成功。

  • true:成功。

  • false:失败。

true
Codestring

状态码。

200
Messagestring

响应信息。

test
PageSizeinteger

分页查询时每页的行数。

100
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

1
RegionIdstring

公网 IP 所属地域 ID。

cn-hangzhou
PublicIpAddressarray

指定地域中位于专有网络的公网 IP 地址的范围。

string

指定地域中位于专有网络的公网 IP 地址的范围。

101.37.XX.XX/24

示例

正常返回示例

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"
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.IpVersionParam IpVersion illegal.非法参数:IpVersion。
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-24OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-03-12OpenAPI 错误码发生变更查看变更详情
2024-02-26OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-05-15OpenAPI 错误码发生变更查看变更详情