tencent cloud

TencentDB for DBbrain

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Strengths
Use Cases
Feature List
Region List
Purchase Guide
Operation Guide
Cloud Access Management
Self-Built Database Access
Instance Overview
Instance Management
Monitoring and Alarms
Health Report and Kill Session Report Management
MySQL/TDSQL-C for MySQL Performance Optimization
TDSQL for MySQL/MariaDB Performance Optimization
Distributed cache database (Distributed Cache) diagnostic optimization
MongoDB Performance Optimization
Full-Link Analysis
Practical Tutorial
Fixing High CPU Utilization on MySQL Instance
Fixing Lock Conflict on MySQL Instance
How to Address High CPU Utilization Issues in Distributed Cache Instances
Fixing High CPU Utilization in MongoDB Instance
Fixing Short Node Oplog Retention Period in MongoDB Instance
API Documentation
History
Introduction
Introduction
API Category
Making API Requests
Session Killing APIs
Exception Detection APIs
Other APIs
Redis related APIs
Health Report Email Sending APIs
Space Analysis APIs
Slow Log Analysis APIs
Security Audit APIs
Database Audit APIs
Data Types
Error Codes
DBbrain APIs 2019-10-16
FAQs
Self-Built Database Issues
MySQL Performance
Product
Service Level Agreement
Glossary
Contact Us

DescribeDBSpaceStatus

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-10-28 22:23:54

1. API Description

Domain name for API request: dbbrain.intl.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: 2019-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
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 (TencentDB for CynosDB (compatible with 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, 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.

4. Example

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

Input Example

https://dbbrain.intl.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
FailedOperation Operation failed.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
OperationDenied.UserHasNoStrategy Error with CAM authentication.
UnauthorizedOperation The operation is unauthorized.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백