tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeClusterParams

Last updated: 2023-08-23 14:22:55

1. API Description

Domain name for API request: cynosdb.tencentcloudapi.com.

This API is used to query the parameters of a 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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeClusterParams.
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
ParamName No String Parameter name

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of parameters
Items Array of ParamInfo Instance parameter list
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the cluster parameters

Input Example

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

{
    "ClusterId": "cynosdbpg-1xcycbu8"
}

Output Example

{
    "Response": {
        "Items": [
            {
                "MatchValue": "",
                "CurrentValue": "4096",
                "Min": "1024",
                "Default": "4096",
                "Description": "xx",
                "Max": "65536",
                "ParamType": "integer",
                "EnumValue": null,
                "ParamName": "work_mem",
                "MatchType": "",
                "NeedReboot": 0
            },
            {
                "MatchValue": "",
                "CurrentValue": "base64",
                "Min": "",
                "Default": "base64",
                "Description": "xx",
                "Max": "",
                "ParamType": "enum",
                "EnumValue": [
                    "base64",
                    "hex"
                ],
                "ParamName": "xmlbinary",
                "MatchType": "",
                "NeedReboot": 0
            }
        ],
        "RequestId": "117812",
        "TotalCount": 2
    }
}

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.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FlowCreateError Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InternalError.InternalHttpServerError An exception occurred while executing the HTTP request.
InternalError.SystemError Internal system error.
InvalidParameterValue.InstanceNotFound The instance does not exist.
OperationDenied.ClusterOpNotAllowedError The current cluster does not allow the operation.
OperationDenied.ServerlessClusterStatusDenied For the serverless cluster in this status, the operation is not allowed.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy