All Products
Search
Document Center

OpenSearch:ModifyAppGroup

Last Updated:Oct 16, 2024

Modifies the properties of an OpenSearch application or sets the online version 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:ModifyAppGroupupdate
  • AppGroup
    acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The name of the application.

my_app_group_name
bodyobjectNo

The request parameters for the operation.

descriptionstringNo

The description of the application.

"test"
currentVersionstringNo

The online version of the application.

1223232
domainstringNo

The type of the industry. Valid values:

  • general: general.
  • ecommerce: e-commerce.
  • education: education.
  • esports: electronic sports.
  • community: content community.
"ecommerce"
resourceGroupIdstringNo

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

rg-****
dryRunbooleanNo

Specifies whether to verify the application before modification. Valid values: true and false.

true

Request body

ParameterTypeRequiredExampleDescription
chargingWayIntegerNo1The billing type. Valid values:1: computing resources.2: queries per second (QPS).
descriptionStringNo"my_first_app"The description of the application.
currentVersionIntegerNo12345678The ID of the application version.

Note: The currentVersion parameter takes effect if all fields are included in the request. In this case, this operation preferentially configures the online version of the application.

Response parameters

ParameterTypeDescriptionExample
object

The response body.

requestIdstring

The request ID.

D77D0DAF-790D-F5F5-A9C0-133738165014
resultobject

Response parameters

createdinteger

The timestamp when the application was created.

1590139524
currentVersionstring

The ID of the current online version.

100302903
lockModestring

The lock status. Valid values:

  • Unlock: The instance is unlocked.
  • LockByExpiration: The instance is automatically locked after it expires.
  • ManualLock: The instance is manually locked.
Unlock
updatedinteger

The timestamp when the application was last modified.

1590978265
idstring

The application ID.

100302881
chargeTypestring

The billing method. Valid values:

  • POSTPAY: pay-as-you-go.
  • PREPAY: subscription.
POSTPAY
hasPendingQuotaReviewTaskinteger

The approval status of the quotas. Valid values:

  • 0: normal.
  • 1: being approved.
0
namestring

The name of the application.

lsh_test_1
instanceIdstring

The instance ID.

10030288
chargingWayinteger

The billable item. Valid values:

  • 1: computing resources.
  • 2: QPS.
1
typestring

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
statusstring

The state of the application. Valid values:

  • producing: being produced.
  • review_pending: being approved.
  • config_pending: to be configured.
  • normal: normal.
  • frozen: frozen.
normal
projectIdstring

The name of the A/B test group.

1
switchedTimeinteger

The timestamp when the current online version was published.

1590486386
commodityCodestring

The code of the commodity.

opensearch
expireOnstring

The time when the application expired.

1
domainstring

The type of the industry. Valid values:

  • GENERAL: general.
  • ECOMMERCE: e-commerce.
  • IT_CONTENT: IT content.
GENERAL
descriptionstring

The description of the application.

1
producedinteger

Indicates whether the order is complete. Valid values:

  • 0: The order is in progress.
  • 1: The order is complete.
1
quotaobject

The information about the quotas of the application.

specstring

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
docSizeinteger

The storage capacity. Unit: GB.

1
computeResourceinteger

The computing resources. Unit: logical computing unit (LCU).

20
engineTypestring

The engine type.

ha3
resourceGroupIdstring

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

rg-acfmoiyerh6nzly

Examples

Sample success responses

JSONformat

{
  "requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
  "result": {
    "created": 1590139524,
    "currentVersion": "100302903",
    "lockMode": "Unlock",
    "updated": 1590978265,
    "id": "100302881",
    "chargeType": "POSTPAY",
    "hasPendingQuotaReviewTask": 0,
    "name": "lsh_test_1",
    "instanceId": "10030288",
    "chargingWay": 1,
    "type": "enhanced",
    "status": "normal",
    "projectId": "1",
    "switchedTime": 1590486386,
    "commodityCode": "opensearch",
    "expireOn": "1",
    "domain": "GENERAL",
    "description": "1",
    "produced": 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 timeSummary of changesOperation
2024-08-07The response structure of the API has changedView Change Details
2023-05-24The request parameters of the API has changedView Change Details