Gunakan ListBusiness API untuk menanyakan workflow-DataWorks-Alibaba Cloud -

Menanyakan daftar alur kerja.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectId	integer	No	ID ruang kerja DataWorks. Anda dapat masuk ke konsol DataWorks dan membuka halaman Manajemen Ruang Kerja untuk memperoleh ID ruang kerja. Anda harus mengonfigurasi parameter ini atau parameter ProjectIdentifier untuk menentukan ruang kerja DataWorks tempat operasi diterapkan.	10000
ProjectIdentifier	string	No	Nama ruang kerja DataWorks. Anda dapat masuk ke konsol DataWorks dan membuka halaman Manajemen Ruang Kerja untuk memperoleh nama ruang kerja. Anda harus mengonfigurasi parameter ini atau parameter ProjectId untuk menentukan ruang kerja DataWorks tempat operasi diterapkan.	dw_project
PageNumber	integer	Yes	Nomor halaman yang akan dikembalikan.	1
PageSize	integer	Yes	Jumlah entri yang akan dikembalikan pada setiap halaman. Nilai default: 10. Nilai maksimum: 100.	10
Keyword	string	No	Kata kunci yang digunakan untuk melakukan pencocokan fuzzy.	my

Elemen respons

Element	Type	Description	Example
	object
HttpStatusCode	integer	Kode status HTTP yang dikembalikan.	200
ErrorMessage	string	Pesan kesalahan yang dikembalikan.	The connection does not exist.
RequestId	string	ID permintaan. Anda dapat menggunakan ID tersebut untuk memecahkan masalah.	0000-ABCD-EFG****
ErrorCode	string	Kode kesalahan yang dikembalikan.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Menunjukkan apakah permintaan berhasil.	true
Data	object	Informasi tentang alur kerja yang dikembalikan.
PageNumber	integer	Nomor halaman dari halaman yang dikembalikan.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
TotalCount	integer	Jumlah total entri yang dikembalikan.	13
Business	array<object>	Detail alur kerja.
	object
Owner	string	The owner of the workflow.	34824327****
Description	string	The description of the workflow.	My first workflow
ProjectId	integer	The ID of the workspace to which the workflow belongs.	10000
BusinessId	integer	The ID of the workflow.	3000001
BusinessName	string	The name of the workflow.	My first workflow
UseType	string	The module to which the workflow belongs. Valid values: NORMAL and MANUAL_BIZ. The value NORMAL indicates that the workflow belongs to auto triggered workflows. The value MANUAL_BIZ indicates that the workflow belongs to manually triggered workflows.	NORMAL

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Business": [
      {
        "Owner": "34824327****",
        "Description": "我的第一个业务流程",
        "ProjectId": 10000,
        "BusinessId": 3000001,
        "BusinessName": "我的第一个业务流程",
        "UseType": "NORMAL"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.