Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

glb-rs & glb-up #528

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/v6/api/overview/rs/rs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,46 +23,46 @@ order: 298
<a id="stat"></a>
## 查看资源信息 (stat)

查看资源信息操作查看的基本信息,包含:文件哈希值、文件大小、媒体类型及上传时间。具体参考[查看资源信息(stat)](/docs/v6/api/reference/rs/stat.html)。
查看资源信息操作查看的基本信息,包含:文件哈希值、文件大小、媒体类型及上传时间。具体参考[查看资源信息(stat)](/docs/v6/api/reference/rs/stat.html)和[多区域查看资源信息(glb-stat)](/docs/v6/api/reference/glb-rs/stat.html)


<a id="move"></a>
## 移动资源 (move)

移动资源操作允许将一个资源在同一个Bucket或者不同的Bucket之间移动。例如,在bucket1下面有一个名为key1的资源,可以将这个资源key1移动到bucket1下面的key2,也可以将其移动到bucket2下的key2。通过移动操作可以实现文件重命名。具体参考[移动资源(move)](/docs/v6/api/reference/rs/move.html)。
移动资源操作允许将一个资源在同一个Bucket或者不同的Bucket之间移动。例如,在bucket1下面有一个名为key1的资源,可以将这个资源key1移动到bucket1下面的key2,也可以将其移动到bucket2下的key2。通过移动操作可以实现文件重命名。具体参考[移动资源(move)](/docs/v6/api/reference/rs/move.html)和[多区域移动资源(glb/move)](/docs/v6/api/reference/glb-rs/move.html)

<a id="copy"></a>
## 复制资源 (copy)

复制资源操作操作允许在同一个bucket进行,也可以在两个不同的bucket之间进行。与资源的移动操作相比,复制资源操作保留原文件,因此会增加用户的存储空间。具体参考[复制资源(copy)](/docs/v6/api/reference/rs/copy.html)。
复制资源操作操作允许在同一个bucket进行,也可以在两个不同的bucket之间进行。与资源的移动操作相比,复制资源操作保留原文件,因此会增加用户的存储空间。具体参考[复制资源(copy)](/docs/v6/api/reference/rs/copy.html)和[多区域复制资源(glb/copy)](/docs/v6/api/reference/glb-rs/copy.html)

<a id="delete"></a>
## 删除资源 (delete)

删除资源与删除文件类似,但是七牛云存储不提供回收站的功能,因此在删除前请确认待删除的资源确实不再需要。具体参考[删除资源(delete)](/docs/v6/api/reference/rs/delete.html)。
删除资源与删除文件类似,但是七牛云存储不提供回收站的功能,因此在删除前请确认待删除的资源确实不再需要。具体参考[删除资源(delete)](/docs/v6/api/reference/rs/delete.html)和[多区域删除资源(glb/delete)](/docs/v6/api/reference/glb-rs/delete.html)

<a id="fetch"></a>
## 抓取资源 (fetch)

抓取资源操作用于从指定的URL抓取资源,并将该资源存储到指定空间中。具体参考[抓取资源(fetch)](/docs/v6/api/reference/rs/fetch.html)。
抓取资源操作用于从指定的URL抓取资源,并将该资源存储到指定空间中。具体参考[抓取资源(fetch)](/docs/v6/api/reference/rs/fetch.html)和[多区域抓取资源(glb/fetch)](/docs/v6/api/reference/glb-rs/fetch.html)

<a id="list"></a>
## 列举资源 (list)
列举资源操作用于将指定空间内的资源分批列出。具体参考[列举资源(list)](/docs/v6/api/reference/rs/list.html)。
列举资源操作用于将指定空间内的资源分批列出。具体参考[列举资源(list)](/docs/v6/api/reference/rs/list.html)和[多区域列举资源(glb/list)](/docs/v6/api/reference/glb-rs/list.html)

<a id="batch"></a>
## 批量操作 (batch)

