All Products
Search

This Product

    OpenSearch:CreateAppGroup

    Document Center

    OpenSearch:CreateAppGroup

    Last Updated:Aug 07, 2026

    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 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 application name.

    jmbon_analyzer
    chargeType

    string

    No

    The billing type. 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 list of tags.

    object

    No

    The tag key-value pair.

    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 compute resource. Unit: LCU.

    20
    spec

    string

    No

    The specification. Valid values:

    • opensearch.share.junior: shared entry-level.

    • opensearch.share.common: shared general-purpose.

    • opensearch.share.compute: shared compute-optimized.

    • opensearch.share.storage: shared storage-optimized.

    • opensearch.private.common: dedicated general-purpose.

    • opensearch.private.compute: dedicated compute-optimized.

    • opensearch.private.storage: dedicated storage-optimized.

    opensearch.share.common
    order

    object

    No

    duration

    integer

    No

    pricingCycle

    string

    No

    autoRenew

    boolean

    No

    No

    Request body

    FieldTypeRequiredExampleDescription
    nameStringYes"my_app"The application name.
    typeStringYes"standard"The application type.
    - standard: Standard Edition.
    - enhanced: Premium Edition.






    quotaObjectYesThe application quota information.
    Reference: Quota

    chargeTypeStringNo"POSTPAY"The billing type.
    - POSTPAY: pay-as-you-go (default).
    - PREPAY: subscription.






    orderObjectNo{"duration": 1,"pricingCycle": "Year"}The subscription period information.
    order.durationInteger--1The subscription period.
    Minimum value: 0.

    order.pricingCycleString--"Year"The unit of the subscription period.
    - Year
    - Month






    order.autoRenewBooleanNotrueSpecifies whether to enable auto-renewal. This parameter takes effect only when chargeType is set to PREPAY. Valid values:
    - true: Auto-renewal is enabled.
    - false (default): Auto-renewal is disabled.






    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    requestId

    string

    The request ID.

    766CF6DB-CA02-3E12-7CBA-6AC21FC978FD
    result

    object

    The result.

    instanceId

    string

    The instance ID.

    -

    Examples

    Success response

    JSON format

    {
  "requestId": "766CF6DB-CA02-3E12-7CBA-6AC21FC978FD",
  "result": {
    "instanceId": "-"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.