DescribeDataCollction - OpenSearch - Centro de documentación de Alibaba Cloud

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

opensearch:DescribeDataCollection

get

*DataCollection

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

Ninguna

Sintaxis de la solicitud

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

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
appGroupIdentity	string	Sí	El nombre de la aplicación.	my_app_group_name
dataCollectionIdentity	string	Sí	El ID de la recopilación de datos.	286

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
requestId	string	El ID de la solicitud.	72FAD77B-83F9-F393-BA8E-5834E2427BF8
result	object	La información de la recopilación de datos.
created	integer	La hora en que se creó la recopilación de datos.	1581065837
dataCollectionType	string	El tipo de la recopilación de datos. behavior: Datos de comportamiento del usuario. item_info: Información del artículo. industry_specific: Atributos específicos de la industria.	BEHAVIOR
type	string	El tipo de cliente de recopilación de datos. server web app Solo se admite server.	server
industryName	string	El nombre de la industria. general: General ecommerce: Comercio electrónico	GENERAL
status	integer	El estado. 0: La recopilación de datos no está habilitada. 1: La recopilación de datos se está habilitando. 2: La recopilación de datos está habilitada. 3: No se pudo habilitar la recopilación de datos.	2
updated	integer	La hora en que se actualizó por última vez la recopilación de datos.	1581065904
name	string	El nombre de la recopilación de datos.	os_function_test_v1
sundialId	string	El ID del sundial.	1755
id	string	El ID de la recopilación de datos.	286

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.