ListDataCollections - OpenSearch - Alibaba Cloud Documentation Center

Queries the data collection tasks 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:ListDataCollections	get	DataCollection acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	my_app_group_name
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries per page. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
totalCount	integer	The total number of entries returned.	1
requestId	string	The request ID.	959D8782-B130-95EB-86CC-1F6ED447981F
result	array<object>	The details of the data collection task. For more information, see DataCollection .
result	object
created	integer	The time when the task was created.	1581065837
dataCollectionType	string	The type of data collected. Valid values: behavior: behavioral data. item_info: project information. industry_specific: industry-specific data.	BEHAVIOR
type	string	The type of the source from which data was collected. Valid values: server web app Only server is supported.	server
industryName	string	The industry name. Valid values: general ecommerce	GENERAL
status	integer	The status of the data collection feature. Valid values: 0: The feature is disabled. 1: The feature is being enabled. 2: The feature is enabled. 3: The feature failed to be enabled.	2
updated	integer	The time when the data collection task was updated.	1581065904
name	string	The name of the data collection task.	os_function_test_v1
sundialId	string	The sundial ID.	1755
id	string	The data collection ID.	286

Examples

Sample success responses

JSONformat

{
  "totalCount": 1,
  "requestId": "959D8782-B130-95EB-86CC-1F6ED447981F",
  "result": [
    {
      "created": 1581065837,
      "dataCollectionType": "BEHAVIOR",
      "type": "server",
      "industryName": "GENERAL",
      "status": 2,
      "updated": 1581065904,
      "name": "os_function_test_v1",
      "sundialId": "1755",
      "id": "286"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history