All Products
Search

This Product

    Cloud Enterprise Network:UpdateTransitRouterPeerAttachmentAttribute

    Document Center

    Cloud Enterprise Network:UpdateTransitRouterPeerAttachmentAttribute

    Last Updated:Mar 25, 2024

    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

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

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    cen:UpdateTransitRouterPeerAttachmentAttributeWrite
    • TransitRouterPeerAttachment
      acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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****
    TransitRouterAttachmentIdstringYes

    The ID of the inter-region connection.

    		tr-attach-ft94dcrbc3e5taun3x
    TransitRouterAttachmentNamestringNo

    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
    TransitRouterAttachmentDescriptionstringNo

    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
    AutoPublishRouteEnabledbooleanNo

    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
    DryRunbooleanNo

    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
    BandwidthintegerNo

    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
    CenBandwidthPackageIdstringNo

    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****
    BandwidthTypestringNo

    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
    DefaultLinkTypestringNo

    The default line type.

    Valid values: Platinum and Gold.

    Platinum is supported only when BandwidthType is set to DataTransfer.

    		Gold

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    The ID of the request.

    		A01FEDD7-7D69-4EB3-996D-CF79F6F885CA

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidTransitRouterAttachmentId.NotFoundTransitRouterAttachmentId is not found.The error message returned because the ID of the network instance does not exist.
    400OperationUnsupported.BandwidthTypeThe specified BandwidthType does not support the operation.The error message returned because this operation is not supported by the specified bandwidth type.
    400MissingParam.BandwidthThe parameter Bandwidth is mandatory.The error message returned because no bandwidth value is specified. You must specify a bandwidth value.
    400IncorrectStatus.AttachmentThe 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.
    400IllegalParam.BandwidthTypeBandwidthType is illegal.The error message returned because the specified bandwidth plan type is invalid.
    400IllegalParam.BandwidthBandwidth is illegal.The error message returned because the specified bandwidth plan ID is invalid.
    400ParameterIllegal.BandwidthPackageDefaultLinkTypeOnlySupportGoldCen bandwidthPackage only support Gold.Cen bandwidthPackage only support Gold.
    400ParameterIllegal.CdtDefaultLinkTypeOnlySupportPlatinumOrGoldDataTransfer only support Platinum and Gold.DataTransfer only support Platinum and Gold.
    400ParameterIllegal.CdtDefaultLinkTypeOnlySupportGoldCDT 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.
    400OperationNotAllowed.DefaultLinkTypeOnlySupportGoldOperation 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.
    400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
    400UnauthorizedThe 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 timeSummary of changesOperation
    2023-12-06The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DefaultLinkType
    2023-11-03The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-10-18The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      delete Input Parameters: DefaultLinkType
    2023-10-18The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DefaultLinkType