查询指定 OceanBase 租户指标信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| oceanbase:DescribeTenantMetrics | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | OceanBase 集群 ID。 | ob317v4uif**** |
| PageSize | integer | 否 | 分页查询时设置的每页行数。
| 10 |
| PageNumber | integer | 否 | 分页查询的页码。
| 1 |
TenantNamedeprecated | string | 否 | 租户名称。 长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。 说明
该参数后期会废弃，建议使用 TenantIdList。 | pay_online |
| StartTime | string | 是 | 监控数据的起始时间。 | 2021-06-13T15:40:43Z |
| EndTime | string | 是 | 监控数据的结束时间。 | 2021-06-13T15:45:43Z |
| Metrics | string | 是 | 监控指标项。 | tps |
TenantIddeprecated | string | 否 | 租户 ID。 说明
该参数后期会废弃，建议使用 TenantIdList。 | tfafd34fs**** |
| TenantIdList | string | 否 | 租户 ID 列表。 | [tdak3nac****,tdakc42df****] |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 9,
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"TenantMetrics": "\"Metrics\":[ {\"request_queue_rt\":0.0,\"TimeStamp\":\"2022-02-23T01:58:00Z\"}]"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-16 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2024-08-15 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-01-17 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2022-01-17 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |