获取 OpenSearch 应用版本的统计结果。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
opensearch:DescribeAppStatistics |
|
| 无 |
请求语法
GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/statistics HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
appGroupIdentity | string | 是 | 应用名称 | my_app_group_name |
appId | string | 是 | 版本号 | 110157886 |
返回参数
统计结果
字段 | 类型 | 描述 |
---|---|---|
result.pv | Integer | 请求量 |
result.docCount | Integer | 文档大小(单位:个) |
result.docLastUpdated | String | 文档最近更新时间戳 |
result.quota | Object | 配额统计结果 |
result.quota.instance | Object | 实例统计结果 |
result.quota.instance.used | Float | 已使用容量(单位:LCU) |
result.quota.instance.quota | Integer | 配额容量(单位:GB) |
result.quota.instance.outOfLimit | Boolean | 是否超出配额 |
result.quota.instance.tables | Object | 各数据表使用统计结果 键名为表名,值为使用容量 |
result.quota.qps | Object | QPS 统计结果 |
result.quota.qps.used | Float | 已使用次数 |
result.quota.qps.quota | Integer | 配额次数 |
result.quota.qps.outOfLimit | Boolean | 是否超出配额 |
result.quota.qps.tables | Array | -- |
result.quota.computeResource | Object | 计算资源统计结果 |
result.quota.computeResource.used | Float | 已使用计算资源(单位:LCU) |
result.quota.computeResource.quota | Integer | 配额计算资源(单位:GB) |
result.quota.computeResource.outOfLimit | Boolean | 是否超出配额 |
result.quota.computeResource.dailyPeak | Float | 最高峰值(单位:LCU) |
result.quota.spec | String | 规格类型: - opensearch.share.junior 入门型 - opensearch.share.common 共享通用型 - opensearch.share.compute 共享计算型 - opensearch.share.storage 共享存储型 - opensearch.private.common 独享通用型 - opensearch.private.compute 独享计算型 - opensearch.private.storage 独享存储型 |
result.quota.docCount | Object | 文档大小统计结果 键名为表名,值为使用容量(单位:个) |
result.quota.mainTable | String | 主表名称 |
示例
正常返回示例
JSON
格式
{
"result": {},
"requestId": "76FC45F1-4167-D3CD-6737-4F97BA503FA0"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史