ModifyAppGroup API修改应用属性或设置在线版本-智能开放搜索 OpenSearch-阿里云

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

opensearch:ModifyAppGroup

update

*AppGroup

acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
appGroupIdentity	string	是	应用名称。	my_app_group_name

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求参数。
description	string	否	描述	"实例描述"
currentVersion	string	否	在线版本。	1223232
domain	string	否	行业类型： general：通用行业。 ecommerce：电商行业。 education：教育行业。 esports：游戏行业。 community：内容社区。	"ecommerce"
resourceGroupId	string	否	实例所属的资源组 ID。	rg-****
dryRun	boolean	否	是否进行升级前校验。true 表示校验，false 表示不校验。	true

请求体

字段	类型	是否必要	示例值	描述
chargingWay	Integer	否	1	计费模型 - 1 计算资源 - 2 qps
description	String	否	"my_first_app"	应用描述
currentVersion	Integer	否	12345678	应用版本 ID

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

返回参数

名称	类型	描述	示例值
	object	响应体	{}
requestId	string	请求 ID	D77D0DAF-790D-F5F5-A9C0-133738165014
result	object	返回数据	{}
created	integer	创建时间戳	159013954
currentVersion	string	当前在线版本	100302903
lockMode	string	锁定状态 Unlock 正常 LockByExpiration 实例过期自动锁定 ManualLock 手动触发锁定	Unlock
updated	integer	更新时间戳	1590978265
id	string	应用 ID	100302881
chargeType	string	付费类型 POSTPAY 后付费（按量付费） PREPAY 预付费（包年包月）	POSTPAY
hasPendingQuotaReviewTask	integer	是否配额审批中 0：正常 1：配额审批中	0
name	string	应用名称	lsh_test_1
instanceId	string	实例 ID	10030288
chargingWay	integer	计费类型 1：计算资源 2：qps	1
type	string	应用类型 standard 标准版 advance 老高级版（新应用不支持此类型） enhanced 新高级版	enhanced
status	string	应用状态 producing 生产中 review_pending 生产审批中 config_pending 待配置 normal 正常 frozen 已冻结	normal
projectId	string	abtest project 名称	1
switchedTime	integer	在线版本切换时间戳	1590486386
commodityCode	string	商品 CODE	opensearch
expireOn	string	过期时间	1
domain	string	行业类型 GENERAL 通用 ECOMMERCE 电商 IT_CONTENT IT 内容	GENERAL
description	string	应用描述	1
produced	integer	是否生产完成 0：生产中 1：生产完成	1
quota	object	应用配额信息	{}
spec	string	规格 opensearch.share.junior 入门型 opensearch.share.common 共享通用型 opensearch.share.compute 共享计算型 opensearch.share.storage 共享存储型 opensearch.private.common 独享通用型 opensearch.private.compute 独享计算型 opensearch.private.storage 独享存储型	opensearch.share.common
docSize	integer	存储容量（单位：GB）	1
computeResource	integer	计算资源（单位：LCU）	20
engineType	string	引擎类型	ha3
resourceGroupId	string	实例所属的资源组 ID。	rg-acfmoiyerh6nzly

示例

正常返回示例

JSON格式

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 159013954,
    "currentVersion": "100302903",
    "lockMode": "Unlock",
    "updated": 1590978265,
    "id": "100302881",
    "chargeType": "POSTPAY",
    "hasPendingQuotaReviewTask": 0,
    "name": "lsh_test_1",
    "instanceId": "10030288",
    "chargingWay": 1,
    "type": "enhanced",
    "status": "normal",
    "projectId": "1",
    "switchedTime": 1590486386,
    "commodityCode": "opensearch",
    "expireOn": "1",
    "domain": "GENERAL",
    "description": "1",
    "produced": 1,
    "quota": {
      "spec": "opensearch.share.common",
      "docSize": 1,
      "computeResource": 20
    },
    "engineType": "ha3",
    "resourceGroupId": "rg-acfmoiyerh6nzly"
  }
}

错误码

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

变更历史

更多信息，参考变更详情。