ListAppGroups - OpenSearch - Alibaba Cloud Documentation Center

Queries a list of OpenSearch applications.

Operation description

This operation allows you to query applications by application name, instance ID, and application type.
This operation allows you to sort the applications based on their creation time.
This operation supports the parameters for paging.

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:ListAppGroup	list	AppGroup acs:opensearch:{#regionId}:{#accountId}:app-groups/*	none	none

Request syntax

GET /v4/openapi/app-groups HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries per page. Default value: 10.	10
instanceId	string	No	The ID of the instance. Exact match is used.	ops-cn-xxxx
name	string	No	The name of the application.	my_name
type	string	No	The type of the application. Valid values: standard: a High-performance Search Edition application. enhanced: an Industry Algorithm Edition application.	standard
sortBy	integer	No	The method based on which applications are sorted. Valid values: 0: sorts applications in descending order by creation time. 1: sorts applications in descending order by modification time. Default value: 0.	0
resourceGroupId	string	No	The ID of the resource group.	"110123123"
tags	array<object>	No	The tags.
	object	No	The tag dictionary.
key	string	No	The tag key.	foo
value	string	No	The tag value.	bar

Response parameters

Parameter	Type	Description	Example
	object	The response body.
totalCount	integer	The total number of entries returned.	1
requestId	string	The request ID.	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	array<object>	The information about the application. For more information, see AppGroup .	[]
result	object	The result body.
created	integer	The timestamp when the application was created.	1575442875
currentVersion	string	The ID of the current online version.	110116134
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
name	string	The application name.	os_function_test_v1
instanceId	string	The instance ID.	"xxx"
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.	"xxx"
switchedTime	integer	The timestamp when the current online version was published.	0
commodityCode	string	The commodity code.	opensearch
expireOn	string	The time when the application expired.	"xxx"
domain	string	The industry of the application.	""
description	string	The description of the application.	"xxx"
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. For more information, see Quota .
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	The tag dictionary.
key	string	The tag key.	foo
value	string	The tag value.	bar
engineType	string	The engine type.	ha3

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-07-16	The response structure of the API has changed	View Change Details