Obtém uma lista de instâncias de fluxo de trabalho usando paginação. Você também pode realizar uma consulta filtrada com base em condições.
Descrição da operação
Você deve adquirir o DataWorks Basic Edition ou superior para usar este recurso.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| ProjectId |
integer |
Sim |
O ID do projeto. |
100 |
| BizDate |
integer |
Sim |
A data de negócios. Normalmente, é 00:00:00 do dia anterior ao horário agendado da instância periódica, formatada como um carimbo de data/hora em milissegundos, como 1743350400000. |
1710239005403 |
| Type |
string |
Não |
O tipo da instância de fluxo de trabalho. Valores válidos:
Valores válidos:
|
Normal |
| WorkflowId |
integer |
Não |
O ID do fluxo de trabalho ao qual a instância pertence. |
1234 |
| UnifiedWorkflowInstanceId |
integer |
Não |
O ID unificado da instância de fluxo de trabalho. O valor deste campo é o mesmo para todas as instâncias de fluxo de trabalho dentro de uma data de negócios específica sob um único gatilho. |
1234 |
| Name |
string |
Não |
O nome. Há suporte para correspondência aproximada. |
WorkflowInstance1 |
| Ids |
array |
Não |
A lista de IDs de instâncias de fluxo de trabalho. Você pode usar este parâmetro para consultar várias instâncias de fluxo de trabalho em lotes por seus IDs. |
|
|
integer |
Não |
O ID da instância de fluxo de trabalho. |
1234 |
|
| Owner |
string |
Não |
O ID da conta do proprietário. |
1000 |
| SortBy |
string |
Não |
A lista de campos de ordenação. Há suporte para campos como o horário agendado e o horário de início. O formato é "Campo de ordenação + Ordem de ordenação (Desc/Asc)", onde Asc pode ser omitido. Valores válidos para campos de ordenação:
Valor padrão: Id Desc. |
Id Desc |
| PageSize |
integer |
Não |
O número de entradas por página. Valor padrão: 10. |
10 |
| PageNumber |
integer |
Não |
O número da página. As páginas começam em 1. Valor padrão: 1. |
1 |
| Tags |
array |
Não |
A lista de tags. Se uma instância corresponder a qualquer uma das tags especificadas, ela será retornada no resultado. |
|
|
string |
Não |
A tag. Formato: chave:valor. Se o valor estiver vazio, o formato será chave:. |
key:value |
|
| Filter |
string |
Não |
O filtro. O valor está no formato JSON. Várias condições de filtro são conectadas pelo operador lógico AND. Campos suportados: status e executionDate. |
{ "status": "Success", "executionDate": "1763481600000" } |
| EnvType |
string |
Não |
O ambiente do projeto. Valores válidos:
Valores válidos:
|
Prod |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| RequestId |
string |
O ID da solicitação. Você pode usar este ID para localizar logs e solucionar problemas. |
22C97E95-F023-56B5-8852-B1A77A17XXXX |
| PagingInfo |
object |
As informações de paginação. |
|
| WorkflowInstances |
array<object> |
A lista de instâncias de fluxo de trabalho. |
|
|
array<object> |
|||
| Id |
integer |
O identificador exclusivo da instância de fluxo de trabalho. |
1234 |
| WorkflowTaskInstanceId |
integer |
O ID da instância de tarefa correspondente à instância de fluxo de trabalho. |
1234 |
| UnifiedWorkflowInstanceId |
integer |
O ID unificado da instância de fluxo de trabalho. O valor deste campo é o mesmo para todas as instâncias de fluxo de trabalho dentro de uma data de negócios específica sob um único gatilho. |
1234 |
| Name |
string |
O nome. |
WorkflowInstance1 |
| Type |
string |
O tipo da instância de fluxo de trabalho. Valores válidos:
|
Normal |
| Status |
string |
O status de execução da instância de fluxo de trabalho. Valores válidos:
|
Success |
| BizDate |
integer |
A data de negócios. O valor é um número de 13 dígitos, como 1710239005403. |
1710239005403 |
| StartedTime |
integer |
O horário de início. O valor é um número de 13 dígitos, como 1710239005403. |
1710239005403 |
| FinishedTime |
integer |
O horário de conclusão. O valor é um número de 13 dígitos, como 1710239005403. |
1710239005403 |
| ProjectId |
integer |
O ID do projeto. |
100 |
| EnvType |
string |
O ambiente do projeto. Valores válidos:
|
Prod |
| Owner |
string |
O ID da conta do proprietário do fluxo de trabalho. |
1000 |
| CreateTime |
integer |
O horário de criação. O valor é um número de 13 dígitos, como 1710239005403. |
1710239005403 |
| ModifyTime |
integer |
O horário de atualização. O valor é um número de 13 dígitos, como 1710239005403. |
1710239005403 |
| CreateUser |
string |
O ID da conta do usuário que criou a instância de fluxo de trabalho. |
100 |
| ModifyUser |
string |
O ID da conta do usuário que atualizou a instância de fluxo de trabalho. |
100 |
| WorkflowParameters |
string |
Os parâmetros do fluxo de trabalho. |
Periodic workflow: key1=value1 key2=value2 Manual workflow: {"key1":"value1", "key2": "value2"} |
| WorkflowId |
integer |
O ID do fluxo de trabalho ao qual a instância pertence. |
1234 |
| Tags |
array<object> |
As tags da tarefa. |
|
|
object |
|||
| Key |
string |
A chave da tag. |
key1 |
| Value |
string |
O valor da tag. |
value1 |
| TotalCount |
integer |
O número total de entradas. |
100 |
| PageSize |
integer |
O número de entradas por página. |
10 |
| PageNumber |
integer |
O número da página. |
1 |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
"PagingInfo": {
"WorkflowInstances": [
{
"Id": 1234,
"WorkflowTaskInstanceId": 1234,
"UnifiedWorkflowInstanceId": 1234,
"Name": "WorkflowInstance1",
"Type": "Normal",
"Status": "Success",
"BizDate": 1710239005403,
"StartedTime": 1710239005403,
"FinishedTime": 1710239005403,
"ProjectId": 100,
"EnvType": "Prod",
"Owner": "1000",
"CreateTime": 1710239005403,
"ModifyTime": 1710239005403,
"CreateUser": "100",
"ModifyUser": "100",
"WorkflowParameters": "Periodic workflow:\nkey1=value1 key2=value2\nManual workflow:\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
"WorkflowId": 1234,
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
]
}
],
"TotalCount": 100,
"PageSize": 10,
"PageNumber": 1
}
}Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.