接口规范
更新时间:2019-06-14
请求头域内容
- Host(必填)
- x-bce-date(必填)
- Authorization(必填)
- Content-Type(选填)
- Content-Length(选填)
其中,x-bce-date为当前的UTC时间,遵循ISO 8601,并做以下约束:
- 日期采用YYYY-MM-DD方式,例如2016-06-01表示2016年6月1日。
- 时间采用hh:mm:ss方式,并在最后加一个大写字母Z表示UTC时间。例如23:00:10Z表示UTC时间23点0分10秒。
- x-bce-date是日期和时间的合并表示,在两者中间加大写字母T,例如2016-06-01T23:00:10Z表示UTC时间2016年6月1日23点0分10秒。
示例
以下是一个标准的请求数据加密的请求头域内容:
POST /v1/tsm/device/de9b28dkjdf21rcf/encrypt HTTP/1.1
Host: hisk.baidubce.com
Authorization: {authorization}
Content-Type: application/json; charset=utf-8
x-bce-date: 2016-06-06T11:52:41Z
请求消息体格式
HISK服务要求使用JSON格式的结构体来描述一个请求的具体内容。
示例
一下是一个标准的请求数据加密的请求消息体格式:
{
"data": "YmFpZHUK",
"type": "base64"
}
请求返回格式
HISK服务均采用JSON格式的消息体作为响应返回的格式。
示例
以下是一个标准的请求数据加密的请求返回:
{
"data": "YXNkZnFmYXNkYXNkZgo="
}
错误请求返回格式
HISK服务均采用JSON格式的消息体作为错误请求的响应返回格式。
示例
{
"requestId": "47e0ef1a-9bf2-11e1-9279-0100e8cf109a",
"code": "AccessDenied",
"message": "Access denied."
}
错误码
错误码 | 消息 | HTTP状态 | 语义 |
---|---|---|---|
AccessDenied | Access denied. | 403 Forbidden | 无权限访问对应的资源 |
IdQuotaInvalid | There is no more device Id quota. | 400 Bad Request | device id quota耗尽 |
ParametersInvalid | (根据请求参数返回具体的错误信息) | 400 Bad Request | 参数错误 |
SignatureInvalid | The signature is invalid. | 400 Bad Request | 签名无效 |
InternalServerError | Encounter an internal server error for the request. | 500 Internal Server Error | 服务内部错误 |