Query Secondary Public IP Addresses via API - ENS - Alibaba Cloud - ENS

Queries the secondary public IP addresses that have been created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeSecondaryPublicIpAddresses

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	The ID of the ENS edge zone.	cn-hangzhou-44
SecondaryPublicIpId	string	No	The ID of the secondary public IP address.	spi-5wys0pio93c9f9ukzj2f2fwyr
SecondaryPublicIpAddress	string	No	The secondary public IP address.	12.XXX.XXX.4
Isp	string	No	The Internet service provider (ISP). Valid values: cmcc: China Mobile. unicom: China Unicom. telecom: China Telecom.	unicom
EnsRegionIds	array	No	The array of ENS edge zone IDs. Array length: 1 to 100.
	string	No	The ID of the ENS edge zone.	cn-chengdu-telecom-4
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page for paging queries. Maximum value: 100. Default value: 10.	50

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page for paging queries.	50
TotalCount	integer	The total number of entries.	13
SecondaryPublicIpAddresses	array<object>	The list of secondary public IP addresses.
	object	The list of secondary public IP addresses.
CidrMask	integer	The CIDR mask of the IP address.	24
Gateway	string	The gateway.	12.XXX.XXX.1
SecondaryPublicIpAddress	string	The secondary public IP address.	12.XXX.XXX.4
Isp	string	The Internet service provider (ISP). Valid values: cmcc: China Mobile. unicom: China Unicom. telecom: China Telecom.	telecom
SecondaryPublicIpId	string	The ID of the secondary public IP address.	spi-5wys0pio93c9f9ukzj2f2fwyr
EnsRegionId	string	The ID of the ENS edge zone.	cn-beijing-15
CreationTime	string	The creation time in UTC format.	2023-07-25T09:43:49Z
IpVersion	string	The IP address version. Valid values: ipv4: IPv4 address. ipv6: IPv6 address.	ipv4

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 13,
  "SecondaryPublicIpAddresses": [
    {
      "CidrMask": 24,
      "Gateway": "12.XXX.XXX.1",
      "SecondaryPublicIpAddress": "12.XXX.XXX.4",
      "Isp": "telecom",
      "SecondaryPublicIpId": "spi-5wys0pio93c9f9ukzj2f2fwyr",
      "EnsRegionId": "cn-beijing-15",
      "CreationTime": "2023-07-25T09:43:49Z",
      "IpVersion": "ipv4"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.