UpdateTransitRouterPolicyBasedRoute-阿里云帮助中心

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

cen:UpdateTransitRouterPolicyBasedRoute

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can generate the value from your client. Make sure that the value is unique among different requests. The ClientToken parameter supports 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 of each API request may be different.	123e4567-e89b-12d3-a456-42665544****
DryRun	boolean	No	Specifies whether to perform only a dry run on the request. Valid values: true: sends a check request and does not update the policy-based route rule. The system checks whether required parameters are specified, the request format is valid, and service limits are met. If the check fails, the corresponding error is returned. If the check succeeds, the `DryRunOperation` error code is returned. false (default): sends a normal request and directly updates the policy-based route rule after the check succeeds.	false
PolicyBasedRouteId	string	Yes	The instance ID of the policy-based routing rule.	pbr-123abczcx
Name	string	No	The name of the policy-based route rule. The name can be empty or 1 to 128 characters in length. It cannot start with http:// or https://.	nametest
Description	string	No	The description of the policy-based route rule. The description can be empty or 1 to 256 characters in length. It cannot start with http:// or https://.	desctest

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	13526224-5780-4426-8ADF-BC8B08700F23

Examples

Success response

JSON format

{
  "RequestId": "13526224-5780-4426-8ADF-BC8B08700F23"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InstanceNotExist.PolicyBasedRoute	The policy based route does not exist.	The policy based route does not exist.
400	InvalidParameter.PolicyBasedRouteId	The specified parameter PolicyBasedRouteId is invalid.	The parameter PolicyBasedRouteId entered is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.