- Release Notes
- User Tutorial
- Product Introduction
- Tencent Kernel TXSQL
- Purchase Guide
- Get Started
- Operation Guide
- Best Practice
- Usage Specifications of TencentDB for MySQL
- Configuring Application Automatic Reconnection
- Impact of Modifying MySQL Master Instance Parameters
- Limits on Automatic Conversion from MyISAM to InnoDB
- Creating VPCs for TencentDB for MySQL
- Enhancing Business Load Capacity with TencentDB for MySQL
- Building LAMP Stack for Web Application
- Building Drupal Website
- Calling MySQL APIs in Python
- White Paper
- Troubleshooting
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Backup APIs
- Task APIs
- Security APIs
- Data Import APIs
- Parameter APIs
- Instance APIs
- DescribeDBInstanceGTID
- CloseWanService
- SwitchForUpgrade
- CreateDBInstanceHour
- DescribeDBInstanceCharset
- ModifyDBInstanceVipVport
- ModifyDBInstanceProject
- IsolateDBInstance
- UpgradeDBInstanceEngineVersion
- DescribeDBInstances
- InitDBInstances
- DescribeDBInstanceRebootTime
- OpenWanService
- UpgradeDBInstance
- ModifyDBInstanceName
- DescribeDBZoneConfig
- RestartDBInstances
- OpenDBInstanceGTID
- DescribeDBSwitchRecords
- DescribeDBInstanceConfig
- ModifyAutoRenewFlag
- ModifyInstanceTag
- DescribeTagsOfInstanceIds
- ModifyTimeWindow
- DescribeTimeWindow
- DeleteTimeWindow
- AddTimeWindow
- OfflineIsolatedInstances
- ReleaseIsolatedDBInstances
- ModifyRoGroupInfo
- DescribeRoGroups
- BalanceRoGroupLoad
- DescribeDBInstanceInfo
- DescribeRoMinScale
- CreateRoInstanceIp
- StopDelayReplication
- StartDelayReplication
- ModifyRoType
- ModifyRoReplicationDelay
- SwitchDBInstanceMasterSlave
- SwitchDrInstanceToMaster
- CreateDeployGroup
- DeleteDeployGroups
- DescribeDeployGroupList
- ModifyNameOrDescByDpId
- Database APIs
- Account APIs
- Rollback APIs
- Monitoring APIs
- Log APIs
- Data Types
- Error Codes
- FAQs
- Service Agreement
- Notice
- Reference
- Glossary
- Contact Us
- Release Notes
- User Tutorial
- Product Introduction
- Tencent Kernel TXSQL
- Purchase Guide
- Get Started
- Operation Guide
- Best Practice
- Usage Specifications of TencentDB for MySQL
- Configuring Application Automatic Reconnection
- Impact of Modifying MySQL Master Instance Parameters
- Limits on Automatic Conversion from MyISAM to InnoDB
- Creating VPCs for TencentDB for MySQL
- Enhancing Business Load Capacity with TencentDB for MySQL
- Building LAMP Stack for Web Application
- Building Drupal Website
- Calling MySQL APIs in Python
- White Paper
- Troubleshooting
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Backup APIs
- Task APIs
- Security APIs
- Data Import APIs
- Parameter APIs
- Instance APIs
- DescribeDBInstanceGTID
- CloseWanService
- SwitchForUpgrade
- CreateDBInstanceHour
- DescribeDBInstanceCharset
- ModifyDBInstanceVipVport
- ModifyDBInstanceProject
- IsolateDBInstance
- UpgradeDBInstanceEngineVersion
- DescribeDBInstances
- InitDBInstances
- DescribeDBInstanceRebootTime
- OpenWanService
- UpgradeDBInstance
- ModifyDBInstanceName
- DescribeDBZoneConfig
- RestartDBInstances
- OpenDBInstanceGTID
- DescribeDBSwitchRecords
- DescribeDBInstanceConfig
- ModifyAutoRenewFlag
- ModifyInstanceTag
- DescribeTagsOfInstanceIds
- ModifyTimeWindow
- DescribeTimeWindow
- DeleteTimeWindow
- AddTimeWindow
- OfflineIsolatedInstances
- ReleaseIsolatedDBInstances
- ModifyRoGroupInfo
- DescribeRoGroups
- BalanceRoGroupLoad
- DescribeDBInstanceInfo
- DescribeRoMinScale
- CreateRoInstanceIp
- StopDelayReplication
- StartDelayReplication
- ModifyRoType
- ModifyRoReplicationDelay
- SwitchDBInstanceMasterSlave
- SwitchDrInstanceToMaster
- CreateDeployGroup
- DeleteDeployGroups
- DescribeDeployGroupList
- ModifyNameOrDescByDpId
- Database APIs
- Account APIs
- Rollback APIs
- Monitoring APIs
- Log APIs
- Data Types
- Error Codes
- FAQs
- Service Agreement
- Notice
- Reference
- Glossary
- Contact Us
1. API Description
Domain name for API request: cdb.tencentcloudapi.com.
This API is used to query the basic information of an instance (instance ID, instance name, and whether encryption is enabled).
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: DescribeDBInstanceInfo. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| InstanceName | String | Instance name. |
| Encryption | String | Whether encryption is enabled. YES: enabled, NO: not enabled. |
| KeyId | String | Encryption key ID. Note: this field may return null, indicating that no valid values can be obtained. |
| KeyRegion | String | Key region. Note: this field may return null, indicating that no valid values can be obtained. |
| DefaultKmsRegion | String | The default region of the KMS service currently used by the TencentDB backend service. Note: this field may return null, indicating that no valid value can be found. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying instance information
Input Example
https://cdb.tencentcloudapi.com/?Action=DescribeDBInstanceInfo
&InstanceId=cdb-oaj9cbla
&<Common request parameters>
Output Example
{
"Response": {
"DefaultKmsRegion": "ap-hongkong",
"Encryption": "NO",
"InstanceId": "cdb-oaj9cbla",
"InstanceName": "cdb_name",
"KeyId": "",
"KeyRegion": "",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
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 NodeJS
- 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 |
|---|---|
| InvalidParameter | Parameter error. |
| InvalidParameter.ResourceNotExists | The resource does not exist. |
Yes
No
Was this page helpful?