GetDigitalEmployee - STAROps - Alibaba Cloud Documentation Center

Retrieves a digital employee.

Operation description

Retrieves a digital employee.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

starops:GetDigitalEmployee

get

*DigitalEmployee

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
name	string	Yes	The name of the digital employee.	test

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
attributes	object	The attributes.
	string	The attributes.	{}
channel	string	The channel type.	default
createTime	string	The creation time.	2025-03-11T08:21:58Z
defaultRule	string	The default rule of the digital employee.	test
description	string	The description of the digital employee.	test
displayName	string	The display name of the digital employee.	test
employeeType	string	The type of the digital employee.	custom
knowledges	object	The knowledge base list.
bailian	array<object>	The Bailian knowledge base list.
	object	The Bailian knowledge base list.
attributes	string	The knowledge base attributes.	test
indexId	string	The Bailian index ID.	index-xxxx
region	string	The region of the knowledge base.	cn-beijing
workspaceId	string	The Bailian workspace ID.	llm-xxxxx
sop	array<object>	The SOP knowledge base list.
	object	The SOP knowledge base.	{ "type": "oss", "basePath": "docs/", "region": "cn-hangzhou", "endpoint": "oss-cn-hangzhou.aliyuncs.com", "bucket": "my-sop-bucket", "description": "sls sop" }
name	string	The name of the digital employee.	test
regionId	string	The region ID.	cn-beijing
requestId	string	The request ID.	0B9377D9-C56B-5C2E-A8A4-************
resourceGroupId	string	The resource group ID.	rg-ae******ey
roleArn	string	The Alibaba Cloud Resource Name (ARN) of the RAM role.	acs:ram::12345678912:role/testrole
sandboxNetworkPolicy	object	The sandbox network ACL policy configuration of the digital employee.	{"allowFqdns":["api.example.com"],"allowCidrs":["1.2.3.0/24","8.8.8.8"],"enableAcl":false}
allowCidrs	array	The list of allowed CIDRs or IP addresses.
	string	The list of allowed CIDRs or IP addresses.	1.2.3.0/24
allowFqdns	array	The list of allowed FQDNs.
	string	The list of allowed FQDNs.	api.example.com
enableAcl	boolean	Indicates whether the sandbox network ACL is enabled.	false
tags	array	The tags.
	Tag	The tags.
toolPolicy	object	The tool policy.	{"aliyun":{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}}
aliyun	object	The security policy configuration for Alibaba Cloud CLI tool calling invokes.	{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}
autoPassPolicy	array	The auto-pass policy. Each entry is a RAM Action string in the format of product:ApiName, product:Prefix, or product:. Matched actions are automatically approved without human confirmation. If this parameter is empty or not configured, built-in read-only actions (Get, List, Describe*) are automatically approved. Unmatched actions require human-in-the-loop (HIL) confirmation.	["log:Get","log:List"]
	string	The auto-pass RAM Action in the format of , product:ApiName, or product:Prefix.	log:Get*
denyPolicy	array	The explicit deny policy with the highest priority. Each entry is a RAM Action string in the format of product:ApiName, product:Prefix, or product:. If this parameter is empty or not configured, no actions are actively denied. STAROps directly denies matched actions. The Pop side performs secondary fallback enforcement.	["ecs:RunCommand","ecs:Delete*"]
	string	The denied RAM Action in the format of , product:ApiName, or product:Prefix.	ecs:Delete*
enable	boolean	Indicates whether the policy is enabled.	true
statements `deprecated`	array<object>	The list of Alibaba Cloud CLI tool policy statements.	[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]
	object	[Deprecated]	{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}
actions	array	The list of RAM actions.	["log:GetProject","log:CreateDashboard"]
	string	RAM action	log:GetProject
apiVersion `deprecated`	string	The API version.	2020-12-30
decision	string	The execution policy. Valid values: allow : allow user_ack : user_ack	user_ack
product	string	The cloud product code.	Sls
updateTime	string	The modification time.	2025-02-18T02:25:06Z

Examples

Success response

JSON format

{
  "attributes": {
    "key": "{}"
  },
  "channel": "default",
  "createTime": "2025-03-11T08:21:58Z\n",
  "defaultRule": "test",
  "description": "test",
  "displayName": "test",
  "employeeType": "custom",
  "knowledges": {
    "bailian": [
      {
        "attributes": "test",
        "indexId": "index-xxxx\n",
        "region": "cn-beijing\n",
        "workspaceId": "llm-xxxxx\n"
      }
    ],
    "sop": [
      {
        "type": "oss",
        "basePath": "docs/",
        "region": "cn-hangzhou",
        "endpoint": "oss-cn-hangzhou.aliyuncs.com",
        "bucket": "my-sop-bucket",
        "description": "sls sop"
      }
    ]
  },
  "name": "test",
  "regionId": "cn-beijing\n",
  "requestId": "0B9377D9-C56B-5C2E-A8A4-************\n",
  "resourceGroupId": "rg-ae******ey",
  "roleArn": "acs:ram::12345678912:role/testrole",
  "sandboxNetworkPolicy": {
    "allowCidrs": [
      "1.2.3.0/24"
    ],
    "allowFqdns": [
      "api.example.com"
    ],
    "enableAcl": false
  },
  "tags": [
    {
      "key": "test-key",
      "value": "test-value"
    }
  ],
  "toolPolicy": {
    "aliyun": {
      "autoPassPolicy": [
        "log:Get*"
      ],
      "denyPolicy": [
        "ecs:Delete*"
      ],
      "enable": true,
      "statements": [
        {
          "actions": [
            "log:GetProject"
          ],
          "apiVersion": "2020-12-30",
          "decision": "user_ack",
          "product": "Sls"
        }
      ]
    }
  },
  "updateTime": "2025-02-18T02:25:06Z\n"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDigitalEmployee.NotFound	The specified DigitalEmployee does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.