All Products
Search
Document Center

Elastic Compute Service:ModifyPrefixList

Last Updated:Mar 19, 2024

Modifies the name, description, or entries of a specific prefix list.

Operation description

Description

  • The specified CIDR block must be valid. For example, 10.0.0.0/8 is a valid CIDR block while 10.0.0.1/8 is not. For more information, see the What is CIDR? section in Network FAQ.

  • When you add or delete an entry, you cannot specify duplicate CIDR blocks. Examples:

    • For IPv4 CIDR blocks, you cannot specify the 10.0.0.0/8 CIDR block in two entries. You cannot specify the 10.0.0.1/32 CIDR block in one entry and the 10.0.0.1 CIDR block in another entry. These two CIDR blocks are the same.
    • For IPv6 CIDR blocks, you cannot specify the 2001:fd01:0:0:0:0:0:0/32 CIDR block in one entry and the 2001:fd01::/32 CIDR block in another entry. These two CIDR blocks are the same.
  • The CIDR block in an entry to be added cannot the same as that in an entry to be deleted. For example, when you add an entry in which the 10.0.0.0/8 CIDR block is specified, the entry to be deleted cannot have the 10.0.0.0/8 CIDR block specified.

  • If you want to modify the description of an entry, you must specify the CIDR block (AddEntry.N.Cidr) and new description (AddEntry.N.Description) in the entry.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-chengdu
PrefixListIdstringYes

The ID of the prefix list.

pl-x1j1k5ykzqlixdcy****
PrefixListNamestringNo

The name of the prefix list. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

PrefixListNameSample
DescriptionstringNo

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.
AddEntryobject []No

The entries that to be added to the prefix list.

DescriptionstringNo

The description in entry N. 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
CidrstringYes

The CIDR block of entry N to be added to the prefix list. Valid values of N: 0 to 200.

Take note of the following items when you add the entries:

  • The number of entries in the prefix list cannot be greater than the maximum number of entries allowed for the prefix list. You can call the DescribePrefixListAttributes operation to query the maximum number of entries in a specific prefix list.
  • You cannot specify duplicate CIDR blocks.
  • The CIDR blocks cannot be the same as the RemoveEntry.N.Cidr values.
192.168.2.0/24
RemoveEntryobject []No

The entries that to be deleted from the prefix list.

CidrstringYes

The CIDR block of entry N to be deleted from the prefix list. Valid values of N: 0 to 200.

Take note of the following items when you delete the entries:

  • You cannot specify duplicate CIDR blocks.
  • The CIDR blocks cannot be the same as the AddEntry.N.Cidr values.
192.168.1.0/24

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

{
  "RequestId": "38793DB8-A4B2-4AEC-BFD3-111234E9188D"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameter%sA parameter is not specified.
400InvalidParameter.PrefixListNameThe parameter PrefixListName is not valid.The prefix list name is invalid.
400InvalidDescription.MalformedThe specified Description is wrongly formed.The resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400InvalidParameter.CidrDuplicated%sDuplicate CIDR blocks are specified.
400InvalidParameter.CidrMalformed%sThe specified CIDR block is invalid.
400LimitExceed.MaxEntriesThe number of entries exceeds the MaxEntries of the specified prefix list.The number of specified entries exceeds the MaxEntries value.
400LimitExceed.EntryThe number of entries added or removed exceeds the limit.The number of entries to add or remove at a time exceeds the upper limit.
404InvalidPrefixListId.NotFoundThe specified prefix list was not found.The prefix list does not exist.

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

Change history

Change timeSummary of changesOperation
2023-11-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 404 change
    delete Error Codes: 400