Gunakan StopExecution untuk menghentikan eksekusi alur - CloudFlow - Alibaba Cloud - CloudFlow

Menghentikan flow yang sedang berjalan.

Deskripsi operasi

Flow harus dalam status berjalan.

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

fnf:StopExecution

update

*Semua resource.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
FlowName	string	Yes	Nama flow yang akan dihentikan. Anda dapat memperoleh nama flow dari tanggapan operasi ListFlows.	my_flow_name
ExecutionName	string	Yes	Nama eksekusi yang akan dihentikan. Anda dapat memperoleh nama eksekusi dari tanggapan operasi ListExecutions.	my_exec_name
Cause	string	No	Penyebab kesalahan penghentian. Nilai harus memiliki panjang 1 hingga 4.096 karakter.	for test
Error	string	No	Kode kesalahan untuk operasi penghentian. Nilai harus memiliki panjang 1 hingga 128 karakter.	InvalidArgument

Elemen respons

Element	Type	Description	Example
	object	Data tanggapan.
Status	string	Status eksekusi. Nilai valid: Starting Running Stopped Succeeded Failed TimedOut	Running
StoppedTime	string	Waktu saat eksekusi dihentikan. Waktu ditampilkan dalam UTC dan mengikuti standar ISO 8601 dalam format YYYY-MM-DDThh:mm:ss.sssZ.	2019-01-01T01:01:01.001Z
RequestId	string	ID permintaan.	testRequestId
StartedTime	string	Waktu saat eksekusi dimulai. Waktu ditampilkan dalam UTC dan mengikuti standar ISO 8601 dalam format YYYY-MM-DDThh:mm:ss.sssZ.	2019-01-01T01:01:01.001Z
FlowDefinition	string	Definisi flow eksekusi.	Legacy: "type: flow\nversion: v1\nname: my_flow_name\nsteps:\n - type: pass\n name: mypass" New version: "Type: StateMachine\nSpecVersion: v1\nName: my_flow_name\nStartAt: my_state\nStates:\n - Type: Pass\n Name: my_state\n End: true"
Output	string	Output eksekusi, dalam format objek JSON.	{"key":"value"}
FlowName	string	Nama flow.	my_flow_name
Name	string	Nama eksekusi.	my_exec_name
Input	string	Input eksekusi, dalam format objek JSON.	{"key":"value"}
RoleArn	string	Konfigurasi izin peran untuk eksekusi. Jika RoleArn dalam definisi flow berubah selama eksekusi, sistem akan mencatat dan mengembalikan snapshot RoleArn pada waktu eksekusi dimulai. Catatan Jika tidak ada peran eksekusi yang dikonfigurasi untuk flow Anda selama eksekusi, bidang ini tidak akan dikembalikan.	acs:ram:${region}:${accountID}:${role}

Contoh

Respons sukses

JSONformat

{
  "Status": "Running",
  "StoppedTime": "2019-01-01T01:01:01.001Z",
  "RequestId": "testRequestId",
  "StartedTime": "2019-01-01T01:01:01.001Z",
  "FlowDefinition": "旧版：\n\"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n  - type: pass\\n    name: mypass\"\n\n新版：\n\"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n  - Type: Pass\\n    Name: my_state\\n    End: true\"",
  "Output": "{\"key\":\"value\"}",
  "FlowName": "my_flow_name",
  "Name": "my_exec_name",
  "Input": "{\"key\":\"value\"}",
  "RoleArn": "acs:ram:${region}:${accountID}:${role}"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	ActionNotSupported	The requested API operation '%s' is incorrect. Please check.
400	APIVersionNotSupported	The requested API version '%s' is not supported yet. Please check.
400	EntityTooLarge	The payload size exceeds maximum allowed size (%s bytes).
400	ExecutionAlreadyCompleted	Execution '%s' for flow '%s' has already completed.
400	InvalidArgument	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.
500	InternalServerError	An internal error has occurred. Please retry.
403	AccessDenied	The resources doesn't belong to you.
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.
403	RequestTimeTooSkewed	The difference between the request time %s and the current time %s is too large.
403	SignatureNotMatch	The request signature we calculated does not match the signature you provided. Check your access key and signing method.
404	ExecutionNotExists	Execution %s for flow %s does not exist.
404	FlowNotExists	Flow %s does not exist.
415	UnsupportedMediaType	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.
409	ConcurrentUpdateError	Update conflict, please retry.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.