ListMetaCollections - DataWorks: Central de Documentação do Alibaba Cloud

Descrição da operação

As coleções incluem ALBUM (álbum de dados) e ALBUM_CATEGORY (categoria em um álbum de dados).

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:*

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ParentQualifiedName	string	Não	O identificador exclusivo da coleção pai.	Album.1234
NextToken	string	Não	O token de paginação usado na próxima solicitação para obter uma nova página de resultados.	12345
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
Keyword	string	Não	A palavra-chave.	Keyword
OrderBy	string	Não	O nome do campo de ordenação.	Sort field
CollectionType	string	Sim	ALBUM: álbum de dados ALBUM_CATEGORY: categoria em um álbum de dados	ALBUM
Creator	string	Não	O ID do criador da coleção.	1200759642363000
Administrator	string	Não	O ID do administrador da coleção.	1200759642363000
Follower	string	Não	O ID do seguidor da coleção.	1200759642363000

Você pode definir no máximo um dos parâmetros Creator, Administrator e Follower.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	E25887B7-579C-54A5-9C4F-83A0DE367DDE
Data	object	O resultado retornado.
NextToken	string	Um token de paginação. Pode ser usado na próxima solicitação para obter uma nova página de resultados.	37ae2053d87d380f28ce0dc0853ca51e
CollectionList	array	As coleções.
	Collection	A coleção.
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
ErrorCode	string	O código de erro.	Invalid.Collection.NotExists
ErrorMessage	string	A mensagem de erro.	The specified parameters are invalid.
HttpStatusCode	integer	O código de status HTTP.	200

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.