tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeInstanceParams

Last updated: 2023-07-06 16:45:55

1. API Description

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

This API is used to query the parameter list of an instance.

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: DescribeInstanceParams.
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
InstanceIds.N Yes Array of String Instance ID, which supports batch query.
ParamKeyword No String Search condition for a parameter name, which supports fuzzy search.

3. Output Parameters

Parameter Name Type Description
Items Array of InstanceParamItem List of instance parameters
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the instance parameters

Input Example

POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeInstanceErrorLogs<common request parameters>{    "InstanceId": "cynosdbmysql-ge5ck0jr",    "ParamKeyword": "cdb",    "InstanceIds": [        "cynosdbmysql-ins-kzavkukw"    ]}

Output Example

{
    "Response": {
        "Items": [
            {
                "InstanceId": "cynosdbmysql-ins-1111111",
                "ParamsItems": [
                    {
                        "CurrentValue": "1",
                        "Default": "1",
                        "Description": "Controls the interval between successive column values.",
                        "EnumValue": [],
                        "Func": "",
                        "IsFunc": false,
                        "IsGlobal": 1,
                        "Max": "65535",
                        "Min": "1",
                        "NeedReboot": 0,
                        "ParamName": "auto_increment_increment",
                        "ParamType": "integer"
                    }
                ]
            }
        ],
        "RequestId": "12fc29c0-6a35-11ed-bc4c-d5b8675844ad"
    }
}

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.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InternalError.SystemError Internal system error.
InvalidParameterValue.InstanceNotFound The instance does not exist.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
OperationDenied.CamDeniedError Failed to verify permissions
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy