All Products
Search
Document Center

Elastic Compute Service:DescribePrefixListAttributes

Last Updated:Feb 14, 2025

Queries the details of a prefix list, including the name, address family, maximum number of entries, and details of the entries.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
ecs:DescribePrefixListAttributesget
*PrefixList
acs:ecs:{#regionId}:{#accountId}:prefixlist/{#PrefixListId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-chengdu
PrefixListIdstringYes

The ID of the prefix list.

pl-x1j1k5ykzqlixdcy****

Response parameters

ParameterTypeDescriptionExample
object
CreationTimestring

The time when the prefix list was created.

2021-02-20T07:11Z
MaxEntriesinteger

The maximum number of entries in the prefix list.

10
RequestIdstring

The request ID.

38793DB8-A4B2-4AEC-BFD3-111234E9188D
Descriptionstring

The description of the prefix list.

This is description.
AddressFamilystring

The IP address family of the prefix list. Valid values:

  • IPv4
  • IPv6
IPv4
PrefixListNamestring

The name of the prefix list.

PrefixListNameSample
PrefixListIdstring

The ID of the prefix list.

pl-x1j1k5ykzqlixdcy****
Entriesarray<object>

Details about the entries in the prefix list.

Entryobject
Descriptionstring

The description in entry N.

Description Sample 01
Cidrstring

The CIDR block in entry N.

192.168.1.0/24

Examples

Sample success responses

JSONformat

{
  "CreationTime": "2021-02-20T07:11Z",
  "MaxEntries": 10,
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D",
  "Description": "This is description.",
  "AddressFamily": "IPv4",
  "PrefixListName": "PrefixListNameSample",
  "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
  "Entries": {
    "Entry": [
      {
        "Description": "Description Sample 01",
        "Cidr": "192.168.1.0/24"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidPrefixListId.NotFoundThe specified prefix list was not found.The prefix list does not exist.
404InvalidRegionId.NotFoundThe specified RegionId does not exist.The specified region ID does not exist.

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

Change history

Change timeSummary of changesOperation
2025-01-02API Description Update. The Error code has changedView Change Details
2023-11-13The Error code has changedView Change Details