CreateAppGroup - OpenSearch - Alibaba Cloud Documentation Center

Creates an OpenSearch application.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:CreateAppGroup

create

*AppGroup

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

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
name	string	No	The name of the application.	jmbon_analyzer
chargeType	string	No	The billing method. Valid values: POSTPAY: pay-as-you-go PREPAY: subscription	POSTPAY
type	string	No	The application type. Valid values: standard: Standard Edition enhanced: Premium Edition	enhanced
resourceGroupId	string	No	The ID of the resource group to which the instance belongs.	rg-acfm2ij6pwxsvua
tags	array<object>	No	The tags.
	object	No	The tag object.
key	string	No	The tag key.	a
value	string	No	The tag value.	1
quota	object	No	The quota.
docSize	integer	No	The storage capacity. Unit: GB.	1
computeResource	integer	No	The computing resources. Unit: logical computing unit (LCU).	20
spec	string	No	The specifications. Valid values: opensearch.share.junior: basic opensearch.share.common: shared general-purpose opensearch.share.compute: shared compute-optimized opensearch.share.storage: shared storage-optimized opensearch.private.common: exclusive general-purpose opensearch.private.compute: exclusive compute-optimized opensearch.private.storage: exclusive storage-optimized	opensearch.share.common

Request body

Parameter	Type	Required	Example	Description
name	String	Yes	"my_app"	The name of the application.
type	String	Yes	"standard"	The application type. Valid values: standard: Standard Edition enhanced: Premium Edition
quota	Object	Yes		The quota information for the application. For more information, see Quota
chargeType	String	No	"POSTPAY"	The billing method. Valid values: POSTPAY: pay-as-you-go (default) PREPAY: subscription
order	Object	No	{"duration": 1,"pricingCycle": "Year"}	The subscription details.
order.duration	Integer	--	1	The subscription duration. The minimum value is 0.
order.pricingCycle	String	--	"Year"	The unit of the subscription duration. Valid values: Year Month
order.autoRenew	Boolean	No	true	Specifies whether to enable auto-renewal. This parameter is valid only when the chargeType parameter is set to PREPAY. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled. (Default)

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	The request ID.	766CF6DB-CA02-3E12-7CBA-6AC21FC978FD
result	object	This parameter is left empty.
created	integer	The timestamp when the application was created.	1590139542
currentVersion	string	The ID of the current online version.	100302903
lockMode	string	The lock state. Valid values: Unlock: The instance is unlocked. LockByExpiration: The instance is automatically locked after it expires. ManualLock: The instance is manually locked.	Unlock
updated	integer	The timestamp when the application was last modified.	1590978265
id	string	The application ID.	100302881
chargeType	string	The billing method. Valid values: POSTPAY: pay-as-you-go PREPAY: subscription	POSTPAY
hasPendingQuotaReviewTask	integer	The approval status of the quota. Valid values: 0: The application is running as normal. 1: The quota change is under review.	0
name	string	The name of the application.	lsh_test_1
instanceId	string	The instance ID.	-
chargingWay	integer	The billing type. Valid values: 1: computing resources 2: queries per second (QPS)	1
type	string	The application type. Valid values: standard: Standard Edition advance: an old version of Premium Edition. You cannot create new applications of this type. enhanced: a new version of Premium Edition	enhanced
status	string	The application status. Valid values: producing: The application is being created. review_pending: The application is under review. config_pending: The application is pending configuration. normal: The application is running as normal. frozen: The application is frozen.	normal
projectId	string	The name of the A/B test project.	-
switchedTime	integer	The timestamp when the current online version was published.	1590486386
commodityCode	string	The commodity code.	opensearch
expireOn	string	The expiration time.	-
domain	string	The industry type. Valid values: GENERAL ECOMMERCE IT_CONTENT	GENERAL
description	string	The description of the application.	-
produced	integer	Indicates whether the application is created. Valid values: 0: The application is being created. 1: The application is created.	1
quota	object	The quota information for the application.
spec	string	The specifications. Valid values: opensearch.share.junior: basic opensearch.share.common: shared general-purpose opensearch.share.compute: shared compute-optimized opensearch.share.storage: shared storage-optimized opensearch.private.common: exclusive general-purpose opensearch.private.compute: exclusive compute-optimized opensearch.private.storage: exclusive storage-optimized	opensearch.share.common
docSize	integer	The storage capacity. Unit: GB.	1
computeResource	integer	The computing resources. Unit: LCU.	20
engineType	string	The engine type.	ha3

Examples

Success response

JSON format

{
  "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"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.