All Products
Search

This Product

    OpenSearch:ModifyAppGroupQuota

    Document Center

    OpenSearch:ModifyAppGroupQuota

    Last Updated:Dec 22, 2025

    Modifies the quota of 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:ModifyAppGroup

    update

    *AppGroup

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

    		 None None

    Request syntax

    PUT /v4/openapi/app-groups/{appGroupIdentity}/quota HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    appGroupIdentity

    string

    Yes

    The name of the application.

    my_app_group_name

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    clientToken

    string

    No

    A client token that is used to ensure the idempotence of the request. The client generates this value to make sure that it is unique among different requests. The value can be up to 64 ASCII characters in length.

    74db41d8cd3c784209093aa76afbe89e
    dryRun

    boolean

    No

    Specifies whether to perform a dry run. Default value: false.

    Valid values:

    • true: Validates the request parameters without creating the attribution configuration.

    • false: Validates the request parameters and creates the attribution configuration.

    false
    body

    Quota

    No

    The request body.

    Request body

    FieldTypeRequiredExampleDescription
    docSizeIntegerYes1The storage capacity in GB. For shared general-purpose instances, the value ranges from 1 to 300.
    computeResourceIntegerYes20The compute resources in LCU. For shared general-purpose instances, the value ranges from 20 to 5,000.
    specStringYes"opensearch.share.common"The specifications.
    orderTypeStringNo"UPGRADE"The type of the configuration change.
    - UPGRADE: upgrades the specifications.
    - DOWNGRADE: downgrades the specifications.


    For more information, see Quota.

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    requestId

    string

    The ID of the request.

    0A6EB64B-B4C8-CF02-810F-E660812972FF
    result

    object

    The information about the application.

    created

    integer

    The timestamp when the application was created.

    1590139542
    currentVersion

    string

    The current online version.

    100302903
    type

    string

    The type of the application.

    • standard: Standard Edition

    • advance: an earlier version of Premium Edition. This type is not supported for new applications.

    • enhanced: a new version of Premium Edition.

    enhanced
    chargingWay

    integer

    The billing model.

    • 1: by compute resources

    • 2: by queries per second (QPS)

    1
    lockMode

    string

    The lock status.

    • Unlock: The application is not locked.

    • LockByExpiration: The application is automatically locked upon expiration.

    • ManualLock: The application is manually locked.

    Unlock
    status

    string

    The status of the application.

    • producing: The application is being provisioned.

    • review_pending: The application is pending for review.

    • config_pending: The application is pending for configuration.

    • normal: The application is running as normal.

    • frozen: The application is frozen.

    normal
    updated

    integer

    The timestamp when the application was last updated.

    1590978265
    chargeType

    string

    The billing method.

    • POSTPAY: pay-as-you-go

    • PREPAY: subscription

    POSTPAY
    id

    string

    The ID of the application.

    100302881
    hasPendingQuotaReviewTask

    integer

    Indicates whether a quota is pending for approval.

    • 0: No quota is pending for approval.

    • 1: A quota is pending for approval.

    0
    projectId

    string

    The name of the A/B test project.

    1000
    commodityCode

    string

    The commodity code.

    opensearch
    switchedTime

    integer

    The timestamp when the online version was switched.

    1590486386
    expireOn

    string

    The expiration time.

    1
    description

    string

    The description of the application.

    1
    produced

    integer

    Indicates whether the application is provisioned.

    • 0: The application is being provisioned.

    • 1: The application is provisioned.

    1
    name

    string

    The name of the application.

    lsh_test_1
    instanceId

    string

    The ID of the instance.

    1
    quota

    object

    The quota information of the application.

    spec

    string

    The specifications.

    • opensearch.share.junior: 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
    docSize

    integer

    The storage capacity in GB.

    1
    computeResource

    integer

    The compute resources in LCU.

    20
    engineType

    string

    The engine type.

    Valid values:

    • ha3 :

      ha3

    ha3
    resourceGroupId

    string

    The ID of the resource group to which the instance belongs.

    rg-acfmoiyerh6nzly

    Examples

    Success response

    JSON format

    {
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "created": 1590139542,
    "currentVersion": "100302903",
    "type": "enhanced",
    "chargingWay": 1,
    "lockMode": "Unlock",
    "status": "normal",
    "updated": 1590978265,
    "chargeType": "POSTPAY",
    "id": "100302881",
    "hasPendingQuotaReviewTask": 0,
    "projectId": "1000",
    "commodityCode": "opensearch",
    "switchedTime": 1590486386,
    "expireOn": " 1",
    "description": " 1",
    "produced": 1,
    "name": "lsh_test_1",
    "instanceId": "1",
    "quota": {
      "spec": "opensearch.share.common",
      "docSize": 1,
      "computeResource": 20
    },
    "engineType": "ha3",
    "resourceGroupId": "rg-acfmoiyerh6nzly"
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.