DescribeAppGroup - OpenSearch - Alibaba Cloud Documentation Center

Queries the details 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:DescribeAppGroup	get	AppGroup acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	my_app_group_name

Response parameters

Parameter	Type	Description	Example
	object
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.	1575442875
currentVersion	string	The ID of the current online version.	110116134
pendingSecondRankAlgoDeploymentId	integer	The ID of the fine sort expression that is being created.	0
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 updated.	1578916076
id	string	The application ID.	110116134
chargeType	string	The billing method. Valid values: POSTPAY: pay-as-you-go. PREPAY: subscription.	POSTPAY
hasPendingQuotaReviewTask	integer	The approval state of the quotas. Valid values: 0: The application is in service. 1: The quotas are being reviewed.	0
secondRankAlgoDeploymentId	integer	The ID of the created fine sort expression.	0
name	string	The application name.	os_function_test_v1
instanceId	string	The instance ID.	-
processingOrderId	string	The ID of the order that is not complete.	-
chargingWay	integer	The billable item. Valid values: 1: computing resources. 2: queries per second (QPS).	1
type	string	The type of the application. Valid values: standard: a High-performance Search Edition application. enhanced: an Industry Algorithm Edition application.	enhanced
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
projectId	string	The name of the A/B test group.	-
switchedTime	integer	The timestamp when the current online version was published.	0
commodityCode	string	The commodity code.	opensearch
expireOn	string	The expiration time.	-
domain	string	The industry of the application.	ecommerce
description	string	The description of the application.	-
firstRankAlgoDeploymentId	integer	The ID of the created rough sort expression.	0
produced	integer	Indicates whether the application is created. Valid values: 0: The application is being created. 1: The application is created.	1
lockedByExpiration	integer	Indicates whether the instance is automatically locked after it expires.	0
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
tags	array<object>	The application tags.
tags	object
key	string	The tag key.	foo
value	string	The tag value	bar
resourceGroupId	string	The ID of the resource group to which the network instance belongs.	rg-acfmoiyerh6nzly
engineType	string	The engine type.	ha3

Examples

Sample success responses

JSONformat

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "created": 1575442875,
    "currentVersion": "110116134",
    "pendingSecondRankAlgoDeploymentId": 0,
    "lockMode": "Unlock",
    "updated": 1578916076,
    "id": "110116134",
    "chargeType": "POSTPAY",
    "hasPendingQuotaReviewTask": 0,
    "secondRankAlgoDeploymentId": 0,
    "name": "os_function_test_v1",
    "instanceId": "-",
    "processingOrderId": "-",
    "chargingWay": 1,
    "type": "enhanced",
    "status": "normal",
    "projectId": "-",
    "switchedTime": 0,
    "commodityCode": "opensearch",
    "expireOn": "-",
    "domain": "ecommerce",
    "description": "-",
    "firstRankAlgoDeploymentId": 0,
    "produced": 1,
    "lockedByExpiration": 0,
    "quota": {
      "spec": "opensearch.share.common",
      "docSize": 1,
      "computeResource": 20
    },
    "tags": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "resourceGroupId": "rg-acfmoiyerh6nzly",
    "engineType": "ha3"
  }
}

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