1. API Description
Domain name for API request: vpc.intl.tencentcloudapi.com.
This API (ModifyCustomerGatewayAttribute) is used to modify the customer gateway information.
A maximum of 100 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.
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: ModifyCustomerGatewayAttribute. |
| 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. |
| CustomerGatewayId |
Yes |
String |
The ID of the customer gateway, such as cgw-2wqq41m9. You can query the customer gateway by using the DescribeCustomerGateways API. |
| CustomerGatewayName |
Yes |
String |
Customer gateway can be named freely, but the maximum length is 60 characters. |
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 a customer gateway
This example shows you how to modify a customer gateway.
POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCustomerGatewayAttribute
<Common request parameters>
{
"CustomerGatewayId": "cgw-mgp33pll",
"CustomerGatewayName": "NewName"
}
Output Example
{
"Response": {
"RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a"
}
}
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 |
| InvalidParameterValue.Malformed |
Invalid input parameter format. |
| InvalidParameterValue.TooLong |
Invalid parameter value. The parameter value is too long. |
| ResourceNotFound |
The resource does not exist. |
| UnsupportedOperation.VpnUnsupportedModifyBgpAsn |
VPN does not support modifying BGP ASN. |