首页 智能开放搜索 OpenSearch 管控API合集 行业算法版&高性能检索版 API目录 应用实例 应用管理 ModifyAppGroup - 修改应用属性或设置应用在线版本

ModifyAppGroup - 修改应用属性或设置应用在线版本

修改 OpenSearch 应用属性或设置应用在线版本。

调试

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

调试

授权信息

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

请求语法

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

请求参数

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

应用名称

my_app_group_name
bodyobject否

请求体

字段类型是否必要示例值描述
chargingWayInteger否1计费模型
- 1  计算资源
- 2  qps
descriptionString否"my_first_app"应用描述
currentVersionInteger否12345678应用版本ID

注：优先执行“设置应用在线版本”，即若所有字段都存在，则默认currentVersion有效。

返回参数

名称类型描述示例值
object

响应体

requestIdstring

请求ID

D77D0DAF-790D-F5F5-A9C0-133738165014
resultobject

返回数据

createdinteger

创建时间戳

159013954
currentVersionstring

当前在线版本

100302903
pendingSecondRankAlgoDeploymentIdinteger

部署中的精排部署ID

0
lockModestring

锁定状态

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

更新时间戳

1590978265
idstring

应用ID

100302881
chargeTypestring

付费类型

  • POSTPAY 后付费（按量付费）
  • PREPAY 预付费（包年包月）
POSTPAY
hasPendingQuotaReviewTaskinteger

是否配额审批中

  • 0：正常
  • 1：配额审批中
0
secondRankAlgoDeploymentIdinteger

精排部署ID

0
namestring

应用名称

lsh_test_1
instanceIdstring

实例ID

10030288
processingOrderIdstring

未结束订单号

1000345
chargingWayinteger

计费类型

  • 1：计算资源
  • 2：qps
1
typestring

应用类型

  • standard 标准版
  • advance 老高级版（新应用不支持此类型）
  • enhanced 新高级版
enhanced
statusstring

应用状态

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

abtest project 名称

1
switchedTimeinteger

在线版本切换时间戳

1590486386
commodityCodestring

商品CODE

opensearch
expireOnstring

过期时间

1
domainstring

行业类型

  • GENERAL 通用
  • ECOMMERCE 电商
  • IT_CONTENT IT内容
GENERAL
descriptionstring

应用描述

1
firstRankAlgoDeploymentIdinteger

粗排部署ID

0
producedinteger

是否生产完成

  • 0：生产中
  • 1：生产完成
1
lockedByExpirationinteger

实例是否过期自动锁定

  • 0：否
  • 1：是
0
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": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 159013954,
    "currentVersion": "100302903",
    "pendingSecondRankAlgoDeploymentId": 0,
    "lockMode": "Unlock",
    "updated": 1590978265,
    "id": "100302881",
    "chargeType": "POSTPAY",
    "hasPendingQuotaReviewTask": 0,
    "secondRankAlgoDeploymentId": 0,
    "name": "lsh_test_1",
    "instanceId": "10030288",
    "processingOrderId": "1000345",
    "chargingWay": 1,
    "type": "enhanced",
    "status": "normal",
    "projectId": "1",
    "switchedTime": 1590486386,
    "commodityCode": "opensearch",
    "expireOn": "1",
    "domain": "GENERAL",
    "description": "1",
    "firstRankAlgoDeploymentId": 0,
    "produced": 1,
    "lockedByExpiration": 0,
    "quota": {
      "spec": "opensearch.share.common",
      "docSize": 1,
      "computeResource": 20
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-24OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参：body
    新增入参：dryRun
阿里云首页 智能开放搜索 OpenSearch 相关技术圈