0、相关文章:
1、请求结构
1.1、描述
腾讯云对象存储的 RESTful API 请求结构如下表:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Version | 是 | String | HTTP 版本 |
URL | 是 | String | HTTP 请求地址,总长度不得超过 1024 字节 |
Header | 是 | 数据集合 | HTTP 请求头部 |
HTTP Method | 是 | String | HTTP 请求方法,常用 GET 或 POST |
Request Body | 否 | json | HTTP 请求正文 |
URL 请求地址格式举例:
<Region>.file.myqcloud.com/files/v2/<appid>/<bucket_name>[/dir_name/<file_name>]
说明:
Region:所在地域,枚举值为 可用地域 中适用于 JSON API 的地域简称,例如 sh、gz、sgp 等。
appid:数字,在腾讯云对象存储 Web 控制台中,创建项目后得到 appid,用于唯一标识某个项目。
bucket_name:字母和数字的组合串。对应某个项目下的 bucket 名称。
<箭头括号>表示必须 替换为有效值的变量,[英文方括号]表示可选的命令或参数,具体要求以各 API 文档为准。
Header 结构:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Host | 是 | String | 文件云服务器域名,形式为 .file.myqcloud.com ,其中 Region 为 可用地域 中适用于 JSON API 的地域简称,例如:sh.file.myqcloud.com , sgp.file.myqcloud.com 等 |
Authorization | 是 | String | 用户的有效签名,用于鉴权。对应签名鉴权中得到的 sign 字符串 |
Content-Type | 是 | String | 按要求填 application/json 或 multipart/form-data |
Content-Length | 是 | Int | 请求长度,单位:字节 |
1.2、示例
POST /files/v2/10000202/buckettest/foldertest/ HTTP/1.1
Host: sh.file.myqcloud.com
Content-Type: application/json
Content-Length: 15
Authorization: 1k2i3/EXIiTDirFg9DoKgWNHc4JhPTEwMDAwMjAyJms9QUtJRFBOUHVyNUIyN3FjdVJhakNFbXpLVjkzVTdrOFZjZXFXJmU9MTQ2NTg3NTU0OSZ0PTE0NjU4NzUzNjkmcj03MTI5NDYyMzQmZj0mYj1qb25ueHU1
{
"op": "create"
}
2、返回结构
2.1、描述
腾讯云对象存储的 RESTful API 统一返回 HTTP 标准的状态码,HTTP 标准的头部信息以及 JSON 格式的返回包内容。
常见的返回格式如下:
参数名称 | 类型 | 描述 |
---|---|---|
HTTP Status Code | Int | HTTP 状态码 |
HTTP Headers | String | HTTP 头部信息 |
Response Body | 数据集合 | HTTP 响应正文 |
Response Body 数据集合
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 服务端返回码 |
message | String | 服务端提示内容 |
data | 数据集合 | 服务端返回的应答数据 |
2.2、示例
HTTP/1.1 200 OK
Server: nginx
Date: Tue, 14 Jun 2016 03:36:12 GMT
Content-Length: 109
{
"code": 0,
"message": "SUCCESS",
"data": {
}
}