tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for DBbrainSpace Analysis APIsDescribeDBSpaceStatus
DescribeDBSpaceStatus
Last updated: 2023-10-17 10:51:52
DescribeDBSpaceStatus
Last updated: 2023-10-17 10:51:52

1. API Description

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

This API is used to query the overview of instance space usage during a specified time period, including disk usage growth (MB), available disk space (MB), total disk space (MB), and estimated number of available days.

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: DescribeDBSpaceStatus.
Version Yes String Common Params. The value used for this API: 2021-05-27.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID.
RangeDays No Integer Query period in days. The end date is the current date, and the query period is 7 days by default.
Product No String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql.

3. Output Parameters

Parameter Name Type Description
Growth Integer Disk usage growth in MB.
Remain Integer Available disk space in MB.
Total Integer Total disk space in MB.
AvailableDays Integer Estimated number of available days.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the overview of instance space usage during the specified time period

Input Example

https://dbbrain.tencentcloudapi.com/?Action=DescribeDBSpaceStatus
&InstanceId=cdb-test
&RangeDays=5
&<Common request parameters>

Output Example

{
    "Response": {
        "Remain": 23224,
        "RequestId": "78cf7bb1-0608-11ea-a9ef-2736f0f7f829",
        "Growth": 231,
        "Total": 50000,
        "AvailableDays": 35
    }
}

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 Error with CAM signature/authentication.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.UserHasNoStrategy Error with CAM authentication.
ResourceNotFound The resource does not exist.
UnauthorizedOperation The operation is unauthorized.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon