DescribePublicIpAddress - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the public IP address range of a virtual private cloud (VPC) in a region.

Operation description

You cannot query the range of public IP addresses of a classic network by calling the DescribePublicIpAddress operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 100.	100
RegionId	string	Yes	The region that you want to query. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45
Success	boolean	Indicates whether the call is successful. Valid values: true false	true
Code	string	The HTTP status codes returned.	200
Message	string	The response messages.	test
PageSize	integer	The number of entries per page.	100
PageNumber	integer	The page number.	1
TotalCount	integer	The number of returned entries.	1
RegionId	string	The ID of the region to which the public IP addresses belong.	cn-hangzhou
PublicIpAddress	array	The range of the public IP addresses of the VPC in the region.
ipAddress	string	The range of the public IP addresses of the VPC in the region.	101.37.XX.XX/24

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-24	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-03-12	The Error code has changed	View Change Details
2024-02-26	API Description Update. The Error code has changed	View Change Details
2023-05-15	The Error code has changed	View Change Details