機能説明
指定したバッチタスクをキャンセルします。現在、Alibaba Cloud Qwenシリーズのモデルのみサポートしています。
呼び出し説明
インターフェース制約
- 呼び出し元はAPI Keyを保有している必要があります。詳細については、AI API Keyの管理をご参照ください。
リクエストパス
POST {BASE_URL}/api/v1/batches/{batch_id}/cancel
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| batch_id | string | はい | batch_abc123 | バッチタスクID |
Queryパラメータ
なし
Bodyパラメータ
なし
実行結果
パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうかを示します。 |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | ビジネスデータ |
dataフィールドの説明
名前 |
型 |
説明 |
|---|---|---|
| id | string | バッチタスクの一意のID |
| status | string | バッチタスクの状態 |
リクエスト例
curl --request POST '{BASE_URL}/api/v1/batches/batch_abc123/cancel' \
--header 'Authorization: Bearer {token}'
レスポンス例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "batch_abc123",
"status": "cancelled"
}
}