UpdateTransitRouterPeerAttachmentAttribute - Cloud Enterprise Network

Modifies an inter-region connection on an Enterprise Edition transit router.

Operation description

UpdateTransitRouterPeerAttachmentAttribute is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the ListTransitRouterPeerAttachments operation to query the status of an inter-region connection.

If an inter-region connection is in the Modifying state, the inter-region connection is being modified. You can query the inter-region connection but cannot perform other operations.
If an inter-region connection is in the Attached state, the inter-region connection is modified.

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

update

*TransitRouterPeerAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

None

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 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 set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.	02fb3da4-130e-11e9-8e44-001****
TransitRouterAttachmentId	string	Yes	The ID of the inter-region connection.	tr-attach-ft94dcrbc3e5taun3x
TransitRouterAttachmentName	string	No	The new name of the inter-region connection. The name can be empty or 1 to 128 characters in length, and cannot start with http:// or https://.	testname
TransitRouterAttachmentDescription	string	No	The new description of the inter-region connection. This parameter is optional. If you enter a description, it must be 1 to 256 characters in length, and cannot start with http:// or https://.	testdesc
AutoPublishRouteEnabled	boolean	No	Specifies whether to enable the local Enterprise Edition transit router to automatically advertise the routes of the inter-region connection to the peer transit router. Valid values: false (default): no true: yes	false
DryRun	boolean	No	Specifies whether to perform a dry run to check information such as the permissions and the instance status. Default values: false (default): performs a dry run and sends the request. true: performs a dry run. The system checks the required parameters and request syntax. If the request fails the dry run, an error message is returned. If the request passes the dry run, the system returns the ID of the request.	false
Bandwidth	integer	No	The bandwidth value of the inter-region connection. Unit: Mbit/s. This parameter specifies the maximum bandwidth value for the inter-region connection if you set BandwidthType to BandwidthPackage. This parameter specifies the bandwidth throttling threshold for the inter-region connection if you set BandwidthType to DataTransfer.	2
CenBandwidthPackageId	string	No	The ID of the bandwidth plan that is used to allocate bandwidth to the inter-region connection. Note If you set BandwidthType to DataTransfer, you do not need to set this parameter.	cenbwp-3xrxupouolw5ou****
BandwidthType	string	No	The bandwidth allocation method. Valid values: BandwidthPackage: allocates bandwidth from a bandwidth plan. DataTransfer: bandwidth is billed based on the pay-by-data-transfer metering method.	BandwidthPackage
DefaultLinkType	string	No	The default line type. Valid values: Platinum and Gold. Platinum is supported only when BandwidthType is set to DataTransfer.	Gold

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	A01FEDD7-7D69-4EB3-996D-CF79F6F885CA

Examples

Success response

JSON format

{
  "RequestId": "A01FEDD7-7D69-4EB3-996D-CF79F6F885CA"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTransitRouterAttachmentId.NotFound	TransitRouterAttachmentId is not found.	The error message returned because the ID of the network instance does not exist.
400	OperationUnsupported.BandwidthType	The specified BandwidthType does not support the operation.	The error message returned because this operation is not supported by the specified bandwidth type.
400	MissingParam.Bandwidth	The parameter Bandwidth is mandatory.	The error message returned because no bandwidth value is specified. You must specify a bandwidth value.
400	IncorrectStatus.Attachment	The resource is not in a valid state for the attachment operation.	The error message returned because the operation is not allowed when the network instance is being processed. Try again later.
400	IllegalParam.BandwidthType	BandwidthType is illegal.	The error message returned because the specified bandwidth plan type is invalid.
400	IllegalParam.Bandwidth	Bandwidth is illegal.	The error message returned because the specified bandwidth plan ID is invalid.
400	ParameterIllegal.BandwidthPackageDefaultLinkTypeOnlySupportGold	Cen bandwidthPackage only support Gold.	Cen bandwidthPackage only support Gold.
400	ParameterIllegal.CdtDefaultLinkTypeOnlySupportPlatinumOrGold	DataTransfer only support Platinum and Gold.	DataTransfer only support Platinum and Gold.
400	ParameterIllegal.CdtDefaultLinkTypeOnlySupportGold	CDT only support Gold when both transitrouters for cross regional connections are not all enterprise version.	CDT only support Gold when both transitrouters for cross regional connections are not all enterprise version.
400	OperationNotAllowed.DefaultLinkTypeOnlySupportGold	Operation is not allowed because this user can only set default link type to Gold.	This user can only set the default link type to Gold.
400	OperationUnsupported.TransitRouterAttachment	The specified TransitRouterAttachment has configured TransitRegion. Please remove the configuration first.	The error message returned because bandwidth multiplexing is enabled. Disable bandwidth multiplexing and try again.
400	IllegalParam.BandwidthLessThanQosPolicyBandwidth	The input bandwidth value is less than the sum of the Qos policy bandwidth.	The input bandwidth value is less than the sum of the Qos policy bandwidth.
400	IllegalParam.BandwidthPackageStatus	The status of the bandwidth package is incorrect.	The status of the bandwidth package is incorrect.
400	QuotaExceeded.Bandwidth	Bandwidth quota exceeded.	Bandwidth quota exceeded.
400	ParamExclusive.BandwidthTypeAndCenBandwidthPackageId	DataTransfer and CenBandwidthPackageId is mutually exclusive.	When the value of bandwidthType is DataTransfer, the CenBandwidthPackageId field cannot be set.
400	OperationUnsupported.CloudDataTransferService	CCN region not support cloud data transfer service.	The error message returned because the Cloud Data Transfer (CDT) service is not supported in the region of the CCN instance.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.
400	ParameterIllegal.CdtDefaultLinkTypeOnlySupportUnderlaySilver	CDT only support UnderlaySilver when both transitrouters for cross regional connections are not all enterprise version.	CDT only support UnderlaySilver when both transitrouters for cross regional connections are not all enterprise version.
400	ParameterIllegal.DefaultLinkTypeOnlySupportUnderlaySilver	Cen bandwidthPackage only support UnderlaySilver.	When the bandwidth allocation method is bandwidth package, the default link type supports only silver (UnderlaySilver)
400	OperationNotAllowed.DefaultLinkTypeOnlySupportUnderlaySilver	This user can only set the default link type to UnderlaySilver.	This user can only set the default link type to UnderlaySilver.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.