tencent cloud

Feedback

PauseServerless

Last updated: 2022-04-07 11:38:10

1. API Description

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.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: PauseServerless.
Version Yes String Common parameter. The value used for this API: 2019-01-07.
Region Yes String Common parameter. 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

3. Output Parameters

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.

4. Example

Example1 Pausing a serverless cluster

Input Example

POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PauseServerless
<Common request parameters>

{
    "ClusterId": "cynosdbmysql-8vcxoq75",
    "ForcePause": 1
}

Output Example

{
  "Response": {
    "FlowId": 1008306,
    "RequestId": "37508f2e-23eb-11eb-a713-525400b7dd5a"
  }
}

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
FailedOperation.FlowCreateError Failed to create a task ({{1}}). Please try again later. If the problem persists, please 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 ({{1}}), the operation is not allowed.
ResourceNotFound.ClusterNotFoundError The cluster ({{1}}) does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support