All Products
Search

This Product

    Cloud Enterprise Network:UpdateTransitRouterVpnAttachmentAttribute

    Document Center

    Cloud Enterprise Network:UpdateTransitRouterVpnAttachmentAttribute

    Last Updated:Oct 21, 2024

    Modifies the configuration of a VPN attachment.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    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.
    		123e4567-e89b-12d3-a456-42665544****
    DryRunbooleanNo

    Specifies whether to perform a dry run. Valid values:

    • true:performs a dry run. The system checks the required parameters, request syntax, and 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 sends the request.
    		false
    TransitRouterAttachmentIdstringYes

    The ID of the VPN attachment.

    		tr-attach-a6p8voaodog5c0****
    TransitRouterAttachmentNamestringNo

    The name of the VPN attachment.

    The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.

    		nametest
    TransitRouterAttachmentDescriptionstringNo

    The new description of the VPN attachment.

    The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with http:// or https://.

    		desctest
    AutoPublishRouteEnabledbooleanNo

    Specifies whether to allow the transit router to automatically advertise routes to the IPsec-VPN attachment. Valid values:

    • true: yes
    • false: no
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object

    The result of the request.

    RequestIdstring

    The ID of the request.

    		1AB038F2-96E5-560B-9F6E-734311D466FA

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1AB038F2-96E5-560B-9F6E-734311D466FA"
}

    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.
    400IncorrectStatus.TransitRouterAttachmentIdThe resource is not in a valid state for the attachment operation.The error message returned because the operation is not supported when the specified attachment is in an unstable state
    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.