全部產品
Search
文件中心

:ListDataAgents

更新時間:Nov 03, 2026

查詢當前帳號下的 DataAgent 列表,支援按關鍵字模糊過濾,並按建立時間從新到舊分頁返回。

介面說明

過濾

  • keyword 為子字串匹配、大小寫不敏感,同時匹配名稱、顯示名稱與描述中的任意一項;搜尋詞中的 % 與 _ 按字面量處理,不作為萬用字元。

排序與分頁

  • 結果按建立時間從新到舊排列。

  • 翻頁使用游標 nextToken:把上一次回應返回的 nextToken 原樣回傳即可取得下一頁;回應中不含 nextToken 表示已經沒有下一頁。該值是不透明字串,請勿解析或自行構造。

  • maxResults 超出取值範圍時,伺服器端會靜默截斷到邊界值,不會回報錯誤。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

log:ListDataAgents

list

*All Resource

*

無 無

請求文法

GET /dataagents HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

keyword

string

否

模糊過濾的搜尋詞(子字串匹配,大小寫不敏感),同時匹配名稱、顯示名與描述三者中的任意一項,最長 256 個字元(按字元數計算,非位元組數)。不傳遞則不過濾。

Order

nextToken

string

否

翻頁遊標,取上一次回應返回的 nextToken 原樣回傳;首頁不傳遞。該值為不透明字串,格式屬實作細節,請勿解析或構造。

MjAyNi0wOC0xNFQxMDowMDowM1oAbXktYWdlbnQ

maxResults

integer

否

本次返回的最大筆數,取值範圍 1~100。超出範圍時伺服器端截斷到邊界值。

100

返回參數

名稱

類型

描述

樣本值

object

回應主體。返回符合條件的 DataAgent 列表。

items

array<object>

DataAgent 列表,按建立時間從新到舊排列。沒有匹配結果時返回空陣列。

object

單一 DataAgent 的設定資訊。

contextModels

array

該 DataAgent 關聯的上下文模型名稱列表。

string

單一上下文模型的名稱。

order-context

createdAt

string

建立時間,UTC 時區的 ISO8601 格式,精確到秒。

2026-08-14T10:00:03Z

description

string

DataAgent 的描述。未設定時返回空字串。

Responsible for analyzing order and revenue-related logs and outputting daily summary reports

displayName

string

顯示名稱。未設定時返回空字串 ""(不會回填成 name),顯示時請按 displayName || name 回退。

Order Analysis Assistant

name

string

DataAgent 的名稱。

order-analysis-agent

roleArn

string

DataAgent 扮演的 RAM 角色 ARN。

acs:ram::123456789012****:role/sls-dataagent-role

systemPrompt

string

DataAgent 的系統提示詞。未設定時返回空字串。

You are a data analysis assistant for the order domain. Only answer questions related to orders and revenue. If unsure, explain the reason instead of guessing

updatedAt

string

最近一次更新的時間,格式同 createdAt。

2026-08-15T09:20:31Z

nextToken

string

下一頁的翻頁遊標。已到最後一頁時不返回該欄位,此時無需繼續請求。

MjAyNi0wOC0xNFQxMDowMDowM1oAbXktYWdlbnQ

樣本

正常返回樣本

JSON格式

{
  "items": [
    {
      "contextModels": [
        "order-context"
      ],
      "createdAt": "2026-08-14T10:00:03Z",
      "description": "Responsible for analyzing order and revenue-related logs and outputting daily summary reports",
      "displayName": "Order Analysis Assistant",
      "name": "order-analysis-agent",
      "roleArn": "acs:ram::123456789012****:role/sls-dataagent-role",
      "systemPrompt": "You are a data analysis assistant for the order domain. Only answer questions related to orders and revenue. If unsure, explain the reason instead of guessing",
      "updatedAt": "2026-08-15T09:20:31Z"
    }
  ],
  "nextToken": "MjAyNi0wOC0xNFQxMDowMDowM1oAbXktYWdlbnQ"
}

錯誤碼

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

變更歷史

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