调用协议
请求
请求协议 | HTTPS |
---|---|
字符集编码 | UTF-8 |
请求域名
请求 URL
- 在具体 API 说明中会给出 URL 路径,也就是域名后面的部分,在 URL 路径前面拼接上具体区域的域名即为完整的请求 URL;
- 请参考 API 列表;
- 以请求中国区的 获取机器人信息 API 为例:
- URL 路径为:/v1/robot/robot_info
公共请求头
公共请求头 | 说明 |
---|---|
Authorization | 用于传递 API 的访问凭证,请参考 鉴权方法。 |
Content-Type |
|
响应
Content-Type | application/json |
---|---|
字符集编码 | UTF-8 |
公共响应体
参数 | 类型 | 参数说明 |
---|---|---|
code | int | 错误代码。0 是成功,非 0 是失败,请参考 错误代码。 |
msg | string | 错误描述,当失败的时候会给出具体的错误描述。 |
req_id | string | 日志跟踪 id,当遇到问题需要猎户星空协助查问题时候,请提供此跟踪 id 值。 |
data | object | 业务数据 data 对象,详见下述 响应体 data 对象。 |
响应体 data 对象
- 不同的 API 会有不同的响应体 data 对象,请参考具体的 API 说明;
公共响应体示例
{ "code": 0, "msg": "", "req_id": "test_req_id", "data": { // 不同的 API 会有不同的响应体 data 对象,请参考具体的 API 说明 } }