Panggil GetDag untuk mengkueri informasi DAG - DataWorks - Alibaba Cloud - DataWorks

Mengkueri informasi tentang graf asiklik terarah (DAG). Anda dapat memanggil operasi GetDag untuk mengkueri informasi DAG untuk alur kerja yang dipicu secara manual, node yang dipicu secara manual, atau instans pengisian ulang data. Namun, Anda tidak dapat mengkueri informasi DAG untuk node yang dipicu secara otomatis atau alur kerja yang dipicu secara otomatis.

Deskripsi operasi

Supported DAG types:

MANUAL: DAG for a manually triggered workflow
SMOKE_TEST: DAG for a smoke testing workflow
SUPPLY_DATA: DAG for a data backfill instance
BUSINESS_PROCESS_DAG: DAG for a one-time workflow

Supported DAG states:

CREATED: The DAG is created.
RUNNING: The DAG is running.
FAILURE: The DAG fails to run.
SUCCESS: The DAG is successfully run.

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

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DagId	integer	Yes	ID DAG. Anda dapat menggunakan salah satu metode berikut untuk mendapatkan ID: Panggil operasi RunCycleDagNodes dan dapatkan nilai parameter respons Data. Panggil operasi RunSmokeTest dan dapatkan nilai parameter respons Data. Panggil operasi RunManualDagNodes dan dapatkan nilai parameter respons DagId.	123141452344525
ProjectEnv	string	Yes	Lingkungan ruang kerja. Nilai valid: PROD dan DEV.	PROD

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	7782a299-b291-4fee-8424-cf8058efa8e8
ErrorMessage	string	The error message.	The connection does not exist.
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request was successful.	true
Data	object	The details of the DAG.
Type	string	The type of the DAG. Valid values: MANUAL, SMOKE_TEST, SUPPLY_DATA, and BUSINESS_PROCESS_DAG. The value MANUAL indicates the DAG for a manually triggered workflow. The value SMOKE_TEST indicates the DAG for a smoke testing workflow. The value SUPPLY_DATA indicates the DAG for a data backfill instance. The value BUSINESS_PROCESS_DAG indicates the DAG for a one-time workflow.	MANUAL_FLOW
Status	string	The status of the DAG. Valid values: CREATED, RUNNING, FAILURE, and SUCCESS.	FAILURE
FinishTime	integer	The time when the DAG finished running.	1605052800000
CreateTime	integer	The time when the DAG was created.	1605052800000
ProjectId	integer	The workspace ID.	112345
DagId	integer	The DAG ID.	351249682
Gmtdate	integer	The time when the DAG was scheduled to run.	1605052800000
StartTime	integer	The time when the DAG started to run.	1605052800000
CreateUser	string	The creator.	1736629400048545
Bizdate	integer	The data timestamp.	1605052800000
Name	string	The name of the DAG.	test_dag
ModifyTime	integer	The time when the DAG was last modified.	1605052800000
OpSeq	integer	The sequence number of the operation.	123

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "7782a299-b291-4fee-8424-cf8058efa8e8",
  "ErrorMessage": "The connection does not exist.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "Type": "MANUAL_FLOW",
    "Status": "FAILURE",
    "FinishTime": 1605052800000,
    "CreateTime": 1605052800000,
    "ProjectId": 112345,
    "DagId": 351249682,
    "Gmtdate": 1605052800000,
    "StartTime": 1605052800000,
    "CreateUser": "1736629400048545",
    "Bizdate": 1605052800000,
    "Name": "test_dag",
    "ModifyTime": 1605052800000,
    "OpSeq": 123
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.