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

Consulta uma lista de conjuntos de dados. Atualmente, há suporte para conjuntos de dados do DataWorks e do PAI.

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

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do espaço de trabalho do DataWorks.	251363
Origin	string	Não	A origem do conjunto de dados. Valores válidos: DataWorks PAI	DataWorks
Name	string	Não	O nome do conjunto de dados. Suporta pesquisa aproximada.	test_dataset
DataTypeList	array	Não	O tipo de dados. Múltiplas seleções são permitidas. Valores válidos: COMMON PIC TEXT TABLE VIDEO AUDIO INDEX
	string	Não	Tipos de dados Valores válidos: TABLE: Tabela. VIDEO: Vídeo. COMMON: Comum. TEXT: Texto. PIC: Imagem. INDEX: Índice. AUDIO: Áudio. Valores válidos: TABLE : Tabela. VIDEO : Vídeo. COMMON : Comum. TEXT : Texto. PIC : Imagem. INDEX : Índice. AUDIO : Áudio.	COMMON
StorageTypeList	array	Não	O tipo de armazenamento. Múltiplas seleções são permitidas. Valores válidos: OSS NAS: Sistemas de arquivos NAS de uso geral EXTREMENAS: Sistemas de arquivos Extreme NAS DLF_LANCE: Data Lake Formation CPFS: Cloud Parallel File Storage BMCPFS: CPFS para Lingjun MAXCOMPUTE: Tabela do MaxCompute Valores válidos: NAS : Armazenamento de arquivos NAS de uso geral. MAXCOMPUTE : Tabela do MaxCompute. CPFS : Armazenamento de arquivos CPFS. BMCPFS : CPFS para Lingjun. EXTREMENAS : Armazenamento de arquivos Extreme NAS. OSS : Object Storage Service. DLF_LANCE : Data Lake Formation.
	string	Não	O tipo de armazenamento.	NAS
CreatorId	string	Não	O ID do criador.	12103XXX46492139
SortBy	string	Não	O campo de ordenação. Valor padrão: CreateTime. Valores válidos: ModifyTime: Hora da modificação. CreateTime: Hora de criação. Name Valores válidos: ModifyTime : Hora da modificação. CreateTime : Hora de criação. Name : Nome.	CreateTime
Order	string	Não	A ordem de classificação. Valor padrão: Desc. Valores válidos: Asc: Ascendente. Desc: Descendente. Valores válidos: Asc : Ascendente. Desc : Descendente.	Asc
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas.	100
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas nesta página.	10
Datasets	array	A lista de conjuntos de dados.
	Dataset	O objeto do conjunto de dados.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX\n",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Datasets": [
      {
        "Id": "dataworks-dataset:1gxxxqjx155usz3hrv",
        "Name": "test_dataset",
        "Comment": "测试数据集",
        "ProjectId": 123456,
        "Origin": "DataWorks",
        "DataType": "COMMON",
        "StorageType": "OSS",
        "CreatorId": "210484359",
        "Readme": "## introduction",
        "LatestVersion": {
          "Id": "dataworks-datasetVersion:0gfxxxjx155usz3hrv:1",
          "DatasetId": "dataworks-datasetVersion:0gfxxxjx155usz3hrv",
          "Comment": "初始版本",
          "CreatorId": "17815XXX61016173",
          "VersionNumber": 1,
          "StorageType": "OSS",
          "Url": "oss://test-oss-bucket/test_dir/",
          "MountPath": "/mnt/data",
          "CreateTime": 1736756055000,
          "ModifyTime": 1736756055000,
          "Labels": [
            {
              "Key": "key1",
              "Value": "value1"
            }
          ],
          "ImportInfo": {
            "key": "None"
          }
        },
        "CreateTime": 1736756055000,
        "ModifyTime": 1736756055000,
        "Labels": [
          {
            "Key": "key1",
            "Value": "value1"
          }
        ]
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.