ListMetaCollections - DataWorks - Centro de documentación de Alibaba Cloud

Descripción de la operación

Las colecciones incluyen: ALBUM (colección de álbumes) y ALBUM_CATEGORY (subcategoría dentro de un álbum).

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

dataworks:*

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ParentQualifiedName	string	No	El identificador único de la colección principal.	Album.1234
NextToken	string	No	El token de paginación que especifica el punto de inicio de la operación de lectura actual.	12345
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
Keyword	string	No	La palabra clave.	Palabra clave
OrderBy	string	No	El nombre del campo que se utiliza para ordenar.	Campo de ordenación
CollectionType	string	Sí	El tipo de colección que se va a consultar. Valores válidos: ALBUM: colección de álbumes. ALBUM_CATEGORY: subcategoría dentro de un álbum.	ALBUM
Creator	string	No	El ID de usuario del creador.	1200759642363000
Administrator	string	No	El ID del administrador de la colección.	1200759642363000
Follower	string	No	El ID del seguidor de la colección.	1200759642363000

Puede establecer como máximo uno de los siguientes parámetros: Creator, Administrator y Follower.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La estructura de respuesta.
RequestId	string	El ID de la solicitud. Se utiliza para localizar registros y solucionar problemas.	E25887B7-579C-54A5-9C4F-83A0DE367DDE
Data	object	El objeto devuelto.
NextToken	string	El token para la página siguiente.	37ae2053d87d380f28ce0dc0853ca51e
CollectionList	array	El objeto de matriz.
	Collection	El objeto de colección devuelto.
Success	boolean	Indica si la llamada se realizó correctamente. Valores válidos: true: la llamada se realizó correctamente. false: la llamada falló.	true
ErrorCode	string	El código de error.	Invalid.Collection.NotExists
ErrorMessage	string	El mensaje de error.	Los parámetros especificados no son válidos
HttpStatusCode	integer	El código de estado HTTP.	200

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DDE",
  "Data": {
    "NextToken": "37ae2053d87d380f28ce0dc0853ca51e",
    "CollectionList": [
      {
        "QualifiedName": "album.12334",
        "CollectionType": "album",
        "Name": "collectionName",
        "Comment": "comment",
        "OwnerId": "1234444",
        "OwnerName": "owner",
        "CreateTime": 1668600147617,
        "UpdateTime": 1668600148617,
        "Level": 1
      }
    ]
  },
  "Success": true,
  "ErrorCode": "Invalid.Collection.NotExists",
  "ErrorMessage": "The specified parameters are invalid",
  "HttpStatusCode": 200
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Invalid.Collection.ParamError	msg: %s
400	Invalid.User.NotExist	msg: %s
400	Invalid.Collection.QualifiedNameError	msg: %s
400	Invalid.Collection.CollectionNotCompatible	msg: %s
400	Invalid.Collection.EntityOverflow	msg: %s
400	Invalid.Collection.NotExist	msg: %s
400	Invalid.Collection.AlreadyExist	msg: %s
400	Invalid.Collection.UnsupportedOperation	msg: %s
400	InvalidParameter.Meta.Missing	msg: %s
400	Forbidden.No.Permission	msg: %s
400	InvalidParameter.Meta.IllegalData	msg: %s

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.