UpdateDigitalEmployee - STAROps - Alibaba Cloud Documentation Center

Updates a digital employee.

Operation description

Updates 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:UpdateDigitalEmployee

update

*DigitalEmployee

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

None

Request syntax

PATCH /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
body	object	No	The digital employee struct.
defaultRule	string	No	The default rule of the digital employee.	test
description	string	No	The description of the digital employee.	test
displayName	string	No	The display name of the digital employee.	test
roleArn	string	No	The ARN of the RAM role.	acs:ram::12345678912:role/testrole
knowledges	object	No	The knowledge base list.
bailian	array<object>	No	The Bailian knowledge base list.
	object	No	The Bailian knowledge base list.
workspaceId	string	No	The Bailian workspace ID.	llm-xxxx
indexId	string	No	The Bailian index ID.	index-xxxx
region	string	No	The region of the knowledge base.	cn-beijing
attributes	string	No	The knowledge base attributes.	test
sop	array<object>	No	The SOP knowledge base list.
	object	No	The SOP knowledge base.	{ "type": "oss", "basePath": "docs/", "region": "cn-hangzhou", "endpoint": "oss-cn-hangzhou.aliyuncs.com", "bucket": "my-sop-bucket", "description": "sls sop" }
attributes	object	No	The attributes.
	string	No	The attributes.	{}
toolPolicy	object	No	The tool calling security policy configuration of the digital employee.	{"aliyun":{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}}
aliyun	object	No	The Aliyun CLI tool calling security policy configuration.	{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}
enable	boolean	No	Specifies whether to enable the policy.	true
statements `deprecated`	array<object>	No	The list of Aliyun CLI tool policy statements.	[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]
	object	No	The list of Aliyun CLI tool policy statements.	{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}
decision	string	No	The execution policy.	user_ack
product	string	No	The cloud product code.	Cms
apiVersion `deprecated`	string	No	[Deprecated] The API version.	2024-03-30
actions	array	No	RAM action	["log:GetProject","log:CreateDashboard"]
	string	No	RAM action	cms:GetWorkspace
denyPolicy	array	No	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 operations are actively denied. STAROps directly denies matched actions. Pop performs secondary enforcement.	["ecs:RunCommand","ecs:Delete*"]
	string	No	The denied RAM Action in the format of , product:ApiName, or product:Prefix.	ecs:Delete*
autoPassPolicy	array	No	The automatic pass-through policy. Each entry is a RAM Action string in the format of product:ApiName, product:Prefix, or product:. Matched actions are automatically allowed without human confirmation. If this parameter is empty or not configured, built-in read-only actions (Get, List, Describe*) are automatically allowed. Unmatched actions require human-in-the-loop (HIL) confirmation.	["log:Get","log:List"]
	string	No	The automatically allowed RAM Action in the format of , product:ApiName, or product:Prefix.	log:Get*
sandboxNetworkPolicy	object	No	The list of CIDRs or IP addresses that are allowed to be accessed.	{"allowFqdns":["api.example.com"],"allowCidrs":["1.2.3.0/24","8.8.8.8"],"enableAcl":false}
allowFqdns	array	No	The list of FQDNs that are allowed to be accessed.
	string	No	The list of FQDNs that are allowed to be accessed.	api.example.com
allowCidrs	array	No	The list of CIDRs or IP addresses that are allowed to be accessed.
	string	No	The list of CIDRs or IP addresses that are allowed to be accessed.	8.8.8.8
enableAcl	boolean	No	Specifies whether to enable the sandbox network ACL.	false

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	0CEC5375-C554-562B-A65F-***

Examples

Success response

JSON format

{
  "requestId": "0CEC5375-C554-562B-A65F-***\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.