Domain name for API request: tse.intl.tencentcloudapi.com.
This API is used to modify the basic information of a cloud native API gateway instance.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyCloudNativeAPIGateway. |
| Version | Yes | String | Common Params. The value used for this API: 2020-12-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| GatewayId | Yes | String | Cloud native API gateway instance ID. |
| Name | No | String | Cloud Native API Gateway name, supports up to 60 characters. |
| Description | No | String | Cloud native API gateway description, supports up to 120 characters. |
| EnableCls | No | Boolean | Whether CLS log is enabled. The value can only be true temporarily, meaning it can only be changed from disabled to enabled. |
| InternetPayMode | No | String | Public network billing mode. Option values: BANDWIDTH |
| DeleteProtect | No | Boolean | Enable instance deletion protection, default false |
| 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. |
Test modifying the basic information of a cloud native API gateway instance
POST / HTTP/1.1
Host: tse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCloudNativeAPIGateway
<Common request parameters>
{
"GatewayId": "<GatewayId>",
"Name": "<Name>",
"Description": "<Description>"
}
{
"Response": {
"RequestId": "9922cab4-4ad3-4146-9535-cbc788082899"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.FailedOperation | Operation failed. |
| FailedOperation.InternalError | Operation failed. Internal error. |
| InternalError.InternalError | Internal service error. |
| InvalidParameterValue.BadRequestFormat | Request format incorrect. |
| InvalidParameterValue.Description | The description information is invalid. |
| InvalidParameterValue.GatewayId | Gateway ID invalid |
| InvalidParameterValue.InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.Name | Invalid name. |
| MissingParameter.MissParameter | Missing required parameters. |
| OperationDenied.OperationDenied | Operation not allowed. |
| ResourceNotFound.Forbidden | The resource does not exist. Operation is not allowed. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| ResourceNotFound.ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation.UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback