DescribeDBInstanceInfo

最后更新时间：2024-11-20 11:15:02

1. API Description

Domain name for API request: cdb.intl.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.

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: DescribeDBInstanceInfo.
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.

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, 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 instance information

Input Example

POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstanceInfo
<Common request parameters>

{
    "InstanceId": "cdb-oaj9cbla"
}

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.

Command Line Interface

Tencent Cloud CLI 3.0

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.
InternalError.DBOperationError	Database operation failed.
InternalError.JSONError	Failed to parse JSON.
InternalError.NetworkError	Network error
InternalError.UnknownError	Unknown error
InvalidParameter	Parameter error.
InvalidParameter.ControllerNotFoundError	This API was not found.
InvalidParameter.ResourceNotExists	The resource does not exist.

tencent cloud

Recent Pages