DescribeExecution - 擷取一次執行的狀態資訊 - CloudFlow

擷取一次執行的狀態資訊，支援長輪詢模式，長輪詢最長等待時間由 WaitTimeSeconds 參數指定。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

fnf:DescribeExecution

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
FlowName	string	是	流程名稱。	my_flow_name
ExecutionName	string	是	執行名稱。	my_exec_name
WaitTimeSeconds	integer	否	請求長輪詢的最長等待時間。取值範圍[0,60]，單位為秒。取值說明如下：取值等於 0：請求立即返回當前執行狀態。取值大於 0：請求在服務端長輪詢等待執行結束，最長等待設定的秒數。	20

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
Status	string	執行狀態。取值說明如下： Starting Running Stopped Succeeded Failed TimedOut	Succeeded
StoppedTime	string	執行停止時間。	2019-01-01T01:01:01.001Z
RequestId	string	請求 ID。	testRequestId
StartedTime	string	執行開始時間。	2019-01-01T01:01:01.001Z
FlowDefinition	string	執行的流程定義。	舊版： "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	執行的輸出，為 JSON 對象格式。	{"key":"value"}
FlowName	string	流程名稱。	my_flow_name
Name	string	執行名稱。	my_exec_name
Input	string	執行的輸入，為 JSON 對象格式。	{"key":"value"}
Environment	object	Flow 執行時使用的環境變數列表
Variables	array<object>	Flow 執行時使用的環境變數列表
	object	Flow 執行期間可以訪問的變數列表
Name	string	變數名稱	key
Value	string	變數值	value

樣本

正常返回樣本

JSON格式

{
  "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"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidArgument	Parameter error.	請求參數錯誤。具體內容請參考實際錯誤資訊。
400	MissingRequiredHeader	The HTTP header '%s' must be specified.	請求所需參數缺失。具體內容請參考實際錯誤資訊。
400	MissingRequiredParams	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).	請求訊息體過大。
412	PreconditionFailed	The resource to be modified has been changed.	資源查看或更新檢查失敗，該資源可能已被更改。請稍後重試。
500	InternalServerError	An internal error has occurred. Please retry.	伺服器內部錯誤。請稍後重試。
403	InvalidAccessKeyID	The AccessKey ID %s is invalid.	AccessKey ID無效。
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.	您發起請求的簽名與我們計算不一致，請檢查您的簽名演算法及AccessKey Secret。
403	AccessDenied	The resources doesn't belong to you.
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.	因某些原因系統流量已達瓶頸。請稍後重試。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。