Queries the data collection tasks of an OpenSearch application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/app-groups/[appGroupIdentity]/data-collections HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app_group_name

The name of the application.

pageNumber Integer Query No 1

The number of the page to return. Default value: 1.

pageSize Integer Query No 10

The number of items to return on each page. Default value: 10.

Response parameters

Parameter Type Example Description
requestId String 959D8782-B130-95EB-86CC-1F6ED447981F

The ID of the request.

result Array of result

The details of the data collection tasks.

For more information, see DataCollection.

created Integer 1581065837

The time when the data collection task was created.

dataCollectionType String BEHAVIOR

The type of the data that is collected by the task. Valid values:

  • behavior: behavioral data
  • item_info: project data
  • industry_specific: industry-specific data
id String 286

The ID of the data collection task.

industryName String GENERAL

The industry to which the data collection task applies. Valid values:

  • general
  • ecommerce
name String os_function_test_v1

The name of the data collection task.

status Integer 2

The status of the data collection task. Valid values:

  • 0: disabled
  • 1: being enabled
  • 2: enabled
  • 3: failed to be enabled
sundialId String 1755

The ID of the sundial.

type String server

The type of the data source. Valid values:

  • server
  • web
  • app

Note: Only server is supported.

updated Integer 1581065904

The time when the data collection task was updated.

totalCount Integer 1

The total number of the returned data collection tasks.

Examples

Sample requests

GET /v4/openapi/app-groups/os_function_test_v1/data-collections

Sample success responses

XML format

<requestId>959D8782-B130-95EB-86CC-1F6ED447981F</requestId>
<totalCount>1</totalCount>
<result>
    <id>286</id>
    <name>os_function_test_v1</name>
    <type>server</type>
    <status>2</status>
    <dataCollectionType>BEHAVIOR</dataCollectionType>
    <industryName>GENERAL</industryName>
    <created>1581065837</created>
    <updated>1581065904</updated>
    <sundialId>1755</sundialId>
</result>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.