Domain name for API request: mariadb.tencentcloudapi.com.
This API is used to query the encryption status of the instance data.
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: DescribeDBEncryptAttributes. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Instance ID in the format of tdsql-ow728lmc |
Parameter Name | Type | Description |
---|---|---|
EncryptStatus | Integer | Whether encryption is enabled. Valid values: 1 (enabled), 2 (disabled). |
CipherText | String | DEK key |
ExpireDate | String | DEK key expiration date |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: mariadb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBEncryptAttributes
<Common request parameters>
{
"InstanceId": "tdsql-lyzax5rb"
}
{
"Response": {
"CipherText": "",
"EncryptStatus": 0,
"ExpireDate": "1970-01-01",
"RequestId": "7c04c9f9-4b1b-4eed-ac21-45d1d8a261f4"
}
}
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 |
---|---|
FailedOperation.OssOperationFailed | Failed to request the backend API. |
InternalError | Internal error. |
InternalError.GetCipherTextFailed | Failed to get the database encryption key |
InternalError.OperateDatabaseFailed | Database operation failed. |
InvalidParameter | Parameter error. |
InvalidParameter.InstanceNotFound | Failed to find the requested instance. |
ResourceUnavailable.InstanceStatusAbnormal | Incorrect database instance status. Operations are not allowed. |
UnauthorizedOperation.PermissionDenied | You have no permission to manipulate this API or resource. |
UnsupportedOperation.InvalidOperation | The operation is not supported. |
Was this page helpful?