DescribeMonitorData-阿里云帮助中心

Operation description

Supported engines

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

rdsai:DescribeMonitorData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	rds_copilot*_public_cn-*******6
StartTime	integer	Yes	The start of the query time range, specified as a Unix timestamp in seconds.	1627268185
EndTime	integer	Yes	The end of the query time range, specified as a Unix timestamp in seconds.	1627269085
Metric	string	Yes	The metric to query. Valid values: `pv` `uv` `qps` `success_rate` `rt` `rate_limited_count`	● pv
Interval	integer	No	The aggregation interval for monitoring data, in seconds. Default: 15.	15
ApiKeyName	array	No	The names of the API keys to use for filtering the data. If this parameter is not specified, data from all keys is returned.
	string	No	The API key name.	api-*****

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329241C
Success	boolean	Indicates whether the request was successful.	true
Message	string	The response message.	success
Data	array<object>	The response data.
	array<object>
Name	string	The metric name.	qps
Value	array<object>	An array of data points for the metric.
	object
Time	string	The timestamp of the data point.	1774972800
Value	number	The value of the metric at the specified timestamp.	60

Examples

Success response

JSON format

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329241C",
  "Success": true,
  "Message": "success",
  "Data": [
    {
      "Name": "qps",
      "Value": [
        {
          "Time": "1774972800",
          "Value": 60
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MoInvalidIpWhitelistError	Invalid IP address or CIDR in whitelist.
400	MoDomainNotReadyError	Domain is not ready yet, please try again later.
403	InvalidUserOrder	There is no valid order for this UID.	There is no valid order for this UID
404	MoInstanceMappingNotFoundError	No active instance mapping found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.