Consulta las carpetas del servicio de datos.
Pruébelo ahora
Test
Autorización de RAM
Parámetros de la solicitud
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| PageNumber |
integer |
No |
El número de página. Las páginas comienzan desde 1. Valor predeterminado: 1. |
1 |
| PageSize |
integer |
No |
El número de entradas por página. Valor predeterminado: 10. Valor máximo: 50. |
10 |
| ProjectId |
integer |
Sí |
El ID del espacio de trabajo. Puede llamar a la operación ListProjects para obtener un ID de espacio de trabajo válido, o ver el ID en la configuración del espacio de trabajo de la consola de DataWorks. El valor de ejemplo en la documentación es solo para demostración de formato. |
10001 |
| TenantId |
integer |
No |
El ID de inquilino. Puede iniciar sesión en la consola de DataWorks, ir a la página de Data Studio, hacer clic en el nombre de usuario de la sesión activa en la esquina superior derecha y elegir Menú > Información de usuario para obtener el ID de inquilino. |
10002 |
| GroupId |
string |
No |
El ID del flujo de trabajo al que pertenece la carpeta. |
ds_123abc |
| FolderNameKeyword |
string |
No |
La palabra clave en el nombre de la carpeta. Se admite la coincidencia de subcadenas. |
Folder name keyword |
Elementos de la respuesta
|
Elemento |
Tipo |
Descripción |
Ejemplo |
|
object |
|||
| RequestId |
string |
El ID de la solicitud. |
0000-ABCD-EF**** |
| FolderPagingResult |
object |
El resultado paginado de la lista de carpetas. |
|
| PageNumber |
integer |
El número de página. El valor es el mismo que el del parámetro PageNumber en la solicitud. |
1 |
| PageSize |
integer |
El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100. |
10 |
| TotalCount |
integer |
El número total de entradas. |
100 |
| Folders |
array<object> |
La lista de carpetas. |
|
|
object |
|||
| ParentId |
integer |
El ID de la carpeta principal. El ID de la carpeta raíz bajo un flujo de trabajo es 0, y el ID de una carpeta creada por el usuario es mayor que 0. |
0 |
| ModifiedTime |
string |
La hora en que se modificó la carpeta. La hora sigue el formato |
2020-09-24T18:37:51+0800 |
| GroupId |
string |
El ID del flujo de trabajo al que pertenece la carpeta. |
ds_1234 |
| FolderId |
integer |
El ID de la carpeta. |
11 |
| FolderName |
string |
El nombre de la carpeta. |
test1 |
| ProjectId |
integer |
El ID del espacio de trabajo. |
10001 |
| CreatedTime |
string |
La hora en que se creó la carpeta. La hora sigue el formato |
2020-09-24T18:37:51+0800 |
| TenantId |
integer |
El ID de inquilino. |
10002 |
Ejemplos
Respuesta exitosa
JSON Formato
{
"RequestId": "0000-ABCD-EF****",
"FolderPagingResult": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Folders": [
{
"ParentId": 0,
"ModifiedTime": "2020-09-24T18:37:51+0800",
"GroupId": "ds_1234",
"FolderId": 11,
"FolderName": "test1",
"ProjectId": 10001,
"CreatedTime": "2020-09-24T18:37:51+0800",
"TenantId": 10002
}
]
}
}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. | |
| 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. | No tiene los permisos requeridos. Conceda los permisos primero. |
| 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 error para ver la lista completa.
Notas de la versión
Consulte Notas de la versión para ver la lista completa.