CreateAppGroup - 创建一个应用 - 智能开放搜索 OpenSearch

创建一个OpenSearch应用。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
opensearch:CreateAppGroup	create	AppGroup acs:opensearch:{#regionId}:{#accountId}:app-groups/*	无	无

请求语法

POST /v4/openapi/app-groups HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求体
name	string	否	应用名称	jmbon_analyzer
chargeType	string	否	付费类型 POSTPAY 后付费（按量付费） PREPAY 预付费（包年包月	POSTPAY
type	string	否	应用类型 standard 标准版 enhanced 高级版	enhanced
resourceGroupId	string	否	实例所属的资源组 ID。	rg-acfm2ij6pwxsvua
tags	array<object>	否	标签列表
	object	否	标签键值
key	string	否	标签 key	a
value	string	否	标签 value	1
quota	object	否	配额
docSize	integer	否	存储容量（单位：GB）	1
computeResource	integer	否	计算资源（单位：LCU）	20
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

请求体

字段	类型	是否必要	示例值	描述
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（默认）：不自动续费。

返回参数

名称	类型	描述	示例值
	object	响应体
requestId	string	请求 ID	766CF6DB-CA02-3E12-7CBA-6AC21FC978FD
result	object	空
created	integer	创建时间戳	1590139542
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	-
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 名称	-
switchedTime	integer	在线版本切换时间戳	1590486386
commodityCode	string	商品 CODE	opensearch
expireOn	string	过期时间	-
domain	string	行业类型 GENERAL 通用 ECOMMERCE 电商 IT_CONTENT IT 内容	GENERAL
description	string	应用描述	-
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

示例

正常返回示例

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 入参发生变更	查看变更详情