除了对单一资源进行操作,还可以在一次请求中对多个资源进行批量的查看、移动、复制及删除操作。具体参考[批量操作(batch)](/docs/v6/api/reference/rs/batch.html)。
除了对单一资源进行操作,还可以在一次请求中对多个资源进行批量的查看、移动、复制及删除操作。具体参考[批量操作(batch)](/docs/v6/api/reference/rs/batch.html)和[多区域批量操作(glb/batch)](/docs/v6/api/reference/glb-rs/batch.html)

<a id="chgm"></a>
## 修改元信息 (chgm)

修改元信息操作用于修改资源的mimeType,可以在七牛服务器自动识别文件类型错误或者是类型描述不够详细的情况下,自定义的对空间已有资源的类型进行修改。具体参考[修改元信息 (chgm) ](/docs/v6/api/reference/rs/chgm.html)。
修改元信息操作用于修改资源的mimeType,可以在七牛服务器自动识别文件类型错误或者是类型描述不够详细的情况下,自定义的对空间已有资源的类型进行修改。具体参考[修改元信息 (chgm) ](/docs/v6/api/reference/rs/chgm.html)和[多区域修改元信息 (glb/chgm) ](/docs/v6/api/reference/glb-rs/chgm.html)


<a id="prefetch"></a>
## 更新镜像资源(prefetch)

对于设置了镜像存储的空间,从镜像源站抓取指定名称的资源并存储到该空间中。如果该空间中已存在该名称的资源,则将镜像源站的资源覆盖空间的资源。具体参考[更新镜像资源(prefetch)](/docs/v6/api/reference/rs/prefetch.html)。
对于设置了镜像存储的空间,从镜像源站抓取指定名称的资源并存储到该空间中。如果该空间中已存在该名称的资源,则将镜像源站的资源覆盖空间的资源。具体参考[更新镜像资源(prefetch)](/docs/v6/api/reference/rs/prefetch.html)和[多区域更新镜像资源(glb/prefetch)](/docs/v6/api/reference/glb-rs/prefetch.html)

5 changes: 4 additions & 1 deletion docs/v6/api/overview/up/upload-models/upload-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Content-Type: <MimeType>
<a id="chunked-upload-workflow"></a>
### 基本流程

与分片上传相关的API有这几个:[创建块(mkblk)][mkblkHref]、[上传片(bput)][bputHref]、[创建资源(mkfile)][mkfileHref]。一个完整的分片上传流程可用下图表示:
与分片上传相关的API有这几个:[创建块(mkblk)][mkblkHref]、[上传片(bput)][bputHref]、[创建资源(mkfile)][mkfileHref]。多区域分片上传的API有:[多区域创建块(glb/mkblk)][glb-mkblkHref]、[多区域上传片(glb/bput)][glb-bputHref]、[多区域创建资源(glb/mkfile)][glb-mkfileHref]。一个完整的分片上传流程可用下图表示:

![分片上传流程](img/chunked-upload-workflow.png)

Expand Down Expand Up @@ -182,6 +182,9 @@ Content-Type: <MimeType>
[mkblkHref]: /docs/v6/api/reference/up/mkblk.html "创建块"
[bputHref]: /docs/v6/api/reference/up/bput.html "上传片"
[mkfileHref]: /docs/v6/api/reference/up/mkfile.html "创建资源"
[glb-mkblkHref]: /docs/v6/api/reference/glb-up/mkblk.html "多区域创建块"
[glb-bputHref]: /docs/v6/api/reference/glb-up/bput.html "多区域上传片"
[glb-mkfileHref]: /docs/v6/api/reference/glb-up/mkfile.html "多区域创建资源"
[uploadTokenHref]: /docs/v6/api/reference/security/upload-token.html "上传凭证"
[varsHref]: /docs/v6/api/overview/up/response/vars.html "变量"

Expand Down
2 changes: 1 addition & 1 deletion docs/v6/api/reference/codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ HTTP状态码 | 说明
614 | 目标资源已存在。
630 | 已创建的空间数量达到上限,无法创建新空间。
631 | 指定空间不存在。
640 | 调用[列举资源(list)](/docs/v6/api/reference/rs/list.html)接口时,指定非法的`marker`参数。
640 | 调用[列举资源(list)](/docs/v6/api/reference/rs/list.html)和[多区域列举资源(glb/list)](/docs/v6/api/reference/glb-rs/list.html)接口时,指定非法的`marker`参数。
701 | 在断点续上传过程中,后续上传接收地址不正确或ctx信息已过期。

如遇5xx系列错误,请将完整的错误信息(包括所有的HTTP响应头部)[通过邮件发送](mailto:[email protected]?subject=5xx错误日志)给我们。情况严重时请直接拨打400-808-9176转2上报给运维部,我们将尽快处理。
1 change: 1 addition & 0 deletions docs/v6/api/reference/data-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ encodedEntryURI = urlsafe_base64_encode(entry)
```

假设entry为`qiniuphotos:gogopher.jpg`,则对应的encodedEntryURI为`cWluaXVwaG90b3M6Z29nb3BoZXIuanBn`。
假设一个多区域entry为`qiniuphotos:z1/gogopher.jpg`,则对应的encodedEntryURI为`cWluaXVwaG90b3M6ejEvZ29nb3BoZXIuanBn`。

<a id="download-internal-resources"></a>
## 内部参考资源
Expand Down
211 changes: 211 additions & 0 deletions docs/v6/api/reference/glb-rs/batch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
---
title: 批量操作(batch)
order: 500
---

<a id="batch"></a>
# 多区域批量操作(glb/batch)

- [描述](#batch-description)
- [请求](#batch-request)
- [请求语法](#batch-request-syntax)
- [访问权限](#batch-request-auth)
- [请求参数](#batch-request-params)
- [头部信息](#batch-request-headers)
- [请求内容](#batch-request-body)
- [响应](#batch-response)
- [响应语法](#batch-response-headers)
- [头部信息](#batch-response-headers)
- [响应内容](#batch-response-body)
- [响应状态码](#batch-response-batchus)
- [附注](#batch-remarks)
- [相关资源](#batch-related-resources)

<a id="batch-description"></a>
## 描述

批量操作意指在单一请求中执行多次获取元信息/移动/复制/删除操作,极大提高资源管理效率。

<a id="batch-request"></a>
## 请求

<a id="batch-request-syntax"></a>
### 请求语法

```
POST /glb/batch HTTP/1.1
Host: rs.qiniu.com
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <AccessToken>

op=<Operation>&op=<Operation>&...
```

<span style="color: red;">注意:要在Authorization头部的`<AccessToken>`前添加`QBox`和半角空格。</span>

其中`op=<Operation>`是单一资源操作指令。例如`/stat/<EncodeEntryURI>`,`/delete/<EncodeEntryURI>`等。
EncodeEntryURI、EncodedEntryURISrc与EncodedEntryURIDest的细节请查看[EncodedEntryURI格式][encodedEntryURIHref]。

<a id="batch-request-auth"></a>
### 访问权限

[管理凭证][accessTokenHref]方式。

<a id="batch-request-params"></a>
### 请求参数

该请求无需设置任何参数。

<a id="batch-request-headers"></a>
### 头部信息

头部名称 | 必填 | 说明
:------------ | :--- | :-----------------------------
Content-Type | 是 | 固定为application/x-www-form-urlencoded
Authorization | 是 | 该参数应严格按照[管理凭证][accessTokenHref]格式进行填充,否则会返回401错误码<p>一个合法的Authorization值应类似于:`QBox QNJi_bYJlmO5LeY08FfoNj9w_r7...`

<a id="batch-request-body"></a>
### 请求内容

#### 批量获取元信息

```
op=/glb/stat/<EncodedEntryURI>&op=/stat/<EncodedEntryURI>&...
```

#### 批量复制资源

```
op=/glb/copy/<EncodedEntryURISrc>/<EncodedEntryURIDest>&op=/glb/copy/<EncodedEntryURISrc>/<EncodedEntryURIDest>&...
```

#### 批量移动资源

```
op=/glb/move/<EncodedEntryURISrc>/<EncodedEntryURIDest>&op=/glb/move/<EncodedEntryURISrc>/<EncodedEntryURIDest>&...
```

#### 批量删除资源

```
op=/glb/delete/<EncodedEntryURI>&op=/glb/delete/<EncodedEntryURI>&...
```

#### 混合多种操作

```
op=/glb/stat/<EncodedEntryURI>
&op=/glb/copy/<EncodedEntryURISrc>/<EncodedEntryURIDest>
&op=/glb/move/<EncodedEntryURISrc>/<EncodedEntryURIDest>&...
&op=/glb/delete/<EncodedEntryURI>&...
```

<a id="batch-response"></a>
## 响应

<a id="batch-request-syntax"></a>
### 响应语法

```
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store
```

<a id="batch-response-headers"></a>
### 头部信息


头部名称 | 必填 | 说明
:------------ | :--- | :-----------------------------------------------------------------
Content-Type | 是 | 正常情况下该值将被设为`application/json`,表示返回JSON格式的文本信息

其它可能返回的头部信息,请参考[常见响应头部信息][commonHttpResponseHeaderHref]。

<a id="batch-response-body"></a>
### 响应内容

#### 批量获取元信息

```
[
{ "code": <HttpCode int>, "data": <Data> },
{ "code": <HttpCode int>, "data": <Data> },
{ "code": <HttpCode int>, "data": { "error": "<ErrorMessage string>" } },
...
]
```

#### 批量复制资源

```
[
{ "code": <HttpCode int> },
{ "code": <HttpCode int> },
{ "code": <HttpCode int>, "data": { "error": "<ErrorMessage string>" } },
...
]
```

#### 批量移动资源

```
[
{ "code": <HttpCode int> },
{ "code": <HttpCode int> },
{ "code": <HttpCode int>, "data": { "error": "<ErrorMessage string>" } },
...
]
```

#### 批量删除资源

```
[
{ "code": <HttpCode int> },
{ "code": <HttpCode int> },
{ "code": <HttpCode int>, "data": { "error": "<ErrorMessage string>" } },
...
]
```

#### 混合多种操作

```
[
{ "code": <HttpCode int>, "data": <Data> },
{ "code": <HttpCode int> },
{ "code": <HttpCode int> },
{ "code": <HttpCode int> },
{ "code": <HttpCode int>, "data": { "error": "<ErrorMessage string>" } },
...
]
```

<a id="batch-response-status"></a>
### 响应状态码

HTTP状态码 | 含义
:--------- | :--------------------------
200 | 所有请求操作都已成功完成
298 | 部分或所有请求操作失败(出错信息参看上述响应内容)
400 | 请求报文格式错误
401 | 管理凭证无效
599 | 服务端操作失败<p>如遇此错误,请将完整错误信息(包括所有HTTP响应头部)[通过邮件发送][sendBugReportHref]给我们

<a id="batch-remarks"></a>
## 附注

无。

<a id="batch-related-resources"></a>
## 相关资源

- [管理凭证][accessTokenHref]
- [EncodedEntryURI格式][encodedEntryURIHref]

[encodedEntryURIHref]: http://developer.qiniu.com/docs/v6/api/reference/data-formats.html#data-format-encoded-entry-uri "EncodedEntryURI格式"
[accessTokenHref]: http://developer.qiniu.com/docs/v6/api/reference/security/access-token.html "管理凭证"

[sendBugReportHref]: mailto:[email protected]?subject=599错误日志 "发送错误报告"
[commonHttpResponseHeaderHref]: http://developer.qiniu.com/docs/v6/api/reference/extended-headers.html "常见响应头部信息"
Loading