DescribeDataCollction - OpenSearch - Alibaba Cloud Documentation Center

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

get

*DataCollection

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	my_app_group_name
dataCollectionIdentity	string	Yes	The ID of the data collection.	286

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	72FAD77B-83F9-F393-BA8E-5834E2427BF8
result	object	The data collection information.
created	integer	The time when the data collection was created.	1581065837
dataCollectionType	string	The type of the data collection. behavior: User behavior data. item_info: Item information. industry_specific: Industry-specific attributes.	BEHAVIOR
type	string	The type of the data collection client. server web app Only server is supported.	server
industryName	string	The name of the industry. general: General ecommerce: E-commerce	GENERAL
status	integer	The status. 0: The data collection is not enabled. 1: The data collection is being enabled. 2: The data collection is enabled. 3: The data collection failed to be enabled.	2
updated	integer	The time when the data collection was last updated.	1581065904
name	string	The name of the data collection.	os_function_test_v1
sundialId	string	The ID of the sundial.	1755
id	string	The ID of the data collection.	286

Examples

Success response

JSON format

{
  "requestId": "72FAD77B-83F9-F393-BA8E-5834E2427BF8",
  "result": {
    "created": 1581065837,
    "dataCollectionType": "BEHAVIOR",
    "type": "server",
    "industryName": "GENERAL",
    "status": 2,
    "updated": 1581065904,
    "name": "os_function_test_v1",
    "sundialId": "1755",
    "id": "286"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.