返回结果
请求发送以后,会收到响应,包含:状态码、响应消息头和响应消息体。
响应消息头
对应请求消息头,响应同样也有消息头,如“Content-type”。
消息头名称 |
描述 |
是否必选 |
---|---|---|
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 |
此字段携带流控单位。 类型:字符串。单位按照分钟、小时、天。 默认值:小时。 |
否 |
对于查询流活动历史记录接口,会返回相应消息头。
响应消息体
响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。
{ "count": 5, "histories": [ { "id": "f4ce35fd-5e33-4d9e-b7e1-63f3a07d74ce", "flow_id": "55e42ede-25dd-4f79-9aa4-842e1ba435a1", "flow_name": "业务对象测试", "flow_version_id": null, "run_model": null, "status": "fail", "icon": "data:image/png;base64,iVBORw0KGgoAAA...", "start_time": "2022-02-28T03:34:04.025Z", "end_time": null, "exec_time": 0, "running_times": 1438, "last_time": "2022-02-28T03:34:04.025Z", "message": "trigger action running fail." }, .... ] }
当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。
{ "error_message": "The format of message is error", "error_code": "MSSI.00020004" }
其中,error_code表示错误码,error_message表示错误描述信息,具体请参见错误码。