通用说明

公共请求头

下表列出了所有标签服务API所携带的公共头域。HTTP协议的标准头域不再这里列出了。

头域(Header) 是否必须 说明
Authorization 必须 包含Access Key与请求签名
Content-Type 可选 application/json; charset=utf-8
x-bce-date 可选 表示日期的字符串,符合BCE API规范
x-bce-content-sha256 可选 表示内容部分的SHA256签名的十六进制字符串。这里内容指HTTP Request Payload Body。即Content部分在被HTTP encode之前的原始数据

公共头域将在每个标签服务API中出现,是必需的头域,其中x-bce-content-sha256头域只出现在POST和PUT请求中。

POST、PUT、DELETE等请求数据放在request body中。

公共响应头

下表列出了所有标签服务API的公共响应头域。HTTP协议的标准响应头域不再这里列出了。

头域(Header) 说明
Content-Type 只支持JSON格式,application/json; charset=utf-8
x-bce-request-id tag后端生成,并自动设置到响应头域中

其中,request id使用UUID version4生成。

通用错误返回

标签服务错误响应符合BCE规范,统一为如下格式。后续各接口不再单独列出。

{
        "requestId": "47e0ef1a-9bf2-11e1-9279-0100e8cf109a",
        "code":"NoSuchKey",
        "message":"The resource you requested does not exist"
    }

其中,code为错误码,所有错误码取值来源BCE公共错误码和标签服务专有错误码(参考错误码部分内容)。

API版本

当前API版本为1,即下文出现的{version}取值为1。