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

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribePublicIpAddress	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	列表的页码，默认值为 1。	1
PageSize	integer	否	分页查询时每页的行数。取值范围：1~100。默认值：100。	100
RegionId	string	是	指定查询的地域。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
IpVersion	string	否	IP 协议的版本。取值： ipv4（默认值）：IPv4 协议。 ipv6：IPv6 协议。	ipv4

返回参数

名称	类型	描述	示例值
	object	返回请求列表。
RequestId	string	请求 ID。	54B48E3D-DF70-471B-AA93-08E683A1B45
Success	boolean	是否查询成功。 true：成功。 false：失败。	true
Code	string	状态码。	200
Message	string	响应信息。	test
PageSize	integer	分页查询时每页的行数。	100
PageNumber	integer	列表的页码。	1
TotalCount	integer	列表条目数。	1
RegionId	string	公网 IP 所属地域 ID。	cn-hangzhou
PublicIpAddress	array	指定地域中位于专有网络的公网 IP 地址的范围。
ipAddress	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	错误码	错误信息	描述
400	IllegalParam.IpVersion	Param IpVersion illegal.	非法参数：IpVersion。
403	Forbidden	User not authorized to operate on the specified resource.	您没有权限操作指定资源，请申请权限后再操作。

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

变更历史

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