tencent cloud

All product documents
Virtual Private Cloud
DocumentationVirtual Private CloudAPI DocumentationDirect Connect Gateway APIsModifyDirectConnectGatewayAttribute
ModifyDirectConnectGatewayAttribute
Download PDF
Last updated: 2024-11-25 20:09:31
ModifyDirectConnectGatewayAttribute
Last updated: 2024-11-25 20:09:31
Download PDF

1. API Description

Domain name for API request: vpc.intl.tencentcloudapi.com.

This API is used to modify the attributes of a direct connect gateway.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyDirectConnectGatewayAttribute.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DirectConnectGatewayId Yes String The unique ID of the direct connect gateway, such as dcg-9o233uri.
DirectConnectGatewayName No String The direct connect gateway name. You can enter any name within 60 characters.
CcnRouteType No String The CCN route-learning type. Valid values: BGP (Automatic learning), STATIC (Static, that is, user-configured). You can only modify CcnRouteType for a CCN direct connect gateway with BGP enabled.
ModeType No String CCN route publishing method. Valid values: standard and exquisite. You can only modify ModeType for a CCN direct connect gateway.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying the attributes of a direct connect gateway

Input Example

https://vpc.intl.tencentcloudapi.com/?Action=ModifyDirectConnectGatewayAttribute
&DirectConnectGatewayId=dcg-k6cswwhx
&DirectConnectGatewayName=new+name
&CcnRouteType=BGP
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "fcb47621-838b-428e-8c33-6e210d93c451"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter A parameter error occurred.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
ResourceNotFound The resource does not exist.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.AppIdMismatch The resource is not under the specified AppId.
UnsupportedOperation.DirectConnectGatewayIsUpdatingCommunity Direct connect gateway is updating the BGP Community attribute.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon