GetDigitalEmployee - 获取数字员工-全域智能运维平台 STAROps(STAROps)-阿里云帮助中心

获取数字员工

接口说明

获取数字员工

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

starops:GetDigitalEmployee

get

*DigitalEmployee

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

无

请求语法

GET /digital-employee/{name} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
name	string	是	数字员工名称。	test

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID。	0B9377D9-C56B-5C2E-A8A4-************
name	string	数字员工名称。	test
defaultRule	string	数字员工默认规则。	test
description	string	数字员工描述信息。	test
createTime	string	创建时间。	2025-03-11T08:21:58Z
displayName	string	数字员工显示名称。	test
updateTime	string	修改时间。	2025-02-18T02:25:06Z
roleArn	string	RAM 角色 ARN。	acs:ram::12345678912:role/testrole
regionId	string	代表地域 ID 的资源属性字段。	cn-beijing
knowledges	object	知识库列表
bailian	array<object>	百练知识库列表。
	object	百练知识库列表。
workspaceId	string	百练工作空间 ID。	llm-xxxxx
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
tags	array	标签
	Tag	标签
resourceGroupId	string	资源组 ID	rg-ae******ey
attributes	object
	string
toolPolicy	object	数字员工工具调用安全策略配置。	{"aliyun":{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}}
aliyun	object	Aliyun MCP 工具调用安全策略配置。	{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}
enable	boolean	是否启用 Aliyun MCP 工具策略。	true
statements	array<object>	Aliyun OpenAPI 工具策略语句列表。	[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]
	object	单条 Aliyun OpenAPI 工具策略语句。	{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}
decision	string	命中该 API 后的执行策略。	user_ack
product	string	本条语句对应的 Aliyun OpenAPI 产品名。	Sls
apiVersion	string	本条语句对应的 Aliyun OpenAPI API 版本。	2020-12-30
actions	array	Aliyun OpenAPI Action 列表，格式为 product:ApiName、product:Prefix* 或 product:*。	["log:GetProject","log:CreateDashboard"]
	string		log:GetProject

示例

正常返回示例

JSON格式

{
  "requestId": "0B9377D9-C56B-5C2E-A8A4-************\n",
  "name": "test",
  "defaultRule": "test",
  "description": "test",
  "createTime": "2025-03-11T08:21:58Z\n",
  "displayName": "test",
  "updateTime": "2025-02-18T02:25:06Z\n",
  "roleArn": "acs:ram::12345678912:role/testrole",
  "regionId": "cn-beijing\n",
  "knowledges": {
    "bailian": [
      {
        "workspaceId": "llm-xxxxx\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",
  "tags": [
    {
      "key": "test-key",
      "value": "test-value"
    }
  ],
  "resourceGroupId": "rg-ae******ey",
  "attributes": {
    "key": ""
  },
  "toolPolicy": {
    "aliyun": {
      "enable": true,
      "statements": [
        {
          "decision": "user_ack",
          "product": "Sls",
          "apiVersion": "2020-12-30",
          "actions": [
            "log:GetProject"
          ]
        }
      ]
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDigitalEmployee.NotFound	The specified DigitalEmployee does not exist.

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

变更历史

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