この API では、ワークフローインスタンスを停止します。
デバッグ
リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 例 | 説明 |
---|---|---|---|---|
Action | String | 必須 | SuspendFlow |
実行する操作。 値を SuspendFlow に設定します。 |
FlowInstanceId | String | 必須 | FI-9DDAAA3ADA5F6FA2 |
ワークフローインスタンスの ID。 |
ProjectId | String | 必須 | FP-3535FE0BE5224A47 |
プロジェクトの ID。 |
RegionId | String | 必須 | cn-hangzhou |
プロジェクトが属するリージョンの ID。 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
Data | Boolean | true |
操作の結果。 |
RequestId | String | B46F8A2A-B46B-415C-8A9C-B01B99B775A2 |
リクエストの ID。 |
例
リクエスト
/? Action=SuspendFlow
&FlowInstanceId=FI-9DDAAA3ADA5F6FA2
&ProjectId=FP-3535FE0BE5224A47
&RegionId=cn-hangzhou
&<Common request parameters>
通常のレスポンス例
XML
形式
<SuspendFlowResponse>
<RequestId>B46F8A2A-B46B-415C-8A9C-B01B99B775A2</RequestId>
<Data>true</Data>
</SuspendFlowResponse>
JSON
形式
{
"Data":true,
"RequestId":"B46F8A2A-B46B-415C-8A9C-B01B99B775A2"
}
エラーコード
エラーコードについては、『API エラーセンター』をご参照ください。