GetAppQuota - 查看应用配额

调用GetAppQuota接口,获取Elasticsearch Serverless应用的配额信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
es-serverless:GetAppQuota
  • 全部资源
    *

请求语法

GET /openapi/es-serverless/instances/{appName}/quota

请求参数

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

应用名称。调用 ListApps 获取应用名称。

test

返回参数

名称类型描述示例值
object

响应体结构。

requestIdstring

请求 ID。

2C5DAA30-****-5181-9B87-9D6181016197
resultobject

返回结果。

quotaInfoobject

配额信息。

limiterInfoobject

系统限制信息。

limitersarray<object>

限制列表。

object
typestring

系统限制类型。

INDEX_NUMBER_OF_SHARDS
immutableboolean

是否为不可变的限制。暂时不支持修改系统限制。

true
minValuelong

最小阈值。

1
maxValuelong

最大阈值。

10

示例

正常返回示例

JSON格式

{
  "requestId": "2C5DAA30-****-5181-9B87-9D6181016197",
  "result": {
    "quotaInfo": {
      "test": "test",
      "test2": 1
    },
    "limiterInfo": {
      "limiters": [
        {
          "type": "INDEX_NUMBER_OF_SHARDS",
          "immutable": true,
          "minValue": 1,
          "maxValue": 10
        }
      ]
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史