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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListFolders	Operação a ser executada.
PageNumber	Integer	Sim	1	Número da página a retornar.
PageSize	Integer	Sim	10	Quantidade de entradas por página. Valor padrão: 10. Valor máximo: 100.
ParentFolderPath	String	Sim	Workflow/1/MaxCompute	Caminho da pasta pai.
RegionId	String	Sim	cn-zhangjiakou	ID da região. Por exemplo, o ID da região China (Shanghai) é cn-shanghai e o da região China (Zhangjiakou) é cn-zhangjiakou. O sistema determina esse valor automaticamente com base no endpoint usado na chamada da operação.
ProjectId	Long	Não	10000	ID do workspace do DataWorks. Faça login no console do DataWorks e acesse a página Workspace Management para obter o ID. Especifique este parâmetro ou ProjectIdentifier para definir o workspace do DataWorks alvo da operação.
ProjectIdentifier	String	Não	dw_project	Nome do workspace do DataWorks. Faça login no console do DataWorks e acesse o painel Workspace Settings para obter o nome. Especifique este parâmetro ou ProjectId para definir o workspace do DataWorks alvo da operação.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Data	Struct		Pastas retornadas.
Folders	Array of Folders		Detalhes das pastas.
FolderId	String	2735c2****	ID da pasta.
FolderPath	String	Workflow/1/MaxCompute/ods	Caminho da pasta.
PageNumber	Integer	1	Número da página retornada.
PageSize	Integer	10	Quantidade de entradas na página retornada.
TotalCount	Integer	13	Total de entradas retornadas.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	Código de erro retornado.
ErrorMessage	String	The connection does not exist.	Mensagem de erro retornada.
HttpStatusCode	Integer	200	Código de status HTTP retornado.
RequestId	String	0000-ABCD-EFG****	ID da solicitação. Utilize-o para solucionar problemas.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListFolders
&PageNumber=1
&PageSize=10
&ParentFolderPath=Workflow/1/MaxCompute
&RegionId=cn-zhangjiakou
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>13</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Folders>
        <FolderPath>Workflow/1/MaxCompute/ods</FolderPath>
        <FolderId>2735c2****</FolderId>
    </Folders>
</Data>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>

Formato JSON

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError.System	An internal system error occurred. Try again later.	Erro interno do sistema. Tente novamente mais tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Erro interno do sistema. Tente novamente mais tarde.
429	Throttling.Api	The request for this resource has exceeded your available limit.	O número de solicitações para este recurso excedeu o limite permitido.
429	Throttling.System	The DataWorks system is busy. Try again later.	O sistema do DataWorks está ocupado. Tente novamente mais tarde.
429	Throttling.User	Your request is too frequent. Try again later.	Frequência de solicitações excessiva. Tente novamente mais tarde.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Acesso negado. Ative o DataWorks Enterprise Edition ou Ultimate Edition.

Para obter uma lista de códigos de erro, visite o API Error Center.