創建一個OpenSearch應用。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| opensearch:CreateAppGroup | create |
|
| 無 |
請求語法
POST /v4/openapi/app-groups HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 請求體 | |
| name | string | 否 | 應用名稱 | jmbon_analyzer |
| chargeType | string | 否 | 付費類型
| POSTPAY |
| type | string | 否 | 應用類型
| enhanced |
| resourceGroupId | string | 否 | 實例所屬的資源組 ID。 | rg-acfm2ij6pwxsvua |
| tags | array<object> | 否 | 標簽列表 | |
| object | 否 | 標簽鍵值 | ||
| key | string | 否 | 標簽 key | |
| value | string | 否 | 標簽 value | |
| quota | object | 否 | 配額 | |
| docSize | integer | 否 | 存儲容量（單位：GB） | 1 |
| computeResource | integer | 否 | 計算資源（單位：LCU） | 20 |
| spec | string | 否 | 規格
| opensearch.share.common |
請求體
| 字段 | 類型 | 是否必要 | 示例值 | 描述 |
|---|---|---|---|---|
| name | String | 是 | "my_app" | 應用名稱 |
| type | String | 是 | "standard" | 應用類型 - standard 標準版 - enhanced 高級版 |
| quota | Object | 是 | 應用配額信息 參考： Quota | |
| chargeType | String | 否 | "POSTPAY" | 付費類型 - POSTPAY 后付費（按量付費）（默認值） - PREPAY 預付費（包年包月） |
| order | Object | 否 | {"duration": 1,"pricingCycle": "Year"} | 訂購周期信息 |
| order.duration | Integer | -- | 1 | 訂購周期 最小值不小于 0 |
| order.pricingCycle | String | -- | "Year" | 訂購周期單位 - Year - Month |
| order.autoRenew | Boolean | 否 | true | 是否要自動續費。當參數 chargeType 取值 PREPAY 時才生效。取值范圍： - true：自動續費。 - false（默認）：不自動續費。 |
返回參數
示例
正常返回示例
JSON格式
{
"requestId": "766CF6DB-CA02-3E12-7CBA-6AC21FC978FD",
"result": {
"created": 1590139542,
"currentVersion": "100302903",
"lockMode": "Unlock",
"updated": 1590978265,
"id": "100302881",
"chargeType": "POSTPAY",
"hasPendingQuotaReviewTask": 0,
"name": "lsh_test_1",
"instanceId": "-",
"chargingWay": 1,
"type": "enhanced",
"status": "normal",
"projectId": "-",
"switchedTime": 1590486386,
"commodityCode": "opensearch",
"expireOn": "-",
"domain": "GENERAL",
"description": "-",
"produced": 1,
"quota": {
"spec": "opensearch.share.common",
"docSize": 1,
"computeResource": 20
},
"engineType": "ha3"
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-09-03 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2024-08-08 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2024-08-08 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2024-07-16 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-05-30 | OpenAPI 入參發生變更 | 查看變更詳情 |