DescribeDBNodePerformance - PolarDB - Alibaba Cloud Documentation Center

Queries the performance data of an instance.

Operation description

Note:

The endpoint differs from other API operations. For Chinese mainland regions and Singapore, use polardbx.aliyuncs.com. For other regions, use polardbx.{region id}.aliyunc.com.
When debugging this API operation, if you receive a service unavailable error, verify that the endpoint is correct. You can switch the service address to Dubai or India and change the endpoint to polardbx.aliyuncs.com.

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

polardbx:DescribeDBNodePerformance

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Key	string	Yes	The metric names. Separate multiple names with commas (,). You can specify up to 6 metrics. For more information, see Performance metrics.	Cpu_Usage,Mem_Usage
StartTime	string	Yes	The start time of the query. Format: YYYY-MM-ddTHH:mmZ (UTC).	2012-06-08T15:00Z
DBInstanceName	string	Yes	The name of the PolarDB-X instance.	pxc-*******
DBNodeIds	string	Yes	The node names. Separate multiple names with commas (,). You can specify up to 10 CDC nodes or compute nodes at a time, and up to 1 data node at a time.	pxc-i-****,pxc-i-*****
CharacterType	string	Yes	The node type. Valid values: polarx_cn, polarx_dn, polarx_cdc, polarx_gms, and polarx_columnar.	polarx_cn
DBNodeRole	string	No	The node role. Valid values: master: primary node. slave: secondary node. Applies to DN and GMS nodes. standby: secondary node. Applies to CN nodes.	master
RegionId	string	Yes	The region ID.	cn-hangzhou
EndTime	string	Yes	The end time of the query. Format: YYYY-MM-ddTHH:mmZ (UTC).	2012-06-18T15:00Z

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time of the query. Format: YYYY-MM-ddTHH:mm:ssZ (UTC).	2021-10-20T02:00Z
StartTime	string	The start time of the query. Format: YYYY-MM-ddTHH:mm:ssZ (UTC).	2021-10-20T00:00Z
DBInstanceName	string	The instance name.	pxc-********
RequestId	string	The request ID.	EFB5E10B-5268-170F-A378-9AF86CCEACC8
PerformanceKeys	object
PerformanceItem	array<object>	The list of performance data.
	array<object>
MetricName	string	The name of the specific performance metrics measurement.	logic_tps
DBNodeId	string	The node name.	pxc-i-********
Measurement	string	The performance metrics.	Logic_TPS
Points	object
PerformanceItemValue	array<object>	The array of performance data.
	object
Value	string	The value of the monitoring metrics.	42.38
Timestamp	integer	The point in time of the monitoring metrics. The value is in the format of a UNIX timestamp. Unit: milliseconds.	1600822800000

Examples

Success response

JSON format

{
  "EndTime": "2021-10-20T02:00Z",
  "StartTime": "2021-10-20T00:00Z",
  "DBInstanceName": "pxc-********",
  "RequestId": "EFB5E10B-5268-170F-A378-9AF86CCEACC8",
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "logic_tps",
        "DBNodeId": "pxc-i-********",
        "Measurement": "Logic_TPS",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "42.38",
              "Timestamp": 1600822800000
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.