ModifyDirectConnectGatewayAttribute

Last updated: 2020-10-16 18:47:09

1. API Description

Domain name for API request: vpc.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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ModifyDirectConnectGatewayAttribute.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. 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.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the attributes of a direct connect gateway

Input Example

https://vpc.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

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.TooLong Invalid parameter value. The parameter value is too long.
ResourceNotFound The resource does not exist.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.DirectConnectGatewayIsUpdatingCommunity Direct connect gateway is updating the BGP Community attribute.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help