修改 OpenSearch 应用属性或设置应用在线版本。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| opensearch:ModifyAppGroup | update |
|
| 无 |
请求语法
PUT /v4/openapi/app-groups/{appGroupIdentity} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appGroupIdentity | string | 是 | 应用名称。 | my_app_group_name |
| body | object | 否 | 请求参数。 | |
| description | string | 否 | 描述 | "实例描述" |
| currentVersion | string | 否 | 在线版本。 | 1223232 |
| domain | string | 否 | 行业类型：
| "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 有效。
返回参数
示例
正常返回示例
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"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-07 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-24 | OpenAPI 入参发生变更 | 查看变更详情 |