tencent cloud

TencentDB for MySQL

ドキュメントTencentDB for MySQLAPIドキュメントInstance APIsDescribeDBInstanceInfo

DescribeDBInstanceInfo

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-06-03 10:37:23

1. API Description

Domain name for API request: cdb.intl.tencentcloudapi.com.

This API is used to query the basic information of an instance, including instance ID, instance name, and whether encryption is enabled. Querying read-only instances is not supported.

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, which can be obtained through the DescribeDBInstances API.
Description: Only the primary instance supports querying. This item only supports input of the primary 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 Key ID used for encryption.
KeyRegion String Key region.
DefaultKmsRegion String The default region of the KMS service used by the current CDB backend service.
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 Query 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": "***-CDB",
        "KeyRegion": "ap-hongkong",
        "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

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.
前の記事へ: DescribeDBInstanceGTID次の記事へ: DescribeDBInstanceRebootTime

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック