修改 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 入參發生變更 | 查看變更詳情 |