ListFolders - - Centro de documentación de Alibaba Cloud

Consulta carpetas.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListFolders	La operación que desea ejecutar.
PageNumber	Integer	Sí	1	El número de página que se devolverá.
PageSize	Integer	Sí	10	El número de entradas que se devolverán en cada página. Valor predeterminado: 10. Valor máximo: 100.
ParentFolderPath	String	Sí	Workflow/1/MaxCompute	La ruta de la carpeta principal.
RegionId	String	Sí	cn-zhangjiakou	El ID de la región. Por ejemplo, el ID de la región China (Shanghai) es cn-shanghai y el de la región China (Zhangjiakou) es cn-zhangjiakou. El sistema determina automáticamente el valor de este parámetro según el endpoint utilizado para llamar a la operación.
ProjectId	Long	No	10000	El ID del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya a la página Workspace Management para obtener el ID. Debe especificar este parámetro o ProjectIdentifier para determinar el espacio de trabajo de DataWorks al que se aplica la operación.
ProjectIdentifier	String	No	dw_project	El nombre del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya al panel Workspace Settings para obtener el nombre. Debe especificar este parámetro o ProjectId para determinar el espacio de trabajo de DataWorks al que se aplica la operación.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Data	Struct		Las carpetas devueltas.
Folders	Array of Folders		Los detalles de la carpeta.
FolderId	String	2735c2****	El ID de la carpeta.
FolderPath	String	Workflow/1/MaxCompute/ods	La ruta de la carpeta.
PageNumber	Integer	1	El número de la página devuelta.
PageSize	Integer	10	El número de entradas en la página devuelta.
TotalCount	Integer	13	El número total de entradas devueltas.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	El código de error devuelto.
ErrorMessage	String	The connection does not exist.	El mensaje de error devuelto.
HttpStatusCode	Integer	200	El código de estado HTTP devuelto.
RequestId	String	0000-ABCD-EFG****	El ID de la solicitud. Puede usar este ID para solucionar problemas.
Success	Boolean	true	Indica si la solicitud fue exitosa.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
500	InternalError.System	An internal system error occurred. Try again later.	Mensaje de error devuelto por un error interno. Inténtelo de nuevo más tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Mensaje de error devuelto por un error interno. Inténtelo de nuevo más tarde.
429	Throttling.Api	The request for this resource has exceeded your available limit.	Mensaje de error devuelto porque el número de solicitudes para el recurso excedió el límite superior.
429	Throttling.System	The DataWorks system is busy. Try again later.	Mensaje de error devuelto porque el sistema de DataWorks está ocupado. Inténtelo de nuevo más tarde.
429	Throttling.User	Your request is too frequent. Try again later.	Mensaje de error devuelto porque se enviaron demasiadas solicitudes en un corto período. Inténtelo de nuevo más tarde.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Mensaje de error devuelto porque no tiene permiso para ejecutar esta operación. Active DataWorks Enterprise Edition o Ultimate Edition.

Para consultar una lista de códigos de error, visite el Centro de errores de API.