DescribeDrdsInstanceMonitor - PolarDB - Alibaba Cloud Documentation Center

Invokes the DescribeDrdsInstanceMonitor operation to query the details of instance monitoring data.

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

drds:DescribeDrdsInstanceMonitor

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drds*********
Key	string	Yes	The performance monitoring metrics. You can specify multiple metrics in a single request. Separate multiple metrics with commas (,). Note For more information about performance monitoring metrics, see Instance monitoring.	cpu
StartTime	integer	Yes	The start time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds.	1603123290000
EndTime	integer	Yes	The end time of the query. Specify a UNIX timestamp in UTC. Unit: milliseconds. Note If the query time range is less than 1 hour, the data within 1 hour before the end time is returned.	1603209690000
PeriodMultiple	integer	No	The multiplier for the monitoring data collection period. For example, the default data collection period for each resource monitoring metric is 1 minute. If you set the period multiplier to 2, the data collection period for the current resource monitoring metric is 2 minutes.	1
RegionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	2F7F8080-9132-4279-85D0-B7E5C4
Data	array<object>	The query result set.
	array<object>
Key	string	The name of the monitoring metrics.	cpu
Unit	string	The unit of the monitoring metrics.	%
NodeNum	integer	The number of nodes.	1
Values	array<object>	The details of the monitoring metrics data.
	object
Date	integer	The point in time when the value of the metric was collected. The value is in the UNIX timestamp format. The timestamp is displayed in UTC. Unit: ms.	1603163400000
Value	string	The value of the metric.	1.40

Examples

Success response

JSON format

{
  "RequestId": "2F7F8080-9132-4279-85D0-B7E5C4",
  "Data": [
    {
      "Key": "cpu",
      "Unit": "%",
      "NodeNum": 1,
      "Values": [
        {
          "Date": 1603163400000,
          "Value": "1.40"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ActionUnauthorized	The specified action is not available for you
400	InvalidParameter.Mismatch	Invalid parameter of key
400	InvalidParameter.time	The startTime and endTime must in one week
400	InvalidParameter.periodMultiple	The periodMultiple is too larger than the time between startTime and endTime
400	DrdsInstance.NotExists	The drds instance does not exist.
400	InvalidParameter	invalid parameter.	Parameter exception
500	InternalError	The request processing has failed due to some unknown error.
404	Monitor.QueryRdsFailure	Failed to query RDS monitor info.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.