ListDigitalEmployees - STAROps

列出數位員工。

介面說明

列出數位員工。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

starops:ListDigitalEmployees

list

*DigitalEmployee

acs:starops:{#regionId}:{#accountId}:digitalemployee/*

無

請求文法

GET /digital-employee HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
maxResults	integer	否	分頁大小預設值: 20 最大值: 100	10
nextToken	string	否	下一次查詢的權杖。	xxxxxx
name	string	否	數位員工名稱。	test
employeeType	string	否	數位員工類型。枚舉值： system : 系統內建數位員工。 custom : 自訂數位員工。	custom
channel	string	否	管道類型。	default
displayName	string	否	數位員工顯示名稱。	test
tags	array	否	標籤。
	Tag	否	標籤。
resourceGroupId	string	否	資源群組 ID。	rg-ae******ey

返回參數

名稱	類型	描述	樣本值
	object	介面傳回資料。
digitalEmployees	array<object>	數位員工清單。
	array<object>	數位員工。
attributes	object	數位員工屬性。	{"key":"value"}
	string	數位員工屬性值。	value
channel	string	管道類型。	default
createTime	string	建立時間，採用 RFC 3339 格式，時區為 UTC。	2025-11-04T08:08:57Z
defaultRule	string	數位員工預設規則。	test
description	string	數位員工描述資訊。	test
displayName	string	數位員工顯示名稱。	test
employeeType	string	數位員工類型。	custom
knowledges	object	知識庫清單。
bailian	array<object>	百鍊知識庫清單。
	object	百鍊知識庫清單。
attributes	string	知識庫屬性。	test
indexId	string	百鍊索引 ID。	index-xxxx
region	string	知識庫地域。	cn-beijing
workspaceId	string	百鍊工作空間 ID。	llm-xxxx
sop	array<object>	SOP 知識庫清單。
	object	SOP 知識庫。	{ "type": "oss", "basePath": "docs/", "region": "cn-hangzhou", "endpoint": "oss-cn-hangzhou.aliyuncs.com", "bucket": "my-sop-bucket", "description": "sls sop" }
name	string	數位員工名稱。	test
resourceGroupId	string	資源群組 ID。	rg-ae******ey
roleArn	string	RAM 角色 ARN。	acs:ram::12345678912:role/testrole
status	integer	數位員工狀態：0 表示正常，1 表示停用。	0
tags	array	標籤。
	Tag	標籤。
updateTime	string	修改時間，採用 RFC 3339 格式，時區為 UTC。	2025-05-07T02:26:01Z
maxResults	integer	最大傳回結果數。	10
nextToken	string	下一次查詢的權杖。	xxxxx
requestId	string	請求 ID。	8FDE2569-626B-5176-9844-28877A*****
total	integer	總記錄數。	56

樣本

正常返回樣本

JSON格式

{
  "digitalEmployees": [
    {
      "attributes": {
        "key": "value"
      },
      "channel": "default",
      "createTime": "2025-11-04T08:08:57Z\n",
      "defaultRule": "test",
      "description": "test",
      "displayName": "test",
      "employeeType": "custom",
      "knowledges": {
        "bailian": [
          {
            "attributes": "test",
            "indexId": "index-xxxx\n",
            "region": "cn-beijing\n",
            "workspaceId": "llm-xxxx\n"
          }
        ],
        "sop": [
          {
            "type": "oss",
            "basePath": "docs/",
            "region": "cn-hangzhou",
            "endpoint": "oss-cn-hangzhou.aliyuncs.com",
            "bucket": "my-sop-bucket",
            "description": "sls sop"
          }
        ]
      },
      "name": "test",
      "resourceGroupId": "rg-ae******ey",
      "roleArn": "acs:ram::12345678912:role/testrole\n",
      "status": 0,
      "tags": [
        {
          "key": "test-key",
          "value": "test-value"
        }
      ],
      "updateTime": "2025-05-07T02:26:01Z\n"
    }
  ],
  "maxResults": 10,
  "nextToken": "xxxxx",
  "requestId": "8FDE2569-626B-5176-9844-28877A*****\n",
  "total": 56
}

錯誤碼

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

變更歷史

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