Domain name for API request: tdmysql.intl.tencentcloudapi.com.
This API is used to query the data retention space of an instance.
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: DescribeInstanceDataReservedSpace. |
| Version | Yes | String | Common Params. The value used for this API: 2021-11-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID. |
| Parameter Name | Type | Description |
|---|---|---|
| ReservedRate | Float | Actual reserved ratio (%, per node) |
| ReservedSpaceGB | Float | Actual reserved space in GB (single node) Unit: GB |
| UsableSpaceGB | Float | Available user space in GB (per node) Unit: GB |
| IsLegacy | Boolean | true=earlier version (<21.6.4.0), value from the old parameter tdstore_enter_readonly_threshold; false=new version |
| KernelVersion | String | Kernel version number |
| 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. |
POST / HTTP/1.1
Host: tdmysql.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceDataReservedSpace
<Common request parameters>
{
"InstanceId": "tdsql3-51780d0c"
}{
"Response": {
"IsLegacy": false,
"KernelVersion": "21.6.4.0",
"ReservedRate": 2,
"ReservedSpaceGB": 1,
"UsableSpaceGB": 49,
"RequestId": "98b162aa-f038-4e06-a4bd-9a93b589fc3c"
}
}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.CamAuthError | CAM authentication error. |
| AuthFailure.CheckCamAuthError | CAM authentication request parameter check failed. |
| AuthFailure.UnauthorizedOperation | CAM authentication failure. |
| FailedOperation.CheckSupportActionError | The current instance version does not support this API. |
| FailedOperation.DBQueryInstanceError | Query instance data failed. |
| InvalidParameterValue.CheckSpecError | Instance specification validation error. |
| LimitExceeded.OutOfSpecLimitError | The specification exceeds the limit. |
| OperationDenied.InstanceStatusError | Incorrect instance status. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback