更新时间:2025-09-11 GMT+08:00
分享

查询实例列表指标

功能介绍

查询实例列表指标。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/instances/metric-data

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。例如:该参数指定为1,limit指定为10,则只展示第2~11条数据。

约束限制:

不涉及。

取值范围:

[0, 2^31-1]

默认取值:

默认为0(偏移0条数据,表示从第一条数据开始查询)。

limit

Integer

参数解释:

查询记录数。例如该参数设定为10,则查询结果最多只显示10条记录。

约束限制:

不涉及。

取值范围:

[1, 50]

默认取值:

默认为50。

name

String

参数解释:

实例名称。

用于表示实例的名称,同一租户下,同类型的实例名可重名。

约束限制:

不涉及。

取值范围:

4~64个字符之间,必须以字母开头,区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。

默认取值:

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为36个字符。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围

  • zh-cn
  • en-us

默认取值

en-us

响应参数

表4 响应Body参数

参数

参数类型

描述

instances

Array of InstancesMetricResult objects

参数解释:

实例信息。详情请参见 表5

total_count

Integer

参数解释:

总记录数。

取值范围:

只能由英文字母、数字组成,且长度为36个字符。

表5 InstancesMetricResult字段数据结构说明

参数

参数类型

描述

id

String

参数解释:

实例ID。

取值范围:

不涉及。

name

String

参数解释:

实例名称。

取值范围:

不涉及。

status

String

参数解释:

实例状态。

取值范围:

  • creating:实例正在创建。
  • normal:实例正常。
  • abnormal:实例异常。
  • createfail:实例创建失败。

mode

String

参数解释:

实例类型。

取值范围:

不涉及。

engine_name

String

参数解释:

引擎名称。

取值范围:

不涉及。

engine_version

String

参数解释:

引擎版本。

取值范围:

不涉及。

solution

String

参数解释:

部署形态。

取值范围:

不涉及。

disk_used_size

String

参数解释:

实例数据磁盘已使用大小。

取值范围:

不涉及。

disk_total_size

String

参数解释:

实例数据磁盘总大小。

取值范围:

不涉及。

disk_usage

String

参数解释:

实例数据磁盘已使用百分比。

取值范围:

不涉及。

p80

String

参数解释:

80% SQL的响应时间。

取值范围:

不涉及。

p95

String

参数解释:

95% SQL的响应时间。

取值范围:

不涉及。

deadlocks

String

参数解释:

死锁次数。

取值范围:

不涉及。

buffer_hit_ratio

String

参数解释:

buffer 命中率。

取值范围:

不涉及。

nodes

Array of InstancesNodesResult objects

参数解释:

实例节点信息列表。详情请参见 表6

表6 InstancesNodesResult字段数据结构说明

参数

参数类型

描述

id

String

参数解释:

节点ID。

取值范围:

不涉及。

name

String

参数解释:

节点名称。

取值范围:

不涉及。

component_ids

Array of Strings

参数解释:

组件ID列表。

请求示例

查询实例列表指标。

https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/metric-data?instance_id=e73893ef73754465a8bd2e0857bbf13ein14

响应示例

{ 
  "instances" : [ { 
    "id" : "ad8cd1440aa94a02ae4580fcbebb3143in14", 
    "name" : "user1-v3-independent", 
    "status" : "BUILD", 
    "mode" : "集中式版", 
    "engine_name" : "GaussDB", 
    "engine_version" : "8.0.92", 
    "solution" : "1主2备", 
    "disk_used_size" : 1.05, 
    "disk_total_size" : 160, 
    "disk_usage" : 0.62, 
    "p80" : 342, 
    "p95" : 501, 
    "deadlocks" : 0, 
    "buffer_hit_ratio" : 0, 
    "nodes" : [ { 
      "id" : "6b7616dfb1c14721b1a11dd5654c1515no14", 
      "name" : "DataNode1", 
      "component_ids" : [ "dn_6001", "dn_6002" ] 
    } ] 
  } ], 
  "total_count" : 100 
}

状态码

错误码

请参见错误码

相关文档