ListTaskFlowInstance - - Alibaba Cloud Dokümantasyon Merkezi

Bir görev akışının yürütme kayıtlarını sorgular.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListTaskFlowInstance

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DagId	integer	Yes	Görev akışının kimliği. Görev akışının kimliğini almak için ListTaskFlow veya ListLhTaskFlowAndScenario işlemini çağırabilirsiniz.	7***
TriggerType	integer	No	Görev akışının tetiklendiği mod. Geçerli değerler: 0: Görev akışı periyodik zamanlamaya göre otomatik olarak tetiklenir. 1: Görev akışı manuel olarak tetiklenir.	1
StartTimeBegin	string	No	Görev akışının yürütme kayıtlarını sorgulamak için zaman aralığının başlangıcı. Zamanı yyyy-MM-DD biçiminde belirtin.	2022-01-07
StartTimeEnd	string	No	Görev akışının yürütme kayıtlarını sorgulamak için zaman aralığının sonu. Zamanı yyyy-MM-DD biçiminde belirtin.	2022-04-08
PageIndex	integer	Yes	Döndürülecek sayfanın numarası.	1
PageSize	integer	Yes	Her sayfada döndürülecek giriş sayısı.	20
Tid	integer	No	Kiracının kimliği. Kiracı kimliğini almak için GetUserActiveTenant veya ListUserTenants işlemini çağırabilirsiniz.	3***
UseBizDate	boolean	No	Filtre koşullarını ayarlar: true: StartTimeBegin ve StartTimeEnd, hizmetleri filtrelemek için kullanılan zaman aralığıdır. false: StartTimeBegin ve StartTimeEnd, görevin çalıştırılacağı zaman aralığıdır.	true
Status	integer	No	Görev düğümünün çalışma durumu. Geçerli değerler: 0: Zamanlama bekleniyor 1: Çalışıyor 2: Askıya alındı 3: Çalıştırma başarısız oldu 4: Başarıyla çalıştırıldı 5: Tamamlandı	2

Response elements

Element	Type	Description	Example
	object
RequestId	string	İsteğin kimliği.	8CFF2295-8249-5287-B888-DBD4F0D76CB0
ErrorCode	string	İsteğin başarısız olması durumunda döndürülen hata kodu.	UnknownError
ErrorMessage	string	İsteğin başarısız olması durumunda döndürülen hata mesajı.	UnknownError
Success	boolean	İsteğin başarılı olup olmadığını gösterir. Geçerli değerler: true: İstek başarılı. false: İstek başarısız.	true
DAGInstanceList	object
DAGInstance	array<object>	Döndürülen yürütme kayıtları hakkındaki bilgiler.
	object
Id	integer	Yürütme kaydının kimliği.	9234
BusinessTime	string	Görev akışının iş zamanı. Zaman yyyy-MM-DD HH:mm:ss biçiminde görüntülenir.	2021-11-10 14:37:26
startTime	string	Görev akışının yürütülmesinin başlatıldığı zaman. Zaman yyyy-MM-DD HH:mm:ss biçiminde görüntülenir.	2021-11-11 14:35:57
EndTime	string	Görev akışının yürütülmesinin tamamlandığı zaman. Zaman yyyy-MM-DD HH:mm:ss biçiminde görüntülenir.	2021-11-11 14:38:57
DagId	string	Görev akışının kimliği.	7***
TriggerType	integer	Görev akışının tetiklendiği mod. Geçerli değerler: 0: Görev akışı periyodik zamanlamaya göre otomatik olarak tetiklenir. 1: Görev akışı manuel olarak tetiklenir.	1
Status	integer	Görev akışının durumu. Geçerli değerler: 0: Görev akışı zamanlanmayı bekliyor. 1: Görev akışı yürütülüyor. 2: Görev akışı duraklatıldı. 3: Görev akışı başarısız oldu. 4: Görev akışı yürütüldü. 5: Görev akışı tamamlandı.	4
Message	string	Görevin açıklaması.	test
HistoryDagId	integer	Görev akışının önceden yayımlanmış sürümünün kimliği.	2****
DagName	string	Görev akışının adı.	Spark_SQL_test
OwnerName	string	Görev akışı sahibinin adı.	test_name
DagVersion	string	Görev akışının sürümü.	[]
TotalCount	integer	Döndürülen toplam yürütme kaydı sayısı.	1

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.