API文档>CloudInstall > 公开接口

公开接口

发布时间:2021-12-28 00:00

前言

以下接口如无特殊说明,均为需要携带 Authorization Header 进行权限验证的HTTP接口。

以下接口将会提供cURL 示例,不再提供某一编程语言之示例。

以下接口中包含在PATH中的 {var} 均为REST 参数 ,请自行替换为具体值。

REST 参数 说明
suid 业务标识
batch_no 安装批次号

统一响应格式

固定参数如下:

参数 总是存在 说明
request_id 本次请求的唯一ID
body 仅在 STATUS CODE 为 200 时,提供数据
message 仅在 STATUS CODE 大于 400 时提供错误消息

示例:

{
    "request_id": "d3655b76-bda8-4885-b1b6-19698d60f2aa",
    "message": "example",
    "body": {}
}

状态码

HTTP CODE:

状态吗 说明
200 操作完成,可能会携带数据
400 请求的参数类型或格式等不正确
401 接口需要持有授权才能访问
403 授权有效但当前提供的授权无权限访问此接口,可能会提供错误信息
404 请求资源不存在
500 服务器内部错误,一般不提供错误信息
本文导读