Enable Fine-Grained PolarDB Cluster Monitoring via API - PolarDB - Alibaba Cloud - PolarDB

Operation description

When the monitoring data is collected every 5 seconds:
- If the query time range is less than or equal to 1 hour, the data is displayed at intervals of 5 seconds.
- If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
- If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
- If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
- When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.
When the monitoring data is collected every 60 seconds:
- If the query time range is less than or equal to one day, the data is displayed at intervals of 1 minute.
- If the query time range is less than or equal to seven days, the data is displayed at intervals of 10 minutes.
- If the query time range is less than or equal to 30 days, the data is displayed at intervals of 1 hour.
- When the query time range is greater than 30 days, the data is displayed at intervals of 1 day.

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

polardb:ModifyDBClusterMonitor

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-****************
Period	string	Yes	The interval at which monitoring data is collected. Valid values: 5 and 60. Unit: seconds.	5

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	75B92353-73B4-447B-8477-C85F3C******

Examples

Success response

JSON format

{
  "RequestId": "75B92353-73B4-447B-8477-C85F3C******"
}

Error codes

HTTP status code	Error code	Error message	Description
403	OperationDenied.DBInstanceMonitorPeriod	Current DB instance does not support this monitor period.	The monitoring cycle is not supported by the current cluster.
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBInstanceId parameter does not exist in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.