Domain name for API request: cynosdb.tencentcloudapi.com.
This API is used to pause a serverless cluster.
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: PauseServerless. |
Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
ClusterId | Yes | String | Cluster ID |
ForcePause | No | Integer | Whether to pause forcibly and ignore the current user connections. Valid values: 0 (no), 1 (yes). Default value: 1 |
Parameter Name | Type | Description |
---|---|---|
FlowId | Integer | Async task ID |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PauseServerless
<Common request parameters>
{
"ClusterId": "cynosdbmysql-8vcxoq75",
"ForcePause": 1
}
{
"Response": {
"FlowId": 1008306,
"RequestId": "37508f2e-23eb-11eb-a713-525400b7dd5a"
}
}
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.FlowCreateError | Failed to create a task. Try again later. If the problem persists, contact customer service. |
InternalError.SystemError | Internal system error. |
InvalidParameterValue.ClusterNotFound | No cluster found. |
InvalidParameterValue.DbModeNotServerlessError | The cluster type must be serverless. |
InvalidParameterValue.ParamError | Incorrect parameter. |
OperationDenied.ServerlessClusterStatusDenied | For the serverless cluster in this status, the operation is not allowed. |
ResourceNotFound.ClusterNotFoundError | The cluster does not exist. |
Was this page helpful?