Consulta uma lista de instâncias.
Depuração
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Exemplo |
Descrição |
|
Action |
String |
Sim |
ListInstances |
A operação a ser executada. |
|
ProjectEnv |
String |
Sim |
PROD |
O ambiente do workspace. Valores válidos: PROD e DEV. PROD indica o ambiente de produção. DEV indica o ambiente de desenvolvimento. |
|
NodeId |
Long |
Não |
100000000000 |
O ID do nó. Chame a operação ListNodes para consultar o ID do nó. |
|
NodeName |
String |
Não |
openmr_8**** |
O nome do nó. Chame a operação ListNodes para consultar o nome do nó. |
|
Owner |
String |
Não |
193379**** |
O ID da conta Alibaba Cloud usada pelo administrador do workspace. Faça login no Alibaba Cloud Management Console e visualize o ID na página Security Settings. |
|
ProjectId |
Long |
Sim |
12345 |
O ID do workspace. Chame a operação ListProjects para consultar o ID do workspace. |
|
BizName |
String |
Não |
test_bizName |
O nome do fluxo de trabalho. Chame a operação ListBusiness para consultar o nome do fluxo de trabalho. |
|
ProgramType |
String |
Não |
ODPS_SQL |
O tipo do nó. Chame a operação ListNodes para consultar o tipo do nó. |
|
PageNumber |
Integer |
Não |
1 |
O número da página. Valores válidos: 1 a 100. |
|
PageSize |
Integer |
Não |
10 |
O número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10. |
|
DagId |
Long |
Não |
11111 |
O ID do grafo acíclico direcionado (DAG). Defina este parâmetro com o valor do parâmetro DagId retornado pela operação RunCycleDagNodes, RunSmokeTest ou RunManualDagNodes. A operação RunManualDagNodes repõe dados, a operação RunSmokeTest realiza testes de fumaça e a operação RunManualDagNodes executa nós em um fluxo de trabalho acionado manualmente. |
|
Bizdate |
String |
Não |
2020-02-02 00:00:00 |
O timestamp de dados das instâncias a serem consultadas. Especifique o timestamp no formato yyyy-MM-dd HH:mm:ss. |
|
BeginBizdate |
String |
Não |
2020-02-02 00:00:00 |
O início do intervalo de tempo a ser consultado. Especifique o horário no formato yyyy-MM-dd HH:mm:ss. |
|
EndBizdate |
String |
Não |
2020-02-03 00:00:00 |
O fim do intervalo de tempo a ser consultado. Especifique o horário no formato yyyy-MM-dd HH:mm:ss. |
|
Status |
String |
Não |
NOT_RUN |
O status do nó. Valores válidos:
|
|
OrderBy |
String |
Não |
INSTANCE_ID_DESC |
A regra de ordenação das instâncias a serem retornadas. Valores válidos:
|
Parâmetros de resposta
|
Parâmetro |
Tipo |
Exemplo |
Descrição |
|
HttpStatusCode |
Integer |
200 |
O código de status HTTP. |
|
RequestId |
String |
E6F0DBDD-5AD**** |
O ID da solicitação. |
|
ErrorMessage |
String |
The project does not exist. |
A mensagem de erro. |
|
ErrorCode |
String |
Invalid.Tenant.ProjectNotExists |
O código de erro. |
|
Success |
Boolean |
true |
Indica se a solicitação foi bem-sucedida. Valores válidos:
|
|
Data |
Object |
As instâncias retornadas. |
|
|
PageNumber |
Integer |
1 |
O número da página. |
|
PageSize |
Integer |
10 |
O número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10. |
|
TotalCount |
Integer |
66 |
O número total de instâncias retornadas. |
|
Instances |
Array of Instance |
As informações sobre as instâncias. |
|
|
Status |
String |
NOT_RUN |
O status do nó. Valores válidos:
|
|
CycTime |
Long |
1590422400000 |
O horário em que o nó estava agendado para execução. |
|
BeginRunningTime |
Long |
1590416703313 |
O horário em que a instância começou a ser executada. |
|
FinishTime |
Long |
1590416703313 |
O horário em que o nó parou de ser executado. |
|
ErrorMessage |
String |
error message |
A mensagem de erro. Este parâmetro foi descontinuado. Chame a operação GetInstanceLog para consultar as informações de erro relacionadas ao nó. |
|
CreateTime |
Long |
1590416703313 |
O horário em que a instância foi gerada. |
|
DagId |
Long |
33845 |
O ID do fluxo de trabalho. |
|
Priority |
Integer |
1 |
A prioridade da instância. Valores válidos: 1, 3, 5, 7 e 8. Um valor maior indica uma prioridade mais alta. Valor padrão: 1. |
|
TaskType |
String |
NORMAL(0) |
O tipo de agendamento do nó. Valores válidos:
|
|
ParamValues |
String |
bizdate=$bizdate tbods=$tbods |
Os parâmetros relacionados ao nó. |
|
Connection |
String |
odps_source |
A string de conexão. |
|
BaselineId |
Long |
123123 |
O ID da linha de base. |
|
DqcType |
Integer |
1 |
Indica se a instância está associada a uma regra de monitoramento no Data Quality. Valores válidos:
|
|
DagType |
String |
DAILY |
O tipo do fluxo de trabalho. Valores válidos:
|
|
BusinessId |
Long |
123 |
O ID do fluxo de trabalho. |
|
TaskRerunTime |
Integer |
0 |
O número de vezes que o nó pode ser reexecutado. O valor deste parâmetro pode estar vazio ou ser um número inteiro maior ou igual a 0.
|
|
ModifyTime |
Long |
1590416703313 |
O horário da última modificação do nó. |
|
Repeatability |
Boolean |
true |
Indica se o nó pode ser reexecutado. |
|
RepeatInterval |
Long |
60000 |
O intervalo em que o nó é reexecutado após uma falha. Unidade: milissegundos. |
|
InstanceId |
Long |
1234 |
O ID da instância. |
|
BeginWaitResTime |
Long |
1590416703313 |
O horário em que a instância começou a aguardar recursos. |
|
RelatedFlowId |
Long |
123456 |
O ID do fluxo de trabalho ao qual o nó pertence. |
|
Bizdate |
Long |
1590336000000 |
O timestamp de dados da instância. Na maioria dos casos, o valor corresponde a um dia antes do horário de execução da instância. |
|
NodeName |
String |
kzh |
O nome do nó. |
|
BeginWaitTimeTime |
Long |
1590416703313 |
O horário em que a instância começou a aguardar o agendamento. |
|
DqcDescription |
String |
[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}] |
A tabela e a expressão de filtro de partição no Data Quality associadas ao nó. |
|
NodeId |
Long |
33115 |
O ID do nó. |
|
CreateUser |
String |
Test |
O nome da conta usada para executar a instância. Por exemplo, se uma conta chamada Test foi usada para executar a instância de reposição de dados, o valor deste parâmetro será Test. |
Exemplos
Exemplos de solicitações
http(s)://[Endpoint]/?Action=ListInstances
&ProjectEnv=PROD
&NodeId=100000000000
&NodeName=openmr_8****
&Owner=193379****
&ProjectId=12345
&BizName=test_bizName
&ProgramType=ODPS_SQL
&PageNumber=1
&PageSize=10
&DagId=11111
&Bizdate=2020-02-02 00:00:00
&BeginBizdate=2020-02-02 00:00:00
&EndBizdate=2020-02-03 00:00:00
&Status=NOT_RUN
&<Common request parameters>
Exemplos de respostas de sucesso
Formato XML
HTTP/1.1 200 OK
Content-Type:application/xml
<ListInstancesResponse>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>E6F0DBDD-5AD****</RequestId>
<ErrorMessage>The project does not exist.</ErrorMessage>
<ErrorCode>Invalid.Tenant.ProjectNotExists</ErrorCode>
<Success>true</Success>
<Data>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>66</TotalCount>
<Instances>
<Status>NOT_RUN</Status>
<CycTime>1590422400000</CycTime>
<BeginRunningTime>1590416703313</BeginRunningTime>
<FinishTime>1590416703313</FinishTime>
<ErrorMessage>error message</ErrorMessage>
<CreateTime>1590416703313</CreateTime>
<DagId>33845</DagId>
<Priority>1</Priority>
<TaskType>NORMAL(0)</TaskType>
<ParamValues>bizdate=$bizdate tbods=$tbods</ParamValues>
<Connection>odps_source</Connection>
<BaselineId>123123</BaselineId>
<DqcType>1</DqcType>
<DagType>DAILY</DagType>
<BusinessId>123</BusinessId>
<TaskRerunTime>0</TaskRerunTime>
<ModifyTime>1590416703313</ModifyTime>
<Repeatability>true</Repeatability>
<RepeatInterval>60000</RepeatInterval>
<InstanceId>1234</InstanceId>
<BeginWaitResTime>1590416703313</BeginWaitResTime>
<RelatedFlowId>123456</RelatedFlowId>
<Bizdate>1590336000000</Bizdate>
<NodeName>kzh</NodeName>
<BeginWaitTimeTime>1590416703313</BeginWaitTimeTime>
<DqcDescription>[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]</DqcDescription>
<NodeId>33115</NodeId>
<CreateUser>Test</CreateUser>
</Instances>
</Data>
</ListInstancesResponse>
Formato JSON
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"RequestId" : "E6F0DBDD-5AD****",
"ErrorMessage" : "The project does not exist.",
"ErrorCode" : "Invalid.Tenant.ProjectNotExists",
"Success" : true,
"Data" : {
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 66,
"Instances" : {
"Status" : "NOT_RUN",
"CycTime" : 1590422400000,
"BeginRunningTime" : 1590416703313,
"FinishTime" : 1590416703313,
"ErrorMessage" : "error message",
"CreateTime" : 1590416703313,
"DagId" : 33845,
"Priority" : 1,
"TaskType" : "NORMAL(0)",
"ParamValues" : "bizdate=$bizdate tbods=$tbods",
"Connection" : "odps_source",
"BaselineId" : 123123,
"DqcType" : 1,
"DagType" : "DAILY",
"BusinessId" : 123,
"TaskRerunTime" : 0,
"ModifyTime" : 1590416703313,
"Repeatability" : true,
"RepeatInterval" : 60000,
"InstanceId" : 1234,
"BeginWaitResTime" : 1590416703313,
"RelatedFlowId" : 123456,
"Bizdate" : 1590336000000,
"NodeName" : "kzh",
"BeginWaitTimeTime" : 1590416703313,
"DqcDescription" : "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
"NodeId" : 33115,
"CreateUser" : "Test"
}
}
}
Códigos de erro
Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.