ListAppGroups - OpenSearch - Alibaba Cloud Documentation Center

Queries a list of OpenSearch applications.

Operation description

Filters applications by name, instance ID, and type.
Sorts applications by their creation time.
Supports paging.

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:ListAppGroup

list

*AppGroup

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

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 to return on each page. Default value: 10.	10
instanceId	string	No	The ID of the instance. An exact match is performed.	ops-cn-xxxx
name	string	No	The application name.	my_name
type	string	No	The type of the application. Valid values: standard: a Standard Edition application. enhanced: a Premium Edition application.	standard
sortBy	integer	No	The sort order. Valid values: 0: Sorts applications by creation time in descending order. 1: Sorts applications by modification time in descending order. Default value: 0.	0
resourceGroupId	string	No	The ID of the resource group.	"110123123"
tags	array<object>	No	A list of tags.
	object	No
key	string	No	The tag key.	foo
value	string	No	The tag value.	bar

Response elements

Element	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 applications. For more information, see AppGroup.	[]
	array<object>	The results.	{}
created	integer	The timestamp that indicates when the application was created.	1575442875
currentVersion	string	The ID of the current online version.	110116134
lockMode	string	The lock status. Valid values: Unlock: The instance is not locked. LockByExpiration: The instance is automatically locked after it expires. ManualLock: The instance is manually locked.	Unlock
updated	integer	The timestamp that indicates 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 quota approval status. Valid values: 0: Normal 1: Pending approval	0
name	string	The application name.	os_function_test_v1
instanceId	string	The instance ID.	"xxx"
chargingWay	integer	The billing method. Valid values: 1: computing resources 2: queries per second (QPS)	1
type	string	The type of the application. Valid values: standard: a Standard Edition application. enhanced: a Premium Edition application.	enhanced
status	string	The status of the application. Valid values: producing: The application is being created. review_pending: The application is pending approval. config_pending: The application is pending configuration. normal: The application is running as normal. frozen: The application is frozen.	normal
projectId	string	The name of the A/B test project.	"xxx"
switchedTime	integer	The timestamp that indicates when the current online version was published.	0
commodityCode	string	The commodity code.	opensearch
expireOn	string	The time when the application expires.	"xxx"
domain	string	The domain of the application group.	""
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 quota information 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 Compute-optimized opensearch.share.storage: Shared Storage-optimized opensearch.private.common: Exclusive General-purpose opensearch.private.compute: Exclusive Compute-optimized opensearch.private.storage: Exclusive Storage-optimized	opensearch.share.common
docSize	integer	The storage capacity in GB.	1
computeResource	integer	The computing resources in logical compute units (LCUs).	20
tags	array<object>	The tags of the application.
	object	The tag.
key	string	The tag key.	foo
value	string	The tag value.	bar
engineType	string	The engine type.	ha3

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.