Monitor Cluster Storage Usage with DescribeStorageResourceUsage - AnalyticDB for MySQL - Alibaba Cloud - AnalyticDB

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeStorageResourceUsage

get

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	amv-bp10yt0gva71ei7d
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-08-22T01:06:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-08-23T01:06:00Z

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEAW
Code	integer	The HTTP status code.	200
Data	object	The storage resource usage.
DBClusterId	string	The cluster ID.	amv-bp1bg858bo8c****
StartTime	string	The beginning of the time range for the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-08-22T01:06:00Z
EndTime	string	The end time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-08-23T01:06:00Z
AcuInfo	array<object>	The AnalyticDB compute unit (ACU) usage of the cluster.
	object
Name	string	The resource usage metric. Valid values: `TotalAcuNumber`: the total number of ACUs. `ReservedAcuNumber`: the number of ACUs for the reserved resources.	TotalAcuNumber
Values	array	The values of the metric at specific points in time.
	string	The value of the metric at a specific point in time.	16ACU

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEAW",
  "Code": 200,
  "Data": {
    "DBClusterId": "amv-bp1bg858bo8c****",
    "StartTime": "2022-08-22T01:06:00Z\n",
    "EndTime": "2022-08-23T01:06:00Z\n",
    "AcuInfo": [
      {
        "Name": "TotalAcuNumber",
        "Values": [
          "16ACU"
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.