TencentDB for MySQL
- Release Notes and Announcements
- Announcements
- Product Introduction
- Database Architecture
- Database Instance
- Kernel Features
- Kernel Version Release Notes
- Functionality Features
- Performance Features
- Parallel Query
- Security Features
- Stability Features
- Purchase Guide
- Getting Started
- Connecting to MySQL Instance
- Database Audit
- Audit Rule Template
- MySQL Cluster Edition
- Maintenance Management Instance
- Operation Guide
- Instance Management and Maintenance
- Instance Upgrade
- CPU Elastic Expansion
- Read-Only/Disaster Recovery Instances
- Database Proxy
- Database Proxy Kernel Features
- Database Proxy Management
- Automatic Read/Write Separation Feature
- Connection Pool Feature
- Other Features
- Account Management
- Database Management Center (DMC)
- Parameter Configuration
- Network and Security
- Backup and Rollback
- Restoring Database from Backup File
- Monitoring and Alarms
- Operation Logs
- Practical Tutorial
- Calling MySQL APIs in Python
- White Paper
- Performance White Paper
- Performance Test Report
- Troubleshooting
- Connections
- API Documentation
- Data Import APIs
- Rollback APIs
- Parameter APIs
- Making API Requests
- Instance APIs
- Database Proxy APIs
- Database Audit APIs
- Security APIs
- Account APIs
- Backup APIs
- Database APIs
- Monitoring APIs
- Log-related API
- FAQs
- Backup
- Connection and Login
- Instance Upgrade
- Performance and Memory
- Service Agreement
- Reference
DescribeInstanceParams
Last updated: 2024-11-20 11:12:35
1. API Description
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.
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: 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. |
3. 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. |
4. Example
Example1 Querying the list of configurable parameters of an instance
This example shows you how to query the list of configurable parameters of an instance.
Input Example
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceParams
<Common request parameters>
{
"InstanceId": "cdb-ezq1vzem"
}
Output Example
{
"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"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| 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?
You can also Contact Sales or Submit a Ticket for help.
Yes
No