All Products
Search
Document Center

:DescribeSecondaryPublicIpAddresses

Last Updated:Oct 14, 2024

Queries created secondary public IP addresses.

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeSecondaryPublicIpAddresseslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EnsRegionIdstringNo

The ID of the edge node.

cn-hangzhou-44
SecondaryPublicIpIdstringNo

The ID of the secondary public IP address.

spi-5wys0pio93c9f9ukzj2f2fwyr
SecondaryPublicIpAddressstringNo

The secondary IP address.

12.XXX.XXX.4
IspstringNo

The Internet service provider. Valid values:

  • cmcc: China Mobile.
  • unicom: China Unicom.
  • telecom: China Telecom.
unicom
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.

50

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

The page number returned.

1
PageSizeinteger

The number of entries per page.

50
TotalCountinteger

The total number of entries returned.

13
SecondaryPublicIpAddressesarray<object>

The array of returned secondary IP addresses.

ipobject
CidrMaskinteger

The subnet mask of the CIDR block.

24
Gatewaystring

The gateway.

12.XXX.XXX.1
SecondaryPublicIpAddressstring

The secondary public IP address.

12.XXX.XXX.4
Ispstring

The Internet service provider. Valid values:

  • cmcc: China Mobile.
  • unicom: China Unicom.
  • telecom: China Telecom.
telecom
SecondaryPublicIpIdstring

The ID of the secondary public IP address.

spi-5wys0pio93c9f9ukzj2f2fwyr
EnsRegionIdstring

The ID of the edge node.

cn-beijing-15
CreationTimestring

The time when the secondary public IP address was created. The time is displayed in UTC.

2023-07-25T09:43:49Z
IpVersionstring

The version of the IP address. Valid values:

  • ipv4
  • ipv6
ipv4

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400ens.interface.errorAn error occurred while call the API.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

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