DescribeDBInstanceInfo

Last updated: 2020-11-05 19:20:58

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 Getting the basic information of an instance

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeDBInstanceInfo
&InstanceId=cdb-***
&<Public request parameters>

Output Example

{
  "Response": {
    "InstanceId": "test",
    "InstanceName": "test",
    "Encryption": "YES",
    "KeyId": "sdasdd-12asdasd",
    "KeyRegion": "ap-guangzhou",
    "RequestId": "faae8d6a-38fb-44de-988e-5a0e78aba4a7"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InvalidParameter Parameter error.
InvalidParameter.ResourceNotExists The resource does not exist.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help