更新时间:2024-08-06 GMT+08:00

返回结果

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

状态码

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

对于创建API分组接口,如果调用后返回状态码为“201”,则表示请求成功。

响应消息头

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

对于创建API分组接口,返回如下图所示的消息头。

图1 创建API分组响应消息头

响应消息体

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

对于创建API分组接口,返回如下消息体。为篇幅起见,这里只展示部分内容。

{
 "id": "41e08fbaca9f4d64bde467d0dd89ff51",
 "name": "aaa",
 "status": 1,
 "sl_domain": "41e08fbaca9f4d64bde467d0dd89ff51.example.cloudapis.com",
 "register_time": "2024-05-23T08:03:56.419897855Z",
 "update_time": "2024-05-23T08:03:56.419897962Z",
 "on_sell_status": 2,
 "url_domains": [],
 "sl_domain_access_enabled": true,
 "sl_domains": [
  "41e08fbaca9f4d64bde467d0dd89ff51.example.cloudapis.com"
 ],
 "remark": "",
 "call_limits": 0,
 "time_interval": 0,
 "time_unit": "",
 "is_default": 2,
 "version": "",
}

当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。

{
    "error_msg": "The token is missing.",
    "error_code": "APIG.1000"
}

其中,error_code表示错误码,error_msg表示错误描述信息。