更新时间:2024-12-02 GMT+08:00
返回结果
状态码
请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。
状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。
对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。
响应消息头
对应请求消息头,响应同样也有消息头,如“Content-type”。
对于获取用户Token接口,返回如图1所示的消息头,其中“X-Subject-Token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
响应消息体(可选)
该部分可选。响应消息体通常以结构化格式(如JSON或XML)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。
对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。
1 2 3 4 5 6 7 8 9 10 11 12 |
{ "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... |
当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。
1 2 3 4 |
{ "error_msg": "The request message format is invalid.", "error_code": "IMG.0001" } |
其中,error_code表示错误码,error_msg表示错误描述信息。
父主题: 如何调用API