DescribeDatabaseInstanceMetricData-阿里云帮助中心

Operation description

After you create a lightweight database instance, you can retrieve its detailed monitoring metrics. These metrics include CPU and memory usage, disk space, IOPS (Input/Output Operations Per Second), and the number of connections.

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

swas-open:DescribeDatabaseInstanceMetricData

get

*Instance

acs:swas-open:{#regionId}:{#accountId}:instance/{#DatabaseInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the lightweight database instance. You can call the ListRegions operation to get the latest list of Alibaba Cloud regions.	cn-hangzhou
DatabaseInstanceId	string	Yes	The ID of the lightweight database instance.	db-38263fa955774501a2ae1bdaed6f****
MetricName	string	Yes	The name of the metric. Valid values: `MySQL_MemCpuUsage`: The CPU utilization and memory usage of the instance, as a percentage of the total resources of the operating system. `MySQL_DetailedSpaceUsage`: The total, data, log, temporary, and system disk space usage of the instance. `MySQL_Sessions`: The number of active and total connections. `MySQL_IOPS`: The IOPS of the instance.	MySQL_MemCpuUsage
StartTime	string	Yes	The start of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC. Note The time in the console is displayed in UTC+8.	2022-09-06T04:04Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mmZ` format. The time must be in UTC. Note The time in the console is displayed in UTC+8.	2022-09-07T04:04Z

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****
MetricName	string	The name of the metric. Valid values: `MySQL_MemCpuUsage`: The CPU utilization and memory usage of the instance, as a percentage of the total resources of the operating system. `MySQL_DetailedSpaceUsage`: The total, data, log, temporary, and system disk space usage of the instance. `MySQL_Sessions`: The number of active and total connections. `MySQL_IOPS`: The IOPS of the instance.	MySQL_MemCpuUsage
Unit	string	The unit of the metric data. % int MB	%
DataFormat	string	The format of the metric data. Valid values: `cpuusage&memusage` `active_session&total_session` `ins_size&data_size&log_size&tmp_size&other_size` `io`	cpuusage&memusage
MetricData	string	The metric data details.	[ { \"date"\: " 2022-09-06T04:04:00Z",\"value\":\"0.77&3.69\" } ]

Examples

Success response

JSON format

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "MetricName": "MySQL_MemCpuUsage",
  "Unit": "%",
  "DataFormat": "cpuusage&memusage",
  "MetricData": "[  {     \\\"date\"\\: \" 2022-09-06T04:04:00Z\",\\\"value\\\":\\\"0.77&3.69\\\"  } ]"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.