Consulta as informações básicas das aplicações de serviço de dados.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| PageNumber |
integer |
Não |
O número da página. As páginas começam em 1. Valor padrão: 1. |
1 |
| PageSize |
integer |
Não |
O número de entradas por página. Valor padrão: 10. Valor máximo: 50. |
10 |
| ProjectIdList |
string |
Sim |
Os IDs dos workspaces usados para consultar aplicações. Separe vários IDs com vírgulas (,). Você pode especificar de 1 a 50 IDs de workspace. |
10000,100001 |
| TenantId |
integer |
Não |
O ID do locatário. Para obter o ID do locatário, faça login no console do DataWorks, acesse a página Data Studio, clique no nome de usuário no canto superior direito e escolha Menu > Informações do Usuário. |
100002 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| HttpStatusCode |
integer |
O código de status HTTP. |
200 |
| RequestId |
string |
O ID da solicitação. |
0000-ABCD-EFG*** |
| ErrorMessage |
string |
A mensagem de erro. |
Normal |
| Success |
boolean |
Indica se a chamada foi bem-sucedida. |
true |
| ErrorCode |
string |
O código de erro. |
0 |
| Data |
object |
As informações básicas das aplicações. |
|
| PageNumber |
integer |
O número da página. O valor é o mesmo que o parâmetro PageNumber na solicitação. |
1 |
| PageSize |
integer |
O número de entradas por página. Valor padrão: 10. Valor máximo: 100. |
10 |
| TotalCount |
integer |
O número total de entradas. |
100 |
| Applications |
array<object> |
A lista de informações básicas sobre as aplicações. |
|
|
object |
|||
| ApplicationName |
string |
O nome da aplicação. |
My application |
| ApplicationId |
integer |
O ID da aplicação. |
20000 |
| ProjectId |
integer |
O ID do workspace. |
10000 |
Exemplos
Resposta de sucesso
JSON formato
{
"HttpStatusCode": 200,
"RequestId": "0000-ABCD-EFG***",
"ErrorMessage": "Normal",
"Success": true,
"ErrorCode": "0",
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Applications": [
{
"ApplicationName": "My application",
"ApplicationId": 20000,
"ProjectId": 10000
}
]
}
}
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. | Você não tem as permissões necessárias. Conceda as permissões primeiro. |
| 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.