ListAppGroups - OpenSearch - Alibaba Cloud Documentation Center

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

Request syntax

GET /v4/openapi/app-groups

Request parameters

Parameter	Type	Required	Description	Example
pageNumber	integer	No	Number or other number indicating order on each 1 page.	1
pageSize	integer	No	Number of returns per page.	10
instanceId	string	No	Instance ID	ops-cn-xxxx
name	string	No	Application Name	my_name
type	string	No	Application Type	standard
sortBy	integer	No	Arrange order 0:Descending order by creation time 1:Descending order by modification time	0
resourceGroupId	string	No	Resource id	"110123123"
tags	object []	No	The tag dictionary.
key	string	No	The key of the tag.	foo
value	string	No	The value of the tag.	bar

Response parameters

Parameter	Type	Description	Example
	object
totalCount	integer	The total number of entries returned.	1
requestId	string	The ID of the request.	0A6EB64B-B4C8-CF02-810F-E660812972FF
result	object []	The information about each application. For more information, see AppGroup .	[]
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 mode of the instance. 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 when the application was last updated.	1578916076
id	string	The ID of the application.	110116134
chargeType	string	The billing method of the application. Valid values: POSTPAY: pay-as-you-go PREPAY: subscription	POSTPAY
hasPendingQuotaReviewTask	integer	The approval status of the quotas. Valid values: 0: The quotas are approved. 1: The quotas are being approved.	0
secondRankAlgoDeploymentId	integer	The ID of the created fine sort expression.	0
name	string	The name of the application.	os_function_test_v1
instanceId	string	The ID of the instance.	"xxx"
processingOrderId	string	The ID of the order that is not complete for the instance. For example, an order is one that is initiated to create the instance or change the quotas or billing method.	"xxx"
chargingWay	integer	The billing model. Valid values: 1: computing resources 2: queries per second (QPS)	1
type	string	The type of the application. Valid values: standard: a standard application. advance: an advanced application which is of an old application type. New applications cannot be of this type. enhanced: an advanced application which is of a new application type.	enhanced
status	string	The status of the application. Valid values: producing review_pending config_pending normal 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 code of the commodity.	opensearch
expireOn	string	The expiration time.	"xxx"
domain	string	domain	""
description	string	The description of the application.	"xxx"
firstRankAlgoDeploymentId	integer	The ID of the created rough sort expression.	0
produced	integer	Indicates whether the order is complete. Valid values: 0: The order is in progress. 1: The order is complete.	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 of the application. 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 units (LCUs).	20
tags	object []	The tag dictionary.
key	string	The key of the tag.	foo
value	string	The value of the tag.	bar

Examples

Sample success responses

JSONformat

{
  "totalCount": 1,
  "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": "\"xxx\"",
      "processingOrderId": "\"xxx\"",
      "chargingWay": 1,
      "type": "enhanced",
      "status": "normal",
      "projectId": "\"xxx\"",
      "switchedTime": 0,
      "commodityCode": "opensearch",
      "expireOn": "\"xxx\"",
      "domain": "\"\"",
      "description": "\"xxx\"",
      "firstRankAlgoDeploymentId": 0,
      "produced": 1,
      "lockedByExpiration": 0,
      "quota": {
        "spec": "opensearch.share.common",
        "docSize": 1,
        "computeResource": 20
      },
      "tags": [
        {
          "key": "foo",
          "value": "bar"
        }
      ]
    }
  ]
}

Error codes

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