CreatePrefixList-阿里云帮助中心

Creates a prefix list.

Operation description

A prefix list is a collection of network prefixes, which are Classless Inter-Domain Routing. You can reference a prefix list when you configure network rules for other resources. For more information about prefix lists, see Prefix list overview.
When you create a prefix list:
- You must specify an address family (IPv4 or IPv6) for the prefix list. Entries in the same prefix list must belong to the same address family, and the address family cannot be modified after the prefix list is created.
- You must configure the Settings for the maximum number of entries for the prefix list, which cannot be modified after the prefix list is created.
- You can specify entries for the prefix list. Each entry consists of a Classless Inter-Domain Routing and a description. The number of entries cannot exceed the maximum number of entries that you configured in the Settings.
For information about the limits on prefix lists and other resources, see Limits.
RAM users help you avoid sharing the credentials of your Alibaba Cloud account with other users. You can allocate least privilege to users on demand to reduce information security risks for your enterprise. For more information about how to grant prefix list-related permissions to Resource Access Management (RAM) users, see Grant prefix list-related permissions to RAM users.

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:CreatePrefixList

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-chengdu
MaxEntries	integer	Yes	The maximum number of entries supported by the prefix list. Valid values: 1 to 200.	10
AddressFamily	string	Yes	The address family of the prefix list. Valid values: IPv4. IPv6.	IPv4
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see Ensure idempotence.	0c593ea1-3bea-11e9-b96b-88e9fe637760
PrefixListName	string	Yes	The name of the prefix list. The name must be 2 to 128 characters in length, and must start with a letter or a Chinese character. It cannot start with `http://`, `https://`, `com.aliyun`, or `com.alibabacloud`. It can contain Chinese characters, letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).	PrefixListNameSample
Description	string	No	The description of the prefix list. The description must be 2 to 256 characters in length, and cannot start with `http://` or `https://`.	This is description.
Entry	array<object>	No	The prefix list entry information.
	object	No
Description	string	No	The description of the prefix list entry. The description must be 2 to 32 characters in length, and cannot start with `http://` or `https://`. Valid values of N: 0 to 200.	Description Sample 01
Cidr	string	Yes	The Classless Inter-Domain Routing of the prefix list entry. Valid values of N: 0 to 200. Precautions: The number of entries in the prefix list cannot exceed the maximum number of entries (`MaxEntries`). The type of the Classless Inter-Domain Routing in an entry is determined by the address family. A prefix list cannot contain both IPv4 and IPv6 Classless Inter-Domain Routing. Classless Inter-Domain Routing in multiple entries cannot be duplicate. For example, you cannot specify two Settings such as 192.168.1.0/24. You can specify a single IP address in the Settings, and the system automatically transforms it into a Classless Inter-Domain Routing. For example, if you specify 192.168.1.100 in the Settings, the system automatically transforms it into 192.168.1.100/32. If you use an IPv6 Classless Inter-Domain Routing, the system automatically transforms it into a zero-compressed format and transforms letters to lowercase. For example, if you specify 2001:0DB8:0000:0000:0000:0000:0000:0000/32 in the Settings, the system automatically transforms it into 2001:db8::/32. For more information about Classless Inter-Domain Routing, see What is CIDR. Default value: empty.	192.168.1.0/24
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key of the prefix list. Valid values of N: 1 to 20. If you specify this parameter, it cannot be an empty string. The tag key can be up to 128 characters in length, and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	TestKey
Value	string	No	The tag value of the prefix list. Valid values of N: 1 to 20. This parameter can be an empty string. The tag value can be up to 128 characters in length, and cannot contain `http://` or `https://`.	TestValue
ResourceGroupId	string	No	The ID of the resource group to which the prefix list belongs.	rg-bp67acfmxazb4p****

Response elements

Element	Type	Description	Example
	object
PrefixListId	string	The ID of the prefix list.	pl-x1j1k5ykzqlixdcy****
RequestId	string	The request ID.	38793DB8-A4B2-4AEC-BFD3-111234E9188D

Examples

Success response

JSON format

{
  "PrefixListId": "pl-x1j1k5ykzqlixdcy****",
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	%s	A parameter is not specified.
400	InvalidParameter.AddressFamily	The parameter AddressFamily should be IPv4 or IPv6.	The specified AddressFamily parameter is invalid. The valid values of this parameter are IPv4 and IPv6.
400	InvalidParameter	%s	The specified parameter is invalid.
400	InvalidParameter.PrefixListName	The parameter PrefixListName is not valid.	The prefix list name is invalid.
400	InvalidDescription.Malformed	The specified Description is wrongly formed.
400	InvalidClientToken.ValueNotSupported	The ClientToken provided is invalid.	The specified ClientToken parameter is invalid.
400	InvalidParameter.CidrMalformed	%s	The specified CIDR block is invalid.
400	InvalidParameter.CidrDuplicated	%s	Duplicate CIDR blocks are specified.
400	LimitExceed.Entry	The number of entries added or removed exceeds the limit.	The number of entries to add or remove at a time exceeds the upper limit.
400	LimitExceed.MaxEntries	The number of entries exceeds the MaxEntries of the specified prefix list.	The number of specified entries exceeds the MaxEntries value.
404	LimitExceed.PrefixListPerRegion	The number of prefix lists in the region exceeds the limit.	The maximum number of prefix lists in the current region has been reached.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	The specified region ID does not exist.
404	InvalidResourceGroup.NotFound	The specified resource group is not found.	Cannot find the corresponding resource group

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.