文档

DescribeTenantMetrics - 查询租户指标信息

更新时间:

查询指定 OceanBase 租户指标信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
PageSizeinteger

分页查询时设置的每页行数。

  • 最大值:100。
  • 默认值:10。
10
PageNumberinteger

分页查询的页码。

  • 起始值:1。
  • 默认值:1。
1
TenantNamedeprecatedstring

租户名称。 长度为 2~20 个字符,支持英文字母、数字和下划线,区分大小写,必须以字母或下划线开头。 不可设置为 sys。

说明
该参数后期会废弃,建议使用 TenantIdList。
pay_online
StartTimestring

监控数据的起始时间。
该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2021-06-13T15:40:43Z
EndTimestring

监控数据的结束时间。
该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2021-06-13T15:45:43Z
Metricsstring

监控指标项。
当前可支持的指标及说明请参考 租户监控数据详情

tps
TenantIddeprecatedstring

租户 ID。

说明
该参数后期会废弃,建议使用 TenantIdList。
tfafd34fs****
TenantIdListstring

租户 ID 列表。

[tdak3nac****,tdakc42df****]

返回参数

名称类型描述示例值
object

请求的返回结果

TotalCountinteger

总数量。

9
RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
TenantMetricsstring

租户指标信息。

"Metrics":[ {"request_queue_rt":0.0,"TimeStamp":"2022-02-23T01:58:00Z"}]

示例

正常返回示例

JSON格式

{
  "TotalCount": 9,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "TenantMetrics": "\"Metrics\":[ {\"request_queue_rt\":0.0,\"TimeStamp\":\"2022-02-23T01:58:00Z\"}]"
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-01-17API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-01-17OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:FuzzyName
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)