ListWorkflowDefinitions - - Alibaba Cloud Dokümantasyon Merkezi

Veri geliştirme iş akışlarının sayfalara ayrılmış listesini sorgular. İş akışlarını belirtilen koşullara göre de filtreleyebilirsiniz.

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

dataworks:*

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	DataWorks çalışma alanının kimliği. Çalışma alanı kimliğini almak için DataWorks konsolunda oturum açabilir ve Çalışma Alanı Yapılandırması sayfasına gidebilirsiniz. Bu parametre, mevcut API çağrısı için DataWorks çalışma alanını belirtir.	10000
Type	string	No	İş akışının türü. Bu parametre filtre koşulu olarak kullanılır. Bu parametreyi belirtmezseniz varsayılan değer CycleWorkflow olur. Geçerli değerler: CycleWorkflow ManualWorkflow	CycleWorkflow
Owner	string	No	İş akışı sahibinin kimliği, çalışma alanı yöneticisi hesabının UID'sidir. Alibaba Cloud Yönetim Konsolunda oturum açarak Hesap Yönetimi altındaki Güvenlik Ayarları sayfasından hesap UID'sini görüntüleyebilirsiniz.	110755000425XXXX
Name	string	No	İş akışının adı. Bulanık arama desteklenir.	test
PageNumber	integer	No	Döndürülecek sayfanın numarası.	1
PageSize	integer	No	Her sayfada döndürülecek giriş sayısı. Varsayılan değer: 10. Maksimum değer: 100.	10

Response elements

Element	Type	Description	Example
	object	Yanıt şeması.
RequestId	string	İstek kimliği. Günlükleri bulmak ve sorunları gidermek için bu kimliği kullanabilirsiniz.	8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX
PagingInfo	object	Sayfalama bilgileri.
TotalCount	integer	Belirtilen koşulları karşılayan toplam giriş sayısı.	227
PageSize	integer	Her sayfada döndürülen giriş sayısı.	10
PageNumber	integer	Döndürülecek sayfanın numarası.	1
WorkflowDefinitions	array<object>	Sorgulanan iş akışlarının listesi.
	array<object>
ProjectId	integer	İş akışının ait olduğu DataWorks çalışma alanının kimliği.	4710
Owner	string	İş akışının sahibi.	110755000425XXXX
CreateTime	integer	İş akışının oluşturulduğu zaman damgası.	1698057323000
ModifyTime	integer	İş akışının en son değiştirildiği zaman damgası.	1698057323000
Description	string	İş akışının açıklaması.	Workflow description
Type	string	İş akışının türü. Geçerli değerler: CycleWorkflow ManualWorkflow	CycleWorkflow
Script	object	Betik bilgileri.
Path	string	Betiğin yolu.	XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo
Runtime	object	Çalışma zamanı.
Command	string	Komut.	WORKFLOW
Id	string	Betiğin kimliği. Önemli SDK sürüm 8.0.0'dan önce bu alan Long türündedir. SDK sürüm 8.0.0 ve sonrasında bu alan String türündedir. Bu değişiklik SDK'nın normal kullanımını etkilemez. Parametre hala SDK'da tanımlanan türe göre döndürülür. Ancak SDK'yı 8.0.0 sürümü üzerinden yükseltirseniz, tür değişikliği proje derleme hatalarına neden olabilir. Bu durumda veri türünü manuel olarak düzeltmeniz gerekir.	698002781368644XXXX
Name	string	İş akışının adı.	OpenAPI test workflow Demo
Id	string	İş akışının benzersiz tanımlayıcısı. Önemli SDK sürüm 8.0.0'dan önce bu alan Long türündedir. SDK sürüm 8.0.0 ve sonrasında bu alan String türündedir. Bu değişiklik SDK'nın normal kullanımını etkilemez. Parametre hala SDK'da tanımlanan türe göre döndürülür. Ancak SDK'yı 8.0.0 sürümü üzerinden yükseltirseniz, tür değişikliği proje derleme hatalarına neden olabilir. Bu durumda veri türünü manuel olarak düzeltmeniz gerekir.	463497880880954XXXX

Examples

Success response

JSON format

{
  "RequestId": "8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX",
  "PagingInfo": {
    "TotalCount": 227,
    "PageSize": 10,
    "PageNumber": 1,
    "WorkflowDefinitions": [
      {
        "ProjectId": 4710,
        "Owner": "110755000425XXXX",
        "CreateTime": 1698057323000,
        "ModifyTime": 1698057323000,
        "Description": "Workflow description",
        "Type": "CycleWorkflow",
        "Script": {
          "Path": "XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo",
          "Runtime": {
            "Command": "WORKFLOW"
          },
          "Id": "698002781368644XXXX"
        },
        "Name": "OpenAPI test workflow Demo",
        "Id": "463497880880954XXXX"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.