転送セッションで現在実行中のターンをキャンセルします。
リクエストヘッダー
|
ヘッダー |
必須 |
説明 |
|
|
はい |
|
|
|
いいえ |
安全でないリクエストに対する、オプションのべき等性キーです。 |
パスパラメーター
|
パラメーター |
型 |
必須 |
説明 |
|
|
string |
はい |
セッション ID。 |
リクエスト例
curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/sessions/sess_xxx/cancel' \
-H "Authorization: Bearer $QODER_PAT"
レスポンス例
HTTP 202 Accepted
{
"id": "sess_xxx",
"type": "session",
"status": "canceling"
}
レスポンスフィールド
|
フィールド |
型 |
説明 |
|
|
string |
セッション ID。 |
|
|
string |
常に |
|
|
string |
キャンセルが受け付けられた場合は |
エラー
|
HTTP |
型 |
コード |
トリガー |
|
401 |
|
|
PAT が無効か、または期限切れです。 |
|
404 |
|
|
セッションが存在しません。 |
|
409 |
|
|
セッションはアーカイブ済みです。 |
|
502 |
|
|
ランタイムセッションサービスが利用不可です。 |
注意事項
-
202 Acceptedは、キャンセルがリクエストされたことを意味します。 -
200 OKは、キャンセル対象の現在実行中のターンがなかったことを意味します。 -
完了は、イベントストリームまたはセッションステータスのポーリングによって確認してください。