ModifyAppGroupQuota - OpenSearch - Alibaba Cloud Documentation Center

Modifies the quotas of an OpenSearch application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application	my_app_group_name
dryRun	boolean	No	Specifies whether to check the validity of input parameters. Default value: false. Valid values: true: checks only the validity of input parameters. false: checks the validity of input parameters and creates an attribution configuration.	false
body	Quota	No	The request body.

Request body

Parameter	Type	Required	Example	Description
docSize	Integer	Yes	1	The storage capacity (Unit: GB). Shared general-purpose (1 to 300 GB).
computeResource	Integer	Yes	20	The computing resources (unit: LCUs). Shared general-purpose (20 to 5000 LCUs).
spec	String	Yes	"opensearch.share.common"	The specifications.
orderType	String	No	"UPGRADE"	The type of specification change. Valid values:UPGRADE: specification upgradeDOWNGRADE: specification downgrade

For more information, see Quota .

Response parameters

Parameter	Type	Description	Example
	object	The rsponse body.
requestId	string	The request ID.	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 ID of the current online version.	100302903
type	string	The type of the application. Valid values: standard: a standard edition application. advance: an advanced edition application of an old version. New versions are not supported for this edition. enhanced: an advanced edition application of a new version.	enhanced
chargingWay	integer	The billable item. Valid values: 1: computing resources. 2: queries per second (QPS).	1
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
status	string	The state of the application. Valid values: producing: The application is being created. review_pending: The application is being reviewed. config_pending: The application is to be configured. normal: The application is in service. frozen: The application is frozen.	normal
updated	integer	The timestamp when the application was last modified.	1590978265
chargeType	string	The billing method. Valid values: POSTPAY: pay-as-you-go. PREPAY: subscription.	POSTPAY
id	string	The application ID.	100302881
hasPendingQuotaReviewTask	integer	The approval state of the quotas. Valid values: 0: The application is in service. 1: The quotas are being reviewed.	0
projectId	string	The name of the A/B test group.	1000
commodityCode	string	The commodity code.	opensearch
switchedTime	integer	The timestamp when the current online version was published.	1590486386
expireOn	string	The time when the application expired.	1
description	string	The description of the application.	1
produced	integer	Indicates whether the application is created. Valid values: 0: The application is being created. 1: The application is created.	1
name	string	The name of the application	lsh_test_1
instanceId	string	The instance ID.	1
quota	object	The information about the quotas of the application.
spec	string	The specifications. Valid values: opensearch.share.junior: basic. opensearch.share.common: shared general-purpose. opensearch.share.compute: shared computing. opensearch.share.storage: shared storage. opensearch.private.common: exclusive general-purpose. opensearch.private.compute: exclusive computing. opensearch.private.storage: exclusive storage.	opensearch.share.common
docSize	integer	The storage capacity. Unit: GB.	1
computeResource	integer	The computing resources. Unit: logical computing unit (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

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-07	The response structure of the API has changed	View Change Details
2023-05-24	The request parameters of the API has changed	View Change Details