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.
Debugging
Authorization information
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 |
| DryRun | boolean | No | Specifies whether to perform a dry run to check information such as the permissions and the instance status. Default values:
| false |
| Bandwidth | integer | No | The bandwidth value of the inter-region connection. Unit: Mbit/s.
| 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 |
| DefaultLinkType | string | No | The default line type. Valid values: Platinum and Gold. Platinum is supported only when BandwidthType is set to DataTransfer. | Gold |
Response parameters
Examples
Sample success responses
JSONformat
{
"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 | 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-10 | The Error code has changed | View Change Details |
| 2023-12-06 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-11-03 | The Error code has changed | View Change Details |
| 2023-10-18 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-10-18 | The Error code has changed. The request parameters of the API has changed | View Change Details |