Queries the trend forecast information of disk usage, queries per second (QPS), and transactions per second (TPS) of an AnalyticDB for MySQL cluster for a specified date.

For more information about trend charts, see Daily health reports.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBClusterForecast

The operation that you want to perform. Set the value to DescribeDBClusterForecast.

StartTime String Yes 2021-08-30

The date to query. Specify the time in the yyyy-MM-dd format. The time must be in UTC.

DBClusterId String Yes am-****************

The ID of the cluster.

Note You can call the DescribeDBClusters operation to query the details of all AnalyticDB for MySQL clusters within a specified region, including cluster IDs.
RegionId String Yes cn-hangzhou

The ID of the region.

Note You can call the DescribeRegions operation to query the regions and zones supported by AnalyticDB for MySQL, including region IDs.
MetricType String No adbmysql_diskStatistics_disk_used

The dimension by which to query the trend forecast information within the specified time range starting from the date specified by StartTime. Valid values:

  • adbmysql_diskStatistics_disk_used: The system measures the disk usage on an hourly basis, and makes a forecast for the next two weeks based on the reported disk usage from the last two weeks.
  • adbmysql_qps_qps: The system measures the QPS on an hourly basis, and makes a forecast for the next two days based on the reported QPS from the last seven days.
  • adbmysql_tps_tps: The system measures the TPS on an hourly basis, and makes a forecast for the next two days based on the reported TPS from the last seven days.
Note If this parameter is not specified, the trend forecast information of all dimensions is returned.

Response parameters

Parameter Type Example Description
Performances Array of Performances

Details about the metrics.

Key String adbmysql_diskStatistics_disk_used

The metric name.

Unit String MB

The unit.

Note This parameter is returned only when the Key parameter is set to adbmysql_diskStatistics_disk_used.
Series Array of Series

Details about the metrics at each point in time.

Name String fact

The metric value. Valid values:

  • fact: the actual observed value.
  • yhat: the trend forecast value.
  • yhatLower: the minimum trend forecast value.
  • yhatUpper: the maximum trend forecast value.
Values String ["2021-08-16 23:58:49","12889.5584"]

The specific value of the corresponding metric at each point in time.

RequestId String B6B60C7B-897D-5F95-A9E9-CCA23C******

The ID of the request.

Examples

Sample requests

http(s)://adb.aliyuncs.com/?Action=DescribeDBClusterForecast
&StartTime=2021-08-30
&DBClusterId=am-****************
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClusterForecastResponse>
    <RequestId>B6B60C7B-897D-5F95-A9E9-CCA23C******</RequestId>
    <Performances>
        <Series>
            <Values>
                <0>2021-08-16 23:58:49</0>
                <1>12889.5584</1>
            </Values>
            <Values>
                <0>2021-08-17 00:00:19</0>
                <1>12889.5823</1>
            </Values>
            <Name>fact</Name>
        </Series>
        <Series>
            <Values>
                <0>2021-08-16 23:58:49</0>
                <1>12923.9609</1>
            </Values>
            <Values>
                <0>2021-08-17 00:00:19</0>
                <1>12923.8966</1>
            </Values>
            <Name>yhat</Name>
        </Series>
        <Series>
            <Values>
                <0>2021-08-16 23:58:49</0>
                <1>12858.7716</1>
            </Values>
            <Values>
                <0>2021-08-17 00:00:19</0>
                <1>12854.6119</1>
            </Values>
            <Name>yhatLower</Name>
        </Series>
        <Series>
            <Values>
                <0>2021-08-16 23:58:49</0>
                <1>12992.0099</1>
            </Values>
            <Values>
                <0>2021-08-17 00:00:19</0>
                <1>12992.8980</1>
            </Values>
            <Name>yhatUpper</Name>
        </Series>
        <Unit>MB</Unit>
        <Key>adbmysql_diskStatistics_disk_used</Key>
    </Performances>
</DescribeDBClusterForecastResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "B6B60C7B-897D-5F95-A9E9-CCA23C******",
  "Performances" : [ {
    "Series" : [ {
      "Values" : [ [ "2021-08-16 23:58:49", "12889.5584" ], [ "2021-08-17 00:00:19", "12889.5823" ] ],
      "Name" : "fact"
    }, {
      "Values" : [ [ "2021-08-16 23:58:49", "12923.9609" ], [ "2021-08-17 00:00:19", "12923.8966" ] ],
      "Name" : "yhat"
    }, {
      "Values" : [ [ "2021-08-16 23:58:49", "12858.7716" ], [ "2021-08-17 00:00:19", "12854.6119" ] ],
      "Name" : "yhatLower"
    }, {
      "Values" : [ [ "2021-08-16 23:58:49", "12992.0099" ], [ "2021-08-17 00:00:19", "12992.8980" ] ],
      "Name" : "yhatUpper"
    } ],
    "Unit" : "MB",
    "Key" : "adbmysql_diskStatistics_disk_used"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.