调用DescribeBot获取机器⼈详情

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeBot

系统规定参数。取值:DescribeBot。

InstanceId String chatbot-cn-7QuUfaqM

机器⼈ID

RegionId String ch-shanghai

访问控制策略组的地域ID,已开通:cn-shanghai

返回数据

名称 类型 示例值 描述
Avatar String http://test.oss-cn-beijing.aliyuncs.com/test.jpg

机器⼈头像的URL

Categories Array of Category

类⽬列表

CategoryId Long 2100073048

类⽬id

Name String test

类⽬名称

ParentCategoryId Long -1

父类目id

CreateTime String 2020-11-29T06:50:46Z

机器⼈创建的 UTC 时间

InstanceId String chatbot-cn-7QuUfaqM

公有云问答API,机器⼈唯⼀标识

Introduction String 测试用的

机器⼈备注

LanguageCode String zh-cn

机器⼈服务的语⾔,如zh-cn、 en-us

Logo String 返回值已下线,保持接口兼容因此字段保留

返回值已下线,保持接口兼容因此字段保留

Name String test

机器⼈名称

RequestId String BF736BAB-5AC0-4092-82A9-85475D39D1

请求id

TimeZone String Asia/Beijing

机器⼈的时区,参考《公共-时区码》

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBot
&InstanceId=chatbot-cn-7QuUfaqM
&<公共请求参数>

正常返回示例

XML 格式

<LanguageCode>zh-cn</LanguageCode>
<TimeZone>Asia/Beijing</TimeZone>
<RequestId>BF736BAB-5AC0-4092-82A9-85475D6F39D1</RequestId>
<InstanceId>chatbot-cn-7QuUfaqMQe</InstanceId>
<Introduction>测试用的</Introduction>
<Categories>
    <CategoryId>2100073048</CategoryId>
    <ParentCategoryId>-1</ParentCategoryId>
    <Name>test</Name>
</Categories>
<CreateTime>2020-11-29T06:50:46Z</CreateTime>
<Avatar>C:\Users\ypfyu\Pictures</Avatar>
<Name>test</Name>

JSON 格式

{
	"LanguageCode": "zh-cn",
	"TimeZone": "Asia/Beijing",
	"RequestId": "BF736BAB-5AC0-4092-82A9-85475F39D1",
	"InstanceId": "chatbot-cn-7QuUfaqM",
	"Introduction": "测试用的",
	"Categories": [
		{
			"CategoryId": 2100073048,
			"ParentCategoryId": -1,
			"Name": "test"
		}
	],
	"CreateTime": "2020-11-29T06:50:46Z",
	"Avatar": "http://test.oss-cn-beijing.aliyuncs.com/test.jpg",
	"Name": "test"
}

错误码

访问错误中心查看更多错误码。