ListTaskFlowInstance - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListTaskFlowInstance	Operação a ser executada. Defina o valor como ListTaskFlowInstance.
DagId	Long	Sim	7***	ID do fluxo de tarefas. Chame a operação ListTaskFlow ou ListLhTaskFlowAndScenario para obter esse ID.
TriggerType	Integer	Não	1	Modo de acionamento do fluxo de tarefas. Valores válidos: 0: Acionamento automático por agendamento periódico. 1: Acionamento manual.
StartTimeBegin	String	Não	2022-01-07	Início do intervalo de tempo para consulta dos registros de execução. Especifique a data no formato yyyy-MM-DD.
StartTimeEnd	String	Não	2022-04-08	Fim do intervalo de tempo para consulta dos registros de execução. Especifique a data no formato yyyy-MM-DD.
PageIndex	Integer	Sim	1	Número da página a retornar.
PageSize	Integer	Sim	20	Quantidade de entradas por página.
Tid	Long	Não	3***	ID do locatário. Chame a operação GetUserActiveTenant ou ListUserTenants para obter esse ID.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	8CFF2295-8249-5287-B888-DBD4F0D76CB0	ID da solicitação.
ErrorCode	String	UnknownError	Código de erro retornado em caso de falha na solicitação.
ErrorMessage	String	UnknownError	Mensagem de erro retornada em caso de falha na solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true: Solicitação bem-sucedida. false: Falha na solicitação.
DAGInstanceList	Array of DAGInstance		Informações dos registros de execução retornados.
DAGInstance
Id	Long	9234	ID do registro de execução.
BusinessTime	String	2021-11-10 14:37:26	Horário de início da execução do fluxo de tarefas, no formato yyyy-MM-DD HH:mm:ss.
EndTime	String	2021-11-11 14:38:57	Horário de conclusão da execução do fluxo de tarefas, no formato yyyy-MM-DD HH:mm:ss.
DagId	String	7***	ID do fluxo de tarefas.
TriggerType	Integer	1	Modo de acionamento do fluxo de tarefas. Valores válidos: 0: Acionamento automático por agendamento periódico. 1: Acionamento manual.
Status	Integer	4	Status do fluxo de tarefas. Valores válidos: 0: Aguardando agendamento. 1: Em execução. 2: Pausado. 3: Falha na execução. 4: Executado. 5: Concluído.
Message	String	test	Descrição da tarefa.
HistoryDagId	Long	2****	ID da versão anterior publicada do fluxo de tarefas.
DagName	String	Spark_SQL_test	Nome do fluxo de tarefas.
OwnerName	String	test_name	Nome do proprietário do fluxo de tarefas.
DagVersion	String	[]	Versão do fluxo de tarefas.
TotalCount	Integer	1	Total de registros de execução retornados.

Exemplos

Solicitações de exemplo

http(s)://dms-enterprise.aliyuncs.com/?Action=ListTaskFlowInstance
&DagId=7***
&TriggerType=1
&StartTimeBegin=2022-01-07
&StartTimeEnd=2022-04-08
&PageIndex=1
&PageSize=20
&Tid=3***
&Common request parameters

Respostas de sucesso de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTaskFlowInstanceResponse>
    <RequestId>8CFF2295-8249-5287-B888-DBD4F0D76CB0</RequestId>
    <Success>true</Success>
    <DAGInstanceList>
        <Id>9234</Id>
        <BusinessTime>2021-11-10 14:37:26</BusinessTime>
        <EndTime>2021-11-11 14:38:57</EndTime>
        <DagId>7***</DagId>
        <TriggerType>1</TriggerType>
        <Status>4</Status>
        <Message>test</Message>
        <DagName>Spark_SQL_test</DagName>
        <OwnerName>test_name</OwnerName>
    </DAGInstanceList>
    <TotalCount>1</TotalCount>
</ListTaskFlowInstanceResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "8CFF2295-8249-5287-B888-DBD4F0D76CB0",
  "Success" : true,
  "DAGInstanceList" : [ {
    "Id" : 9234,
    "BusinessTime" : "2021-11-10 14:37:26",
    "EndTime" : "2021-11-11 14:38:57",
    "DagId" : "7***",
    "TriggerType" : 1,
    "Status" : 4,
    "Message" : "test",
    "DagName" : "Spark_SQL_test",
    "OwnerName" : "test_name"
  } ],
  "TotalCount" : 1
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros de API.