DescribeMetricsData-阿里云帮助中心

This API retrieves single- or multi-dimensional monitoring metrics for an OceanBase cluster.

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

oceanbase:DescribeMetricsData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
StartTime	string	Yes	The start time for the query. The time must be in UTC and use the YYYY-MM-DDThh:mm:ssZ format.	2021-06-13T15:40:43Z
EndTime	string	Yes	The end time for the query. The time must be in UTC and use the YYYY-MM-DDThh:mm:ssZ format.	2021-06-13T15:40:43Z
Metrics	string	Yes	The monitoring metrics to query. Separate multiple metrics with a comma. For example, "sql_all_count,sql_all_rt...".	sql_all_count
Labels	string	Yes	A string of key-value pairs. Use a colon (:) to separate keys from values, and a comma (,) to separate key-value pairs. For example: "app:OB,clusterId:ob***,tenantId:t**,serverId:***,zoneId:cn-hangzhou-j". The supported keys are as follows: app: The application type. Currently, only OceanBase is supported. clusterId: The ID of the OceanBase cluster. tenantId: The ID of the OceanBase tenant. zoneId: The ID of the OceanBase zone. serverId: The ID of the OBServer node.	app:OB,clusterId:ob***
GroupByLabels	string	Yes	The fields by which to group the results. Separate multiple fields with a comma. For example: "app,clusterId,tenantId".	app,clusterId
SortMetricKey	string	No	The metric key by which to sort the results.	tps
SortOrder	string	No	The sort order. ASC: ascending order. DESC: descending order.	DESC
Limit	string	No	The maximum number of items to return.	5
ReplicaType	string	No	The replica type. In OceanBase cluster monitoring, this parameter filters nodes by replica type. Default (unspecified): Retrieves monitoring data for all replica types. This applies to both OceanBase and access proxy monitoring. FULL: Retrieves monitoring data from full-featured replica nodes only. This value is valid only for OceanBase monitoring. READONLY: Retrieves monitoring data from read-only replica nodes only. This value is valid only for OceanBase monitoring.	FULL

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	array	The returned data.	[ { "sql_select_count":75.**151515, "timestamp":165079** }, ...... ]
	string	A JSON-formatted string that contains the data points.	[{'clusterId': 'ob5b8*******', 'Data': [{'timestamp': 1702434300, 'sql_all_rt': 0.64}, {'timestamp': 1702434240, 'sql_all_rt': 0.0}], 'tenantId': 't5b8*******'}]

Examples

Success response

JSON format

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    "[{'clusterId': 'ob5b8*********', 'Data': [{'timestamp': 1702434300, 'sql_all_rt': 0.64}, {'timestamp': 1702434240, 'sql_all_rt': 0.0}], 'tenantId': 't5b8*********'}]"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.