DescribePrefixListAttributes-阿里云帮助中心

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

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

ecs:DescribePrefixListAttributes

get

*PrefixList

acs:ecs:{#regionId}:{#accountId}:prefixlist/{#PrefixListId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-chengdu
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-chengdu
PrefixListId	string	Yes	The ID of the prefix list.	pl-x1j1k5ykzqlixdcy****

Response elements

Element	Type	Description	Example
	object
CreationTime	string	The time when the prefix list was created.	2021-02-20T07:11Z
MaxEntries	integer	The maximum number of entries in the prefix list.	10
RequestId	string	The request ID.	38793DB8-A4B2-4AEC-BFD3-111234E9188D
Description	string	The description of the prefix list.	This is description.
AddressFamily	string	The IP address family of the prefix list. Valid values: IPv4 IPv6	IPv4
PrefixListName	string	The name of the prefix list.	PrefixListNameSample
PrefixListId	string	The ID of the prefix list.	pl-x1j1k5ykzqlixdcy****
Entries	object
Entry	array<object>	Details about the entries in the prefix list.
	object
Description	string	The description in entry N.	Description Sample 01
Cidr	string	The CIDR block in entry N.	192.168.1.0/24

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
404	InvalidPrefixListId.NotFound	The specified prefix list was not found.	The prefix list does not exist.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	The specified region ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.