Domain name for API request: tcaplusdb.tencentcloudapi.com.
This API is used to enable the RESTful API.
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: EnableRestProxy. |
Version | Yes | String | Common Params. The value used for this API: 2019-08-23. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
ClusterId | Yes | String | The value is the same as appid . |
Parameter Name | Type | Description |
---|---|---|
RestProxyStatus | Integer | RestProxy status. Valid values: 0 (disabled), 1 (enabling), 2 (enabled), 3 (disabling). |
TaskId | String | TaskId is in the format of AppInstanceId-taskId , used to identify tasks of different clusters. |
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. |
This example shows how to enable the RESTful API by specifying the ClusterId
.
https://tcaplusdb.tencentcloudapi.com/?Action=EnableRestProxy
&ClusterId=5674209986
&<Common request parameters>
{
"Response": {
"RestProxyStatus": 1,
"RequestId": "request-xxx123",
"TaskId": "838418134-44"
}
}
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 |
---|---|
AuthFailure | CAM signature/authentication error |
AuthFailure.UnauthorizedOperation | API operation authentication error. |
FailedOperation | Operation failed. |
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.InvalidAppName | Invalid cluster name |
InvalidParameterValue.InvalidClusterName | Invalid cluster name. |
InvalidParameterValue.InvalidTableGroupName | Invalid table group name. |
InvalidParameterValue.InvalidTimeValue | Invalid time format. |
InvalidParameterValue.InvalidZoneName | Invalid AZ name |
InvalidParameterValue.UnsupportIdlType | Unsupported application data description type. |
ResourceNotFound | The resource does not exist. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?