查询指定机器人下指定实体的meta信息,如:实体类型、实体名称、创建时间、修改时间等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AgentKey |
string |
否 |
业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取 |
ac627989eb4f8a98ed05fd098bbae5_p_beebot_public |
| InstanceId |
string |
是 |
机器人 ID |
chatbot-cn-yjzbyrEvqd |
| EntityId |
integer |
是 |
实体 ID |
123 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数说明 |
||
| RequestId |
string |
请求 ID |
ad23234dsf234fga |
| EntityId |
integer |
实体 ID |
123 |
| EntityName |
string |
实体名称,仅支持中文、大小写字母、数字、下划线 |
书类型 |
| SysEntityCode |
string |
系统实体 code,如 sys.date;用户实体时为空 |
sys.date |
| EntityType |
string |
实体类型:[synonyms(同义词),regex(正则)] |
synonyms |
| CreateTime |
string |
创建时间(UTC 时间) |
2021-08-12T16:00:01Z |
| ModifyTime |
string |
修改时间(UTC 时间) |
2021-08-12T16:00:01Z |
| CreateUserId |
string |
创建者 ID |
123231 |
| CreateUserName |
string |
创建人名称 |
test |
| ModifyUserId |
string |
修改人唯一标识 |
123231 |
| ModifyUserName |
string |
修改人名称 |
test |
如果是系统实体,SysEntityCode 返回系统实体 key,例如:@sys.date
示例
正常返回示例
JSON格式
{
"RequestId": "ad23234dsf234fga",
"EntityId": 123,
"EntityName": "书类型",
"SysEntityCode": "sys.date",
"EntityType": "synonyms",
"CreateTime": "2021-08-12T16:00:01Z",
"ModifyTime": "2021-08-12T16:00:01Z",
"CreateUserId": "123231",
"CreateUserName": "test",
"ModifyUserId": "123231",
"ModifyUserName": "test"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | BusinessErrorEntityId.NotExists | The business error EntityId is not exists. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。