CancelAgentSession - DataWorks

介面說明

請求說明

該介面主要用於使用者主動中斷正在進行中的會話，特別是當會話處於串流回應狀態時。
sessionId 是必要參數，用來標識要取消的具體會話。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

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	Schema of Response
RequestId	string	Id of the request	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

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

變更歷史

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