Consulta uma lista de pastas.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| ProjectId |
integer |
Não |
O ID do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do workspace para obter o ID do workspace. Você deve especificar este parâmetro ou ProjectIdentifier para determinar o workspace do DataWorks para esta chamada de API. |
10000 |
| ProjectIdentifier |
string |
Não |
O nome do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do workspace para obter o nome do workspace. Você deve especificar este parâmetro ou ProjectId para determinar 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 para paginação. |
1 |
| PageSize |
integer |
Sim |
O número de entradas por página. Valor padrão: 10. Valor máximo: 100. |
10 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Os parâmetros de resposta. |
||
| 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. Você pode usar este ID para solucionar problemas. |
0000-ABCD-**** |
| ErrorCode |
string |
O código de erro. |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
Indica se a chamada foi bem-sucedida. Valores válidos:
|
true |
| Data |
object |
A lista de pastas que atendem às condições especificadas. |
|
| PageNumber |
integer |
O número da página atual. |
1 |
| PageSize |
integer |
O número de entradas na página atual. |
10 |
| TotalCount |
integer |
O número total de entradas que atendem às condições de consulta. |
13 |
| Folders |
array<object> |
A lista de pastas. |
|
|
object |
As informações da pasta. |
||
| 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 |
Descrição |
|---|---|---|---|
| 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. | Acesso negado. Autorize o acesso. |
| 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.