DescribeExecution - CloudFlow

Menanyakan status suatu execution. Operasi ini mendukung long polling, dengan parameter WaitTimeSeconds yang menentukan waktu tunggu maksimum.

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:DescribeExecution

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
FlowName	string	Yes	Nama flow.	my_flow_name
ExecutionName	string	Yes	Nama execution.	my_exec_name
WaitTimeSeconds	integer	No	Waktu tunggu maksimum untuk permintaan long polling, dalam detik. Nilai yang valid: 0 hingga 60. 0: Permintaan langsung mengembalikan status saat ini dari execution. Nilai lebih besar dari 0: Permintaan menunggu di server hingga execution selesai. Waktu tunggu maksimum adalah nilai yang Anda tentukan.	20

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
Status	string	Status execution. Nilai yang valid: Starting Running Stopped Succeeded Failed TimedOut	Succeeded
StoppedTime	string	Waktu saat execution berhenti.	2019-01-01T01:01:01.001Z
RequestId	string	ID permintaan.	testRequestId
StartedTime	string	Waktu saat execution dimulai.	2019-01-01T01:01:01.001Z
FlowDefinition	string	Definisi flow yang dieksekusi.	旧版： "type: flow\nversion: v1\nname: my_flow_name\nsteps:\n - type: pass\n name: mypass" 新版： "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 dari execution, dalam format JSON.	{"key":"value"}
FlowName	string	Nama flow.	my_flow_name
Name	string	Nama execution.	my_exec_name
Input	string	Input dari execution, dalam format JSON.	{"key":"value"}
Environment	object	Daftar variabel lingkungan yang digunakan selama eksekusi flow.
Variables	array<object>	Daftar variabel lingkungan yang digunakan selama eksekusi flow.
	object	Daftar variabel yang dapat diakses selama eksekusi flow.
Name	string	Nama variabel.	key
Value	string	Nilai variabel.	value

Contoh

Respons sukses

JSONformat

{
  "Status": "Succeeded",
  "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\"}",
  "Environment": {
    "Variables": [
      {
        "Name": "key",
        "Value": "value"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.

HTTP status code	Error code	Error message	Description
400	InvalidArgument	Parameter error.	Parameter error.
400	MissingRequiredHeader	The HTTP header '%s' must be specified.	The HTTP header '%s' must be specified.
400	MissingRequiredParams	The HTTP query '%s' must be specified.	The HTTP query '%s' must be specified.
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).	The payload size exceeds maximum allowed size (%s bytes).
412	PreconditionFailed	The resource to be modified has been changed.	The resource to be modified has been changed. Please try again later.
500	InternalServerError	An internal error has occurred. Please retry.	An internal error has occurred. Please retry.
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.	The AccessKey ID %s is invalid.
403	RequestTimeTooSkewed	The difference between the request time %s and the current time %s is too large.	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.	The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm.
403	AccessDenied	The resources doesn't belong to you.
404	ExecutionNotExists	Execution %s for flow %s does not exist.	Execution %s for flow %s does not exist.
404	FlowNotExists	Flow %s does not exist.	Flow %s does not exist.
415	UnsupportedMediaType	The content type must be "application/json".	The content type must be "application/json".
429	ResourceThrottled	The request is throttled. Please try again later.	The request is throttled. Please try again later.