すべてのプロダクト
Search

このプロダクト

    DataWorks:CancelAgentSession

    ドキュメントセンター

    DataWorks:CancelAgentSession

    最終更新日:Sep 03, 2026

    指定された会話のエージェント呼び出しを中断します。ストリーミング応答中の中断もサポートしています。

    操作説明

    リクエストの説明

    • この操作は、主に進行中の会話を能動的に中断するために使用されます。特に、会話がストリーミング応答状態にある場合に有効です。

    • sessionId は必須パラメーターで、キャンセル対象の特定の会話を識別します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:CancelAgentSession

    none

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Jsonrpc

    string

    任意

    JSON-RPC バージョン。固定値: 2.0。

    2.0
    Id

    string

    任意

    リクエストによって渡される ID。応答でそのまま返されます。

    676303114031776
    Params

    object

    任意

    リクエストのビジネスパラメーター。

    SessionId

    string

    任意

    キャンセルする会話の ID。このパラメーターは必須です。

    sess_0f12abc34

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ。

    RequestId

    string

    リクエストの ID。

    7CD3D216-5876-5DB1-A34A-396806F4A413
    JsonRpcResponse

    object

    JSON-RPC 応答。

    Jsonrpc

    string

    JSON-RPC バージョン。固定値: 2.0。

    2.0
    Id

    string

    リクエストによって渡される ID。応答でそのまま返されます。

    7675839888324361477
    Result

    object

    会話キャンセルの結果オブジェクト。

    SessionId

    string

    キャンセルされたセッション ID です。

    session-d5d549fe4c2c4180a9814fb74190f502

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "7CD3D216-5876-5DB1-A34A-396806F4A413",
  "JsonRpcResponse": {
    "Jsonrpc": "2.0",
    "Id": "7675839888324361477",
    "Result": {
      "SessionId": "session-d5d549fe4c2c4180a9814fb74190f502"
    }
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。