Obtém uma lista de aplicativos.
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 a partir da página 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: 100. |
10 |
| ProjectIdList |
string |
Sim |
O ID do workspace com base no qual você deseja consultar as informações básicas dos aplicativos. Você pode especificar vários IDs. Separe-os com vírgulas (,). Você deve especificar pelo menos um ID de workspace. Você pode especificar no máximo 50 IDs de workspace. |
10000,100001 |
| TenantId |
integer |
Não |
O ID do locatário. Para obter o ID do locatário, execute as seguintes etapas: faça login no console do DataWorks. Encontre seu workspace e acesse a página do DataStudio. Na página do DataStudio, clique no nome de usuário de login no canto superior direito e clique em Informações do Usuário na seção Menu. |
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 solicitação foi bem-sucedida. |
true |
| ErrorCode |
string |
O código de erro. |
0 |
| Data |
object |
Os dados retornados. |
|
| PageNumber |
integer |
O número da página. O valor deste parâmetro é o mesmo que o do 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 retornadas. |
100 |
| Applications |
array<object> |
As informações básicas dos aplicativos. |
|
|
object |
|||
| ApplicationName |
string |
The name of the application. |
My application |
| ApplicationId |
integer |
The application ID. |
20000 |
| ProjectId |
integer |
The workspace ID. |
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. | No permission, please authorize |
| 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.