通用说明
认证机制
所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成，均为字符串。 对于每个HTTP请求，使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}。
- version是正整数，目前取值为1。
- timestamp是生成签名时的UTC时间。
- expirationPeriodInSeconds表示签名有效期限。
- signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
- signature是256位签名的十六进制表示，由64个小写字母组成。
鉴权认证机制的详细内容请参见鉴权认证。
通信协议
支持HTTP和HTTPS两种调用方式。为了提升数据的安全性，建议通过HTTPS调用。
请求结构说明
请求参数包括如下4种：
| 参数类型 | 说明 |
|---|---|
| URI | 通常用于指明操作实体，如:GET /v1/csn |
| Query参数 | URL中携带的请求参数 |
| HEADER | 通过HTTP头域传入，如:x-bce-date |
| RequestBody | 通过JSON格式组织的请求数据体 |
响应结构说明
返回值分为两种形式：
| 返回内容 | 说明 |
|---|---|
| HTTP STATUS CODE | 如200、400、403、404等 |
| ResponseBody | JSON格式组织的响应数据体 |
公共请求头与公共响应头
公共请求头
| 公共头部 | 描述 |
|---|---|
| Authorization | 包含Access Key与请求签名。 |
| Content-Type | application/json; charset=utf-8。 |
| x-bce-date | 表示日期的字符串，符合API规范。 |
HTTP协议的标准头域不在这里列出。公共头域将在每个网络诊断API中出现，是必需的头域。POST、PUT、DELETE等请求数据放在request body中。
公共响应头
| 公共头部 | 描述 |
|---|---|
| Content-Type | application/json; charset=utf-8。 |
| x-bce-request-id | VPC后端生成，并自动设置到响应头域中。 |
API版本号
| 参数 | 类型 | 参数位置 | 描述 | 是否必选 |
|---|---|---|---|---|
| version | String | URL参数 | API版本号，当前API版本v1。 | 是 |
幂等性
当调用创建接口时如果遇到了请求超时或服务器内部错误，用户可能会尝试重发请求，这时用户通过clientToken参数避免创建出比预期要多的资源，即保证请求的幂等性。
幂等性基于clientToken，clientToken是一个长度不超过64位的ASCII字符串，通常放在query string里，如http://bcc.bj.baidubce.com/v1/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20。
如果用户使用同一个clientToken值调用创建接口，则服务端会返回相同的请求结果。因此用户在遇到错误进行重试的时候，可以通过提供相同的clientToken值，来确保只创建一个资源；如果用户提供了一个已经使用过的clientToken，但其他请求参数（包括queryString和requestBody）不同甚至url Path不同，则会返回IdempotentParameterMismatch的错误代码。
clientToken的有效期为24小时，以服务端最后一次收到该clientToken为准。也就是说，如果客户端不断发送同一个clientToken，那么该clientToken将长期有效。
