文档

ModifyAppGroupQuota - 修改应用配额

更新时间:

修改 OpenSearch 应用配额。

调试

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

授权信息

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

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

请求语法

PUT /v4/openapi/app-groups/{appGroupIdentity}/quota

请求参数

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

应用名称

my_app_group_name
dryRunboolean

是否校验入参数据合法性,默认 false。

取值:

  • true:只校验参数合法性。

  • false:校验参数合法性,创建归因配置。

false
bodyQuota

请求体。

请求体

字段类型是否必要示例值描述
docSizeInteger1存储容量(单位:GB) 共享通用型(1~300G)
computeResourceInteger20计算资源(单位:LCU) 共享通用型(20~5000LCU)
specString"opensearch.share.common"规格
orderTypeString"UPGRADE"变配类型
- UPGRADE  升配
- DOWNGRADE  降配

参考: Quota

返回参数

名称类型描述示例值
object

响应体

requestIdstring

请求 ID

0A6EB64B-B4C8-CF02-810F-E660812972FF
resultobject

应用信息

createdinteger

创建时间戳

1590139542
currentVersionstring

当前在线版本

100302903
pendingSecondRankAlgoDeploymentIdinteger

部署中的精排部署 ID

0
typestring

应用类型

  • standard 标准版
  • advance 老高级版(新应用不支持此类型)
  • enhanced 新高级版
enhanced
chargingWayinteger

计费类型

  • 1:计算资源
  • 2:qps
1
lockModestring

锁定状态

  • Unlock 正常
  • LockByExpiration 实例过期自动锁定
  • ManualLock 手动触发锁定
Unlock
statusstring

应用状态

  • producing 生产中
  • review_pending 生产审批中
  • config_pending 待配置
  • normal 正常
  • frozen 已冻结
normal
updatedinteger

更新时间戳

1590978265
chargeTypestring

付费类型

  • POSTPAY 后付费(按量付费)
  • PREPAY 预付费(包年包月)
POSTPAY
idstring

应用 ID

100302881
hasPendingQuotaReviewTaskinteger

是否配额审批中

  • 0:正常
  • 1:配额审批中
0
projectIdstring

abtest project 名称

1000
secondRankAlgoDeploymentIdinteger

精排部署 ID

0
commodityCodestring

商品 CODE

opensearch
switchedTimeinteger

在线版本切换时间戳

1590486386
expireOnstring

过期时间

1
descriptionstring

应用描述

1
firstRankAlgoDeploymentIdinteger

粗排部署 ID

0
lockedByExpirationinteger

实例过期自动锁定

0
producedinteger

是否生产完成

  • 0:生产中
  • 1:生产完成
1
namestring

应用名称

lsh_test_1
processingOrderIdstring

未结束订单号

1
instanceIdstring

实例 ID

1
quotaobject

应用配额信息

specstring

规格

  • opensearch.share.junior 入门型
  • opensearch.share.common 共享通用型
  • opensearch.share.compute 共享计算型
  • opensearch.share.storage 共享存储型
  • opensearch.private.common 独享通用型
  • opensearch.private.compute 独享计算型
  • opensearch.private.storage 独享存储型
opensearch.share.common
docSizeinteger

存储容量(单位:GB)

1
computeResourceinteger

计算资源(单位:LCU)

20

示例

正常返回示例

JSON格式

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "created": 1590139542,
    "currentVersion": "100302903",
    "pendingSecondRankAlgoDeploymentId": 0,
    "type": "enhanced",
    "chargingWay": 1,
    "lockMode": "Unlock",
    "status": "normal",
    "updated": 1590978265,
    "chargeType": "POSTPAY",
    "id": "100302881",
    "hasPendingQuotaReviewTask": 0,
    "projectId": "1000",
    "secondRankAlgoDeploymentId": 0,
    "commodityCode": "opensearch",
    "switchedTime": 1590486386,
    "expireOn": " 1",
    "description": " 1",
    "firstRankAlgoDeploymentId": 0,
    "lockedByExpiration": 0,
    "produced": 1,
    "name": "lsh_test_1",
    "processingOrderId": "1",
    "instanceId": "1",
    "quota": {
      "spec": "opensearch.share.common",
      "docSize": 1,
      "computeResource": 20
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-24OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:dryRun
    新增入参:body