ListAgents - 查詢Agent列表 - DataWorks

介面說明

請求說明

該介面用於查詢當前租戶下所有可用的 Agent。
支援通過agentName參數進行精確匹配過濾。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListAgents

list

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Jsonrpc	string	否	JSON-RPC 版本，固定 2.0	2.0
Id	string	否	請求方傳入的 id，原樣回顯	4as3dasf654a
Params	object	否	此次請求的具體參數內容
AgentName	string	否	Agent 名稱精確過濾；不傳時返回所有 Agent	chat_cli_chatbi
MaxResults	integer	否	單頁條數；預設 50	100
NextToken	string	否	下一頁 token，阿里雲 OpenAPI 規範；首頁不傳，翻頁時傳上一頁返回的 nextToken	0

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	4003B739-C33C-5297-B810-0490EEE5A767
JsonRpcResponse	object	符合 Jsonrpc 規範的返回結果對象
Jsonrpc	string	JSON-RPC 版本，固定 2.0	2.0
Id	string	請求方傳入的 id，原樣回顯	70623e38-a889-4192-930a-752ffdd75f48
Result	object	Agent 分頁查詢結果
TotalCount	integer	匹配到的 Agent 總數	27
MaxResults	integer	實際生效的單頁條數	100
NextToken	string	下一頁 token，末頁或無資料時為 null	2
Agents	array<object>	Agent 列表
	object
AgentName	string	Agent 名稱	chat_cli_chatbi

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4003B739-C33C-5297-B810-0490EEE5A767",
  "JsonRpcResponse": {
    "Jsonrpc": "2.0",
    "Id": "70623e38-a889-4192-930a-752ffdd75f48",
    "Result": {
      "TotalCount": 27,
      "MaxResults": 100,
      "NextToken": "2",
      "Agents": [
        {
          "AgentName": "chat_cli_chatbi"
        }
      ]
    }
  }
}

錯誤碼

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

變更歷史

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