查询 DigitalEmployee。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
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 |
角色 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 |
rg-ae******ey |
示例
正常返回示例
JSON格式
{
"requestId": "0B9377D9-C56B-5C2E-A8A4-************",
"name": "test",
"defaultRule": "test",
"description": "test",
"createTime": "2025-03-11T08:21:58Z",
"displayName": "test",
"updateTime": "2025-02-18T02:25:06Z",
"roleArn": "acs:ram::12345678912:role/testrole",
"regionId": "cn-beijing",
"knowledges": {
"bailian": [
{
"workspaceId": "llm-xxxxx",
"indexId": "index-xxxx",
"region": "cn-beijing",
"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": "env",
"value": "test"
}
],
"resourceGroupId": "rg-ae******ey"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | InvalidDigitalEmployee.NotFound | The specified DigitalEmployee does not exist. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。