Queries the performance metrics of a PolarDB-X instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBNodePerformance

The operation that you want to perform. Set the value to DescribeDBNodePerformance.

Key String Yes Cpu_Usage,Mem_Usage

The name of one or more metrics. Separate multiple metric names with commas (,). You can specify up to six metric names. For more information, see Performance parameters.

StartTime String Yes 2012-06-08T15:00Z

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

DBInstanceName String Yes pxc-*******

The name of the instance.

DBNodeIds String Yes pxc-i-******,pxc-i-*******

The name of one or more nodes. Separate multiple node names with commas (,). In the same request, you can specify a maximum of 10 Change Data Capture (CDC) nodes, a maximum of 10 compute nodes, and a maximum of one data node.

CharacterType String Yes polarx_cn

The node type. Valid values: polarx_cn, polarx_dn, polarx_cdc, and polarx_gms.

DBNodeRole String Yes master

The role of the node. Valid values:

  • master: a primary node
  • slave: a secondary node

This parameter is valid only for data nodes and Global Meta Service (GMS) nodes.

RegionId String Yes cn-hangzhou

The region ID of the instance.

EndTime String Yes 2012-06-18T15:00Z

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Response parameters

Parameter Type Example Description
EndTime String 2021-10-20T02:00Z

The end of the time range in which the performance metrics were queried. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

StartTime String 2021-10-20T00:00Z

The beginning of the time range in which the performance metrics were queried. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

DBInstanceName String pxc-********

The name of the instance.

RequestId String EFB5E10B-5268-170F-A378-9AF86CCEACC8

The ID of the request.

PerformanceKeys Array of PerformanceItem

The details about the performance metric data.

PerformanceItem
MetricName String logic_tps

The name of the performance metric.

DBNodeId String pxc-i-********

The name of the node.

Measurement String Logic_TPS

The performance metric.

Points Array of PerformanceItemValue

The data array returned for the performance metric.

PerformanceItemValue
Value String 42.38

The value of the metric.

Timestamp Long 1600822800000

The time when the metric value was collected. This value is a timestamp that represents the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBNodePerformance
&Key=Cpu_Usage,Mem_Usage
&StartTime=2012-06-08T15:00Z
&DBInstanceName=pxc-*******
&DBNodeIds=pxc-i-******,pxc-i-*******
&CharacterType=polarx_cn
&DBNodeRole=master
&RegionId=cn-hangzhou
&EndTime=2012-06-18T15:00Z
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBNodePerformanceResponse>
    <EndTime>2021-10-20T02:00Z</EndTime>
    <StartTime>2021-10-20T00:00Z</StartTime>
    <DBInstanceName>pxc-********</DBInstanceName>
    <RequestId>EFB5E10B-5268-170F-A378-9AF86CCEACC8</RequestId>
    <PerformanceKeys>
        <MetricName>logic_tps</MetricName>
        <DBNodeId>pxc-i-********</DBNodeId>
        <Measurement>Logic_TPS</Measurement>
        <Points>
            <Value>42.38</Value>
            <Timestamp>1600822800000</Timestamp>
        </Points>
    </PerformanceKeys>
</DescribeDBNodePerformanceResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.