DescribeDBFeatures

最后更新时间：2024-01-30 10:26:07

1. API Description

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

This API is used to query database version attributes, including supported features such as database encryption and audit.

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: DescribeDBFeatures.
Version	Yes	String	Common Params. The value used for this API: 2017-03-20.
Region	No	String	Common Params. This parameter is not required for this API.
InstanceId	Yes	String	Instance ID in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB console.

3. Output Parameters

Parameter Name	Type	Description
IsSupportAudit	Boolean	Whether database audit is supported
AuditNeedUpgrade	Boolean	Whether enabling audit requires a kernel version upgrade
IsSupportEncryption	Boolean	Whether database encryption is supported
EncryptionNeedUpgrade	Boolean	Whether enabling encryption requires a kernel version upgrade
IsRemoteRo	Boolean	Whether the instance is a remote read-only instance
MasterRegion	String	Region of the source instance
IsSupportUpdateSubVersion	Boolean	Whether minor version upgrade is supported
CurrentSubVersion	String	The current kernel version
TargetSubVersion	String	Available kernel version for upgrade
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the version attributes of an instance

This API is used to query instance features, such as kernel minor version, and audit enablement status.

Input Example

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

{
    "InstanceId": "cdb-qwerasdf"
}

Output Example

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "IsSupportAudit": true,
        "AuditNeedUpgrade": false,
        "IsSupportEncryption": true,
        "EncryptionNeedUpgrade": false,
        "IsRemoteRo": false,
        "MasterRegion": "",
        "IsSupportUpdateSubVersion": true,
        "CurrentSubVersion": "20190203",
        "TargetSubVersion": "20190930"
    }
}

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.HttpError	Exceptional HTTP request
InternalError.JSONError	Failed to parse JSON.
InternalError.NetworkError	Network error
InternalError.UnknownError	Unknown error
InvalidParameter	Parameter error.
InvalidParameter.InstanceNotFound	The instance does not exist.
OperationDenied	Operation denied.

tencent cloud

Recent Pages