Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query cloud database version attributes, including whether database encryption and database audit are supported, and other features.
A maximum of 20 requests can be initiated per second for this API.
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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| 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. |
| 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 | Primary instance region. Description: This parameter may return null. You can ignore this return value. If needed, you can call the Query Instance List API to obtain the instance region details. |
| 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, 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. |
Query instance features, such as kernel minor version and whether audit is enabled.
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBFeatures
<Common request parameters>
{
"InstanceId": "cdb-qwerasdf"
}
{
"Response": {
"AuditNeedUpgrade": false,
"CurrentSubVersion": "20230701",
"EncryptionNeedUpgrade": false,
"IsRemoteRo": false,
"IsSupportAudit": true,
"IsSupportEncryption": true,
"IsSupportUpdateSubVersion": true,
"MasterRegion": "",
"RequestId": "68782c1e-d613-4451-b993-adef1cc7a3a6",
"TargetSubVersion": "20230702"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
フィードバック