Use DescribeAppGroup to query application details - OpenSearch

Query 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:DescribeAppGroup

get

*AppGroup

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

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	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.
	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.