GetDigitalEmployee - STAROps

取得數位員工。

介面說明

取得數位員工。

調試

您可以在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 CLI 工具呼叫安全性策略設定。	{"enable":true,"statements":[{"decision":"user_ack","product":"Sls","apiVersion":"2020-12-30","actions":["log:GetProject","log:CreateDashboard"]}]}
enable	boolean	是否啟用。	true
statements	array<object>	Aliyun CLI 工具策略語句清單。	[{"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	執行策略。枚舉值： allow : allow user_ack : user_ack	user_ack
product	string	雲端產品 CODE。	Sls
apiVersion `deprecated`	string	API 版本。	2020-12-30
actions	array	RAM action 清單。	["log:GetProject","log:CreateDashboard"]
	string	RAM action	log:GetProject
sandboxNetworkPolicy	object	數位員工沙箱網路 ACL 策略設定。	{"allowFqdns":["api.example.com"],"allowCidrs":["1.2.3.0/24","8.8.8.8"],"enableAcl":false}
allowFqdns	array	允許存取的 FQDN 清單。
	string	允許存取的 FQDN 清單。	api.example.com
allowCidrs	array	允許存取的 CIDR 或 IP 清單。
	string	允許存取的 CIDR 或 IP 清單。	1.2.3.0/24
enableAcl	boolean	是否啟用沙箱網路 ACL。	false

樣本

正常返回樣本

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"
          ]
        }
      ]
    }
  },
  "sandboxNetworkPolicy": {
    "allowFqdns": [
      "api.example.com"
    ],
    "allowCidrs": [
      "1.2.3.0/24"
    ],
    "enableAcl": false
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
404	InvalidDigitalEmployee.NotFound	The specified DigitalEmployee does not exist.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。