Domain name for API request: cdb.intl.tencentcloudapi.com.
This API (DescribeInstanceParams) is used to query the list of parameters for an instance.
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: DescribeInstanceParams. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the instance list querying API to query the ID, whose value is the InstanceId value in output parameters. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of instance parameters. |
Items | Array of ParameterDetail | Parameter details. |
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 you how to query the list of configurable parameters of an instance.
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceParams
<Common request parameters>
{
"InstanceId": "cdb-ezq1vzem"
}
{
"Response": {
"TotalCount": 72,
"Items": [
{
"Name": "max_connections",
"ParamType": "integer",
"Default": "151",
"Description": "The maximum permitted number of simultaneous client connections.",
"CurrentValue": "800",
"NeedReboot": 0,
"Max": 10240,
"Min": 1,
"EnumValue": [],
"MinFunc": "",
"MaxFunc": ""
},
{
"Name": "character_set_server",
"ParamType": "enum",
"Default": "utf8",
"Description": "Specify default server character set.",
"CurrentValue": "utf8",
"NeedReboot": 1,
"EnumValue": [
"utf8",
"utf8mb4",
"gbk",
"latin1"
],
"Max": 0,
"Min": 0,
"MinFunc": "",
"MaxFunc": ""
},
{
"Name": "lower_case_table_names",
"ParamType": "integer",
"Default": "0",
"Description": "If set to 0, table names are stored as specified and comparisons are case sensitive. If set to 1, they are stored in lowercase on disk and comparisons are not case sensitive.",
"CurrentValue": "0",
"NeedReboot": 1,
"Max": 1,
"Min": 0,
"EnumValue": [],
"MinFunc": "",
"MaxFunc": ""
}
],
"RequestId": "92131c95-aa65-44db-8c3c-e8cd67883b58"
}
}
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. |
CdbError | Backend or process error. |
InternalError.CdbError | System error. |
InternalError.DatabaseAccessError | Internal database error. |
InternalError.InternalHttpServerError | An exception occurred while executing the request. |
InternalError.ParamError | Parameter error |
InternalError.UnknownError | Unknown error |
InvalidParameter | Parameter error. |
InvalidParameter.ControllerNotFoundError | This API was not found. |
InvalidParameter.InstanceNotFound | The instance does not exist. |
OperationDenied | Operation denied. |
Was this page helpful?