调用DescribeDBNodePerformance接口查询实例性能数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBNodePerformance

系统规定参数。取值:DescribeDBNodePerformance

Key String Cpu_Usage,Mem_Usage

指标名称,多个用英文逗号分隔,最多6个。详细内容请参见性能参数表章节。

StartTime String 2012-06-08T15:00Z

查询开始时间, 格式: YYYY-MM-ddTHH:mmZ(UTC时间)。

DBInstanceName String pxc-*******

PolarDB-X实例名称。

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

节点名称,多个用英文逗号分隔,CDC节点和计算节点一次最多支持10个节点,数据节点一次最多支持1个节点。

CharacterType String polarx_cn

节点类型。目前包含polarx_cn、polarx_dn、polarx_cdc、polarx_gms。

DBNodeRole String master

节点类型,取值:

  • master:主节点
  • slave:备节点

只对DN和GMS节点生效。

RegionId String cn-hangzhou

地域ID。

EndTime String 2012-06-18T15:00Z

查询结束时间, 格式: YYYY-MM-ddTHH:mmZ(UTC时间)。

返回数据

名称 类型 示例值 描述
EndTime String 2021-10-20T02:00Z

查询结束时间, 格式: YYYY-MM-ddTHH:mm:ssZ(UTC时间)。

StartTime String 2021-10-20T00:00Z

查询开始时间, 格式: YYYY-MM-ddTHH:mm:ssZ(UTC时间)。

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

实例名称。

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

请求ID。

PerformanceKeys Array of PerformanceItem

性能数据列表。

PerformanceItem
MetricName String logic_tps

具体的性能指标度量名称。

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

节点名称。

Measurement String Logic_TPS

性能指标。

Points Array of PerformanceItemValue

性能数据数组。

PerformanceItemValue
Value String 42.38

监控指标数据值。

Timestamp Long 1600822800000

监控指标的具体时间点,格式为时间戳,单位为毫秒。

示例

请求示例

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
&公共请求参数

正常返回示例

XML格式

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格式

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
    } ]
  } ]
}

错误码

访问错误中心查看更多错误码。