RetryVpcPrefixListAssociation - Reapply a prefix list | VPC API - Virtual Private Cloud

Operation description

After you modify the information of a prefix list instance, if the route table associated with the prefix list instance does not automatically update the prefix list instance information, you can call this operation to redeploy the latest prefix list instance to the associated route table.
The RetryVpcPrefixListAssociation operation is asynchronous. After you send a request, the system returns a request ID. However, the latest prefix list instance is not yet redeployed, and the redeployment task is still running in the background. You can call GetVpcPrefixListAssociations to query the latest deployment status of the prefix list instance:
- If the deployment status of the prefix list instance is Modifying, the latest prefix list instance is being redeployed.
- If the deployment status of the prefix list instance is ModifyFailed, the latest prefix list instance failed to be redeployed.
- If the deployment status of the prefix list instance is Created, the latest prefix list instance is redeployed.
The RetryVpcPrefixListAssociation operation does not support concurrent retry of redeploying the latest prefix list instance for the same prefix list.

Scenarios

When you modify a prefix list instance, the modification succeeds as long as the CIDR blocks are valid, no conflicting CIDR blocks exist, and the maximum number of entries for the prefix list instance is not exceeded. However, the reference may fail due to issues on the referencing side, such as quota limits or a route conflict with existing routing entries. After you resolve the issue on the referencing side, call the RetryVpcPrefixListAssociation operation to redeploy the latest prefix list instance.

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

vpc:RetryVpcPrefixListAssociation

update

*PrefixList

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

None

Request parameters

Parameter	Type	Required	Description	Example
PrefixListId	string	Yes	The instance ID of the prefix list to redeploy.	pl-0b7hwu67****
ResourceType	string	Yes	The type of the resource associated with the prefix list instance. Valid values: vpcRouteTable: VPC route table. trRouteTable: transit router route table.	vpcRouteTable
ResourceId	string	Yes	The instance ID of the associated resource.	vtb-bp1drpcfz9srr393h****
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. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The prefix list is not associated. The system checks the request for potential issues, including missing required parameters, request format, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, an HTTP 2xx status code is returned and the prefix list is directly associated.	false
RegionId	string	Yes	The region ID of the prefix list instance to redeploy. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF

Examples

Success response

JSON format

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

Error codes

HTTP status code	Error code	Error message	Description
400	UnsupportedRegion	The feature of prefixList entry is not supported in this region.	Prefix list routes are not supported in this region.
400	OperationDenied.SystemPrefixList	The operation is not allowed because of SystemPrefixList.	You cannot manage the system prefix list.
400	OperationFailed.OperateShareResource	This is not allowed to operate shared prefixList.	You cannot operate on a shared prefix list.
400	IncorrectStatus.PrefixList	The status of prefixList is incorrect.	The prefix list is in an unstable state.
400	OperationFailed.NotExistAssociateRelation	The operation is failed because of association not exist.	The operation failed. The specified reference relationship does not exist in the prefix list.
400	ResourceNotFound.PrefixList	The specified resource of prefixList is not found.	The prefix list does not exist.
400	IncorrectStatus.PrefixListRelation	The related prefix list relation is in an intermediate state and cannot perform the current operation.	The associated prefix list association is in an intermediate state, and the current operation cannot be performed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.