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	否	数字员工类型。	custom
displayName	string	否	数字员工显示名称。	test
tags	array	否	标签
	Tag	否	标签
resourceGroupId	string	否	资源组 ID	rg-ae******ey

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID。	8FDE2569-626B-5176-9844-28877A*****
nextToken	string	下一次查询的令牌。	xxxxx
total	integer	总记录数	56
maxResults	integer	最大返回结果数	10
digitalEmployees	array<object>	数字员工列表
	array<object>	数字员工
name	string	数字员工名称。	test
defaultRule	string	数字员工默认规则。	test
description	string	数字员工描述信息。	test
createTime	string	创建时间。	2025-11-04T08:08:57Z
displayName	string	数字员工显示名称。	test
updateTime	string	修改时间。	2025-05-07T02:26:01Z
roleArn	string	RAM 角色 ARN。	acs:ram::12345678912:role/testrole
knowledges	object	知识库列表
bailian	array<object>	百练知识库列表。
	object	百练知识库列表。
workspaceId	string	百练工作空间 ID。	llm-xxxx
indexId	string	百练索引 ID。	index-xxxx
region	string	知识库地域。	cn-beijing
attributes	string	知识库属性。	test
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" }
employeeType	string	数字员工类型。	custom
resourceGroupId	string	资源组 ID	rg-ae******ey
tags	array	标签
	Tag	标签
attributes	object
	string

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。