ListDigitalEmployees - 列出数字员工

更新时间:
复制为 MD 格式

列出数字员工

接口说明

列出数字员工

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
starops:ListDigitalEmployeeslist
*DigitalEmployee
acs:starops:{#regionId}:{#accountId}:digitalemployee/*

请求语法

GET /digital-employee HTTP/1.1

请求参数

名称类型必填描述示例值
maxResultsinteger

分页大小 默认值: 20 最大值: 100

10
nextTokenstring

下一次查询的令牌。

xxxxxx
namestring

数字员工名称。

test
employeeTypestring

数字员工类型。

custom
displayNamestring

数字员工显示名称。

test
tagsarray

标签

Tag

标签

resourceGroupIdstring

资源组 ID

rg-ae******ey

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID。

8FDE2569-626B-5176-9844-28877A*****
nextTokenstring

下一次查询的令牌。

xxxxx
totalinteger

总记录数

56
maxResultsinteger

最大返回结果数

10
digitalEmployeesarray<object>

数字员工列表

DigitalEmployeesobject

数字员工

namestring

数字员工名称。

test
defaultRulestring

数字员工默认规则。

test
descriptionstring

数字员工描述信息。

test
createTimestring

创建时间。

2025-11-04T08:08:57Z
displayNamestring

数字员工显示名称。

test
updateTimestring

修改时间。

2025-05-07T02:26:01Z
roleArnstring

RAM 角色 ARN。

acs:ram::12345678912:role/testrole
knowledgesobject

知识库列表

bailianarray<object>

百练知识库列表。

bailianobject

百练知识库列表。

workspaceIdstring

百练工作空间 ID。

llm-xxxx
indexIdstring

百练索引 ID。

index-xxxx
regionstring

知识库地域。

cn-beijing
attributesstring

知识库属性。

test
soparray<object>

SOP 知识库列表

sopobject

SOP 知识库

{ "type": "oss", "basePath": "docs/", "region": "cn-hangzhou", "endpoint": "oss-cn-hangzhou.aliyuncs.com", "bucket": "my-sop-bucket", "description": "sls sop" }
employeeTypestring

数字员工类型。

custom
resourceGroupIdstring

资源组 ID

rg-ae******ey
tagsarray

标签

tagsTag

标签

attributesobject

属性

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": ""
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2026-05-14OpenAPI 返回结构发生变更查看变更详情
2026-05-06新增 OpenAPI查看变更详情