文档首页/ 园区智能体 CampusGo/ API参考/ 如何调用API/ 返回结果
更新时间：2022-01-13 GMT+08:00
查看PDF
分享

返回结果

请求发送以后，您会收到响应，包含：状态码、响应消息头和响应消息体。

状态码

状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。

对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-type”。

表1 公共响应消息头

消息头名称

描述

是否必选

Content-Type

用于指明发送给接收者的实体正文的媒体类型。

类型：字符串。

默认值：application/json; charset=UTF-8

是

X-request-id

此字段携带请求ID号，以便任务跟踪。

类型：字符串。request_id-timestamp-hostname（request_id在服务器端生成UUID， timestamp为当前时间戳，hostname为处理当前接口的服务器名称）。

默认值：无。

否

X-ratelimit

此字段携带总计流控请求数。

类型：整型。

默认值：无。

否

X-ratelimit-used

此字段携带剩下请求数。

类型：整型。

默认值：无。

否

X-ratelimit-window

此字段携带流控单位。

类型：字符串。单位按照分钟、小时、天。

默认值：小时。

否

对于获取用户Token接口，返回如下图所示的消息头。

其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

图1 获取用户Token响应消息头

响应消息体

响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。

对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

{
    "token": {
        "expires_at": "2019-02-13T06:52:13.855000Z",
        "methods": [
            "password"
        ],
        "catalog": [
            {
                "endpoints": [
                    {
                        "region_id": "cn-north-1",
......

当接口调用出错时，可根据返回的错误码及错误信息说明进行问题定位，如下所示。

{
    "error_msg": "The API does not exist or has not been publish in the environment",
    "error_code": "IVA.0101",
    "request_id": "8ec47b9ec686af9976bed342d5cd5e06"
}

其中，error_code表示错误码，error_msg表示错误描述信息，具体请参见错误码。

父主题： 如何调用API

相关文档