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

Chama a operação ListFolders para consultar pastas.

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

get

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do workspace do DataWorks. Faça logon no console do DataWorks e acesse a página Gerenciamento de Workspaces para obter o ID do workspace. Você deve definir este parâmetro ou ProjectIdentifier para especificar o workspace do DataWorks para esta chamada de API.	10000
ProjectIdentifier	string	Não	O nome do workspace do DataWorks. Faça logon no console do DataWorks e acesse a página Gerenciamento de Workspaces para obter o nome do workspace. Você deve definir este parâmetro ou ProjectId para especificar o workspace do DataWorks para esta chamada de API.	dw_project
ParentFolderPath	string	Sim	O caminho da pasta pai.	Business_process/my_first_business_process/MaxCompute
PageNumber	integer	Sim	O número da página a ser retornada. Este parâmetro é usado para paginação.	1
PageSize	integer	Sim	O número de entradas por página. O valor padrão é 10. O valor máximo é 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
RequestId	string	O ID da solicitação. Use este ID para solucionar problemas.	0000-ABCD-****
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a operação foi bem-sucedida.	true
Data	object	Uma lista de pastas que atendem aos critérios especificados.
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número de entradas na página retornada.	10
TotalCount	integer	O número total de entradas que atendem aos critérios de filtro.	13
Folders	array<object>	Uma lista de pastas.
	object
FolderPath	string	O caminho da pasta.	Business_process/my_first_business_process/MaxCompute/ods_layer
FolderId	string	O ID da pasta.	2735c2****

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Folders": [
      {
        "FolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer",
        "FolderId": "2735c2****"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.