conversations
listlengths 2
2
| source
stringclasses 1
value | score
float64 1
1
|
|---|---|---|
[
{
"from": "human",
"value": "如何处理七牛云的对象存储删除 Bucket"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Bucket\n接口](https://developer.qiniu.com/kodo/api/3941/the-bucket-interface) > 删除\nBucket\n\n# 删除 Bucket\n\n最近更新时间: 2023-03-01 17:47:02\n\n# **描述**\n\n本接口用于删除指定的 Bucket。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /drop/<BucketName> HTTP/1.1\n Host: uc.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n使用说明：\n\n * 删除存储空间后，其中保存的文件也会被删除，无法恢复。\n\n * 删除存储空间后，空间名称可以被重新使用。\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nBucketName | 是 | 需要删除的目标空间名 \n \n \n\n### **请求头**\n\n该请求操作的实现使用了所有操作的公共请求头。有关详细信息，请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-header)。\n\n \n\n### **响应内容**\n\n该请求操作的响应体为空。\n\n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /drop/test05 HTTP/1.1\n Host: uc.qiniuapi.com\n User-Agent: Go-http-client/1.1\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:nj2E4apIRDq67g_PMJ932w_2qiA=\n \n\n_注：要在`Authorization` 头部的 `<AccessToken>` 前添加 `Qiniu` 和半角空格。_\n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Server: nginx\n X-Reqid: r3oAAD-vqeUyT9sU\n \n {}\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储获取 Bucket 空间域名"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Bucket\n接口](https://developer.qiniu.com/kodo/api/3941/the-bucket-interface) > 获取\nBucket 空间域名\n\n# 获取 Bucket 空间域名\n\n最近更新时间: 2023-03-01 17:47:13\n\n# **描述**\n\n本接口用于获取 Bucket 的域名列表。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n GET /v2/domains?tbl=<bucketName> HTTP/1.1\n Host: uc.qiniuapi.com \n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z \n Authorization: Qiniu <AccessToken>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \ntbl | 是 | 要获取域名列表的目标空间名称 \n \n \n\n### **请求头**\n\n该请求操作的实现使用了所有操作的公共请求头。有关详细信息，请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n {\n DomainName\n }\n \n\n \n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nresponse-headers)。\n\n \n\n### **响应内容**\n\n名称 | 说明 \n---|--- \nDomainName | 空间域名 \n \n类型：字符串 \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n GET /v2/domains?tbl=test01 HTTP/1.1\n Host: uc.qiniuapi.com\n User-Agent: Go-http-client/1.1\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:jfblnkj6JsrlxgbE3l4SfhSyiL4=\n Accept-Encoding: gzip\n \n\n_注：要在`Authorization` 头部的 `<AccessToken>` 前添加 `Qiniu` 和半角空格。_\n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Connection: keep-alive\n Content-Type: application/json\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Server: nginx\n Vary: Accept-Encoding\n X-Reqid: BksAALTAQtVZhdsU\n \n [\n \"oupgm4mi4.bkt.clouddn.com\", \n \"sarah.qiniudemo.com\"\n ]\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储设置 Bucket 镜像源"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Bucket\n接口](https://developer.qiniu.com/kodo/api/3941/the-bucket-interface) > 设置\nBucket 镜像源\n\n# 设置 Bucket 镜像源\n\n最近更新时间: 2023-03-01 17:47:24\n\n# **描述**\n\n七牛镜像存储服务可以帮助用户实现数据热迁移，迁移过程中并不影响原有业务系统的访问。镜像存储适用于迁移原有业务系统的已有数据。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /image/<BucketName>/from/<EncodedSrcSiteUrl>/host/<EncodedHost> HTTP/1.1\n Host: uc.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n使用说明：\n\n * 取回动作仅在第一次访问资源不存在时发生\n\n * 取回动作是一个同步操作，源文件过大可能导致客户端等待超时\n\n * 取回动作失败时，会返回 HTTP 响应码\n\n * 源站同名资源的内容发生改变后，七牛云存储不会自动将新内容取回，用户需要删除空间中的资源，再[刷新预取 __](https://portal.qiniu.com/domain/refresh)才可以访问到更新后的资源\n\n * 多个客户端触发镜像回源时，资源的最终内容为最后一个成功执行的操作所存储的结果\n\n * 回源源站时，会携带固定的User-Agent信息：`<RegionID>-qiniu-imgstg-spider-1.0`，[Region(区域) ID列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq)\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nBucketName | 是 | 需要设定镜像源的目标空间名 \nEncodedSrcSiteUrl | 是 | 镜像源的访问域名，必须设置为形如`http(s)://source.com`或`http(s)://114.114.114.114`的字符串。参数值必须做[URL 安全的 Base64 编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64)。 \nEncodedHost | 否 | 回源时使用的`Host`头部值。参数值必须做[URL 安全的 Base64 编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64)。可以填空字符串 `\"\"` 或不包含 `/host/<EncodedHost>` 部分，表示不额外指定 host \n \n \n\n### **请求头**\n\n该请求操作的实现使用了所有操作的公共请求头。有关详细信息，请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nresponse-headers)。\n\n \n\n### **响应内容**\n\n该请求操作的响应体为空。\n\n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /image/test02/from/aHR0cHM6Ly9zYXJhaC5xaW5pdWRlbW8uY29t HTTP/1.1\n Host: uc.qiniuapi.com\n User-Agent: Go-http-client/1.1\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:CCiHcTjKJDdseHBrldeYFywnxWo=\n Accept-Encoding: gzip\n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Server: nginx/1.4.4\n X-Reqid: WUQAAIqqrYab_9oU\n \n {}\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储设置 Bucket 访问权限"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Bucket\n接口](https://developer.qiniu.com/kodo/api/3941/the-bucket-interface) > 设置\nBucket 访问权限\n\n# 设置 Bucket 访问权限\n\n最近更新时间: 2023-03-01 17:47:33\n\n# **描述**\n\n本接口用于设置 Bucket 访问权限。目前 Bucket 有两种访问权限：公开和私有。创建 Bucket 时默认为公开空间。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /private?bucket=<BucketName>&private=<Private> HTTP/1.1\n Host: uc.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nbucket | 是 | 空间名称 \nprivate | 是 | \n* `0` 公开\n* `1` 私有 \n \n \n\n### **请求头**\n\n该请求操作的实现使用了所有操作的公共请求头。有关详细信息，请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **响应内容**\n\n该请求操作的响应体为空。\n\n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /private?bucket=test06&private=1 HTTP/1.1\n Host: uc.qiniuapi.com\n User-Agent: Go-http-client/1.1\n Content-Length: 23\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:YHLW5tnhbumBI56iQ0AzJdZONSY=\n Content-Type: application/x-www-form-urlencoded\n Accept-Encoding: gzip\n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Server: nginx\n X-Reqid: VBoAAJjbI4_ZmdsU\n \n {}\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储设置空间标签"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Bucket\n接口](https://developer.qiniu.com/kodo/api/3941/the-bucket-interface) > 设置空间标签\n\n# 设置空间标签\n\n最近更新时间: 2023-03-01 17:47:42\n\n# **描述**\n\n本接口用于设置空间标签，包括新增和修改。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n PUT /bucketTagging?bucket=<BucketName> HTTP/1.1\n Host: uc.qiniuapi.com\n Content-Type: application/json\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n {\n \"Tags\":[ \n {\"Key\":xx, \"Value\": xx},\n {\"Key\":xx, \"Value\": xx},\n ...\n ]\n }\n \n\n使用说明：\n\n * 标签（tag）是 Key-Value的结构，同一个Bucket下，Key必须是唯一的, 且一个Key只能有1个Value，Key设置重复时服务端会返回400: tag contain duplicate key。\n\n * 每个Bucket最多可以设置10对标签，超出限制时服务端会返回400: tag num exceed limit。\n\n * API是覆盖语义，调用时会替换整个Bucket的标签，比如：原来Bucket有10对标签, 想更新其中1对，request.body应该包含9对old tag + 1对 new tag。\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nBucketName | 是 | 空间名称 \nKey | 是 | 标签名称，最大64Byte，不能为空且大小写敏感，不能以kodo为前缀(预留), 不支持中文字符，可使用的字符有：字母，数字，空格，+ - = . _ : / @ \nValue | 是 | 标签值，最大128Byte，不能为空且大小写敏感，不支持中文字符，可使用的字符有：字母，数字，空格，+ - = . _ : / @ \n \n \n\n### **请求头**\n\n该请求操作的实现使用了所有操作的公共请求头。有关详细信息，请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nresponse-headers)。\n\n \n\n### **响应内容**\n\n该请求操作的响应体为空。\n\n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n PUT /bucketTagging?bucket=temp-bucket-jnacytgvzwpgiotaprp1z0 HTTP/1.1\n Host: uc.qiniuapi.com\n User-Agent: Go-http-client/1.1\n Content-Length: 0\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu HwFOxpYCQU6oXoZXFOTh1mq5ZZig6Yyocgk3BTZZ:yfdfCaZNBlgi2HACEXRSgycc8IY=\n Content-Type: application/json \n \n {\n \t\"Tags\": [\n \t\t{\n \t\t\t\"Key\": \"KODO-BUKCET-TAGS-key-qyxvhJ0b3l\",\n \t\t\t\"Value\": \"KODO-BUKCET-TAGS-value-tUwjRvCVzz\"\n \t\t}\n \t]\n }\n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n X-Reqid: rWkAAFTxT13GrdYV\n \n {}\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储查询空间标签"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Bucket\n接口](https://developer.qiniu.com/kodo/api/3941/the-bucket-interface) > 查询空间标签\n\n# 查询空间标签\n\n最近更新时间: 2023-03-01 17:47:54\n\n# **描述**\n\n本接口用于查询指定空间已设置的标签信息。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n GET /bucketTagging?bucket=<BucketName> HTTP/1.1\n Host: uc.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nBucketName | 是 | 空间名称 \n \n \n\n### **请求头**\n\n该请求操作的实现使用了所有操作的公共请求头。有关详细信息，请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n {\n \"Tags\":[{\"Key\":xx,\"Value\":xx}]\n }\n \n\n \n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nresponse-headers)。\n\n \n\n### **响应内容**\n\n名称 | 说明 \n---|--- \nKey | 标签名称 \nValue | 标签值 \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n GET /bucketTagging?bucket=temp-bucket-jnacytgvzwpgiotaprp1z0 HTTP/1.1\n Host: uc.qiniuapi.com\n User-Agent: Go-http-client/1.1\n Content-Length: 0\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu HwFOxpYCQU6oXoZXFOTh1mq5ZZig6Yyocgk3BTZZ:z_ksteUK6jI_0MLAaHNEPFqrpqY=\n Content-Type: application/json \n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n X-Reqid: rWkAAGaeqzDGrdYV\n \n {\n \t\"Tags\": [\n \t\t{\n \t\t\t\"Key\": \"123\",\n \t\t\t\"Value\": \"0000\"\n \t\t},\n \t\t{\n \t\t\t\"Key\": \"aaaaa\",\n \t\t\t\"Value\": \"bbbbb\"\n \t\t}\n \t]\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储删除空间标签"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Bucket\n接口](https://developer.qiniu.com/kodo/api/3941/the-bucket-interface) > 删除空间标签\n\n# 删除空间标签\n\n最近更新时间: 2023-03-01 17:48:00\n\n# **描述**\n\n本接口用于一键删除指定空间的所有标签。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n DELETE /bucketTagging?bucket=<BucketName> HTTP/1.1\n Host: uc.qiniuapi.com\n Content-Type: application/json\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nBucketName | 是 | 空间名称 \n \n \n\n### **请求头**\n\n该请求操作的实现使用了所有操作的公共请求头。有关详细信息，请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nresponse-headers)。\n\n \n\n### **响应内容**\n\n该请求操作的响应体为空。\n\n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n DELETE /bucketTagging?bucket=temp-bucket-wdszkatkt3hdk3cid9dnz0 HTTP/1.1\n Host: uc.qiniuapi.com\n User-Agent: Go-http-client/1.1\n Content-Length: 0\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu HwFOxpYCQU6oXoZXFOTh1mq5ZZig6Yyocgk3BTZZ:kHhCAVNFp4hti6x7YMMi1_9Fs7k=\n Content-Type: application/json \n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n X-Reqid: rWkAAJJlhDXGrdYV\n \n {}\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Object 接口"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > Object 接口\n\n# Object 接口\n\n最近更新时间: 2021-12-06 12:19:58\n\n对象管理相关的接口：\n\n接口 | 说明 \n---|--- \n[upload](https://developer.qiniu.com/kodo/api/1312/upload) | 用于在一次 HTTP 会话中上传单一的一个对象 \n[mkblk](https://developer.qiniu.com/kodo/api/1286/mkblk) | 为后续分片上传创建一个新的块，同时上传第一片数据 \n[bput](https://developer.qiniu.com/kodo/api/1251/bput) | 上传指定块的一片数据，具体数据量可根据现场环境调整，同一块的每片数据必须串行上传 \n[mkfile](https://developer.qiniu.com/kodo/api/1287/mkfile) | 将上传好的所有数据块按指定顺序合并成一个对象资源 \n[initiateMultipartUpload](https://developer.qiniu.com/kodo/api/6365/initialize-multipartupload) | 通知服务端开启分块上传任务,得到全局唯一任务UploadId \n[uploadPart](https://developer.qiniu.com/kodo/api/6366/upload-part) | 分块上传数据，需指定的任务UploadId \n[completeMultipartUpload](https://developer.qiniu.com/kodo/api/6368/complete-multipart-upload) | 完成整个对象的分块上传，需指定的任务UploadId \n[abortMultipartUpload](https://developer.qiniu.com/kodo/api/6367/abort-multipart-upload) | 中止分块上传任务，并且删除已经上传的块，需指定的任务UploadId \n[listParts](https://developer.qiniu.com/kodo/api/6858/listparts) | 列举指定 UploadId 所属的所有已经上传成功Part \n[list](https://developer.qiniu.com/kodo/api/1284/list) | 用于列举指定空间里的所有对象条目 \n[stat](https://developer.qiniu.com/kodo/api/1308/stat) | 仅获取对象的 Metadata 信息，不返回对象内容 \n[chgm](https://developer.qiniu.com/kodo/api/1252/chgm) | 修改对象的 MIME 类型信息 \n[move](https://developer.qiniu.com/kodo/api/1288/move) | 将源空间的指定对象移动到目标空间，或在同一空间内对对象重命名 \n[copy](https://developer.qiniu.com/kodo/api/1254/copy) | 将指定对象复制为新命名对象 \n[delete](https://developer.qiniu.com/kodo/api/1257/delete) | 删除指定对象 \n[batch](https://developer.qiniu.com/kodo/api/1250/batch) | 指在单一请求中执行多次获取元信息、移动、复制、删除操作，极大提高对象管理效率 \n[chstatus](https://developer.qiniu.com/kodo/api/4173/modify-the-file-status) | 修改对象的存储状态，即切换启用、禁用状态 \n[chtype](https://developer.qiniu.com/kodo/api/3710/chtype) | 修改对象的存储类型信息，即低频存储、标准存储和归档存储的互相转换 \n[restoreAr](https://developer.qiniu.com/kodo/api/6380/restore-archive) | 解冻归档存储类型的对象 \n[deleteAfterDays](https://developer.qiniu.com/kodo/api/1732/update-file-lifecycle) | 设置一个对象多少天后过期删除 \n[lifecycle](https://developer.qiniu.com/kodo/api/8062/modify-object-life-cycle) | 修改已上传对象的生命周期，即修改对象转低频时间、转归档时间、过期删除时间 \n[prefetch](https://developer.qiniu.com/kodo/api/1293/prefetch) | 对于设置了镜像存储的空间，从镜像源站抓取指定名称的对象并存储到该空间中 \n[sisyphus/fetch](https://developer.qiniu.com/kodo/api/4097/asynch-fetch) | 从指定 URL 抓取对象，并将该对象存储到指定空间中。每次只抓取一个对象，抓取时可以指定保存空间名和最终对象名 \n \n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储直传文件"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 直传文件\n\n# 直传文件\n\n最近更新时间: 2024-04-09 14:41:24\n\n# **描述**\n\n本接口用于在一次 HTTP 会话中上传单一的一个文件。\n\n \n\n# **请求**\n\n### **请求语法**\n\n请求报文的内容以`multipart/form-data`格式组织：\n\n \n \n POST / HTTP/1.1\n Host: <UpHost>\n Content-Type: multipart/form-data; boundary=<frontier>\n Content-Length: <multipartContentLength>\n \n --<frontier>\n Content-Disposition: form-data; name=\"key\"\n \n <resource_key>\n --<frontier>\n Content-Disposition: form-data; name=\"x:<custom_name>\"\n \n <custom_value>\n --<frontier>\n Content-Disposition: form-data; name=\"token\"\n \n <upload_token>\n --<frontier>\n Content-Disposition: form-data; name=\"crc32\"\n \n <crc32>\n --<frontier>\n Content-Disposition: form-data; name=\"x-qn-meta-<metaKey>\"\n \n <metaValue>\n --<frontier>\n Content-Disposition: form-data; name=\"accept\"\n \n <acceptContentType>\n --<frontier>\n Content-Disposition: form-data; name=\"file\"; filename=\"<fileName>\"\n Content-Type: <contentType>\n Content-Transfer-Encoding: binary\n \n <fileBinaryData>\n --<frontier>--\n \n\n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | 上传域名。七牛对象存储支持的区域和对应区域上传域名列表见 [存储区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq) \n \n \n\n### **请求内容**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nresource_key | 否 | 资源名，必须是UTF-8编码。如果[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)中 scope 指定为 <bucket>:<key>， 则该字段也必须指定，并且与上传凭证中的 key 一致，否则会报`403`错误。如果表单没有指定 key，可以使用上传策略[saveKey](https://developer.qiniu.com/kodo/manual/1206/put-policy#save-key)字段所指定魔法变量生成 Key，如果没有模板，则使用 Hash 值作为 Key。 \ncustom_name | 否 | [自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)的名字，不限个数。 \ncustom_value | 否 | [自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)的值。 \nupload_token | 是 | [上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)，位于 token 消息中。 \ncrc32 | 否 | 上传内容的 CRC32 校验码。如果指定此值，则七牛服务器会使用此值进行内容检验。 \naccept | 否 | 当 HTTP 请求指定 accept 头部时，七牛会返回 Content-Type 头部值。该值用于兼容低版本 IE 浏览器行为。低版本 IE 浏览器在表单上传时，返回 application/json 表示下载，返回 text/plain 才会显示返回内容。 \nfileName | 是 | 原文件名。对于没有文件名的情况，建议填入随机生成的纯文本字符串。本参数的值将作为魔法变量[$(fname)](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar-fname)的值使用。 \nfileBinaryData | 是 | 上传文件的完整内容。文件大小不超过 1GB。 \nx-qn-meta | 否 | 自定义元数据，可同时自定义多个元数据，总和大小不能超过 1024 字节。 \n \n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n {\n hash:\"xx\"\n key:\"xx\"\n }\n \n\n \n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n### **响应内容**\n\n名称 | 说明 \n---|--- \nhash | 目标资源的[hash值](https://developer.qiniu.com/kodo/manual/1231/appendix#qiniu-etag)，可用于 ETag 头部。 \n \n类型：字符串 \nkey | 目标资源的最终名字，可由七牛云存储自动命名。 \n \n类型：字符串 \n \n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **在线示例**\n\n * [JS表单上传（异步） __](https://kodo-utils.qiniu.com/upload-token?ref=developer.qiniu.com&s_path=%2Fkodo%2F1208%2Fupload-token)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储分片上传 v1 版"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 分片上传 v1 版\n\n# 分片上传 v1 版\n\n最近更新时间: 2020-12-10 20:09:27\n\n分片上传相关的接口：\n\n接口 | 说明 \n---|--- \n[mkblk](https://developer.qiniu.com/kodo/api/1286/mkblk) | 创建块 \n[bput](https://developer.qiniu.com/kodo/api/1251/bput) | 上传片 \n[mkfile](https://developer.qiniu.com/kodo/api/1287/mkfile) | 创建文件 \n \n目前历史版本 sdk 均使用 v1 版分片上传接口\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储创建块"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > [分片上传 v1\n版](https://developer.qiniu.com/kodo/api/7443/shard-to-upload) > 创建块\n\n# 创建块\n\n最近更新时间: 2024-06-04 19:06:12\n\n# **描述**\n\n本接口用于为后续分片上传创建一个新的块，同时上传第一片数据。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /mkblk/<blockSize> HTTP/1.1\n Host: <UpHost>\n Content-Type: application/octet-stream\n Content-Length: <firstChunkSize>\n Authorization: UpToken <UploadToken>\n \n <firstChunkBinary>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 类型 | 说明 \n---|---|---|--- \nblockSize | 是 | int64 | 块大小，每块均为 4MB，最后一块大小不超过 4MB。 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | 上传域名。\n* 后续七牛对象存储支持的区域和对应区域上传域名列表见 [存储区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq)\n* 后续片的上传为上一次上传响应返回的后续上传接收地址 \nContent-Type | 是 | 固定为`application/octet-stream`。 \nContent-Length | 是 | 第一个片的内容长度，单位为字节。 \nAuthorization | 是 | 该参数应严格按照[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)格式进行填充，否则会返回 401 错误码。一个合法的 Authorization 值应类似于`Authorization: UpToken QNJi_bYJlmO5LeY08FfoNj9w_r...`。 \n \n \n\n### **请求内容**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nfirstChunkBinary | 是 | 第一个片的二进制内容 \n \n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **响应内容**\n\n名称 | 说明 \n---|--- \nctx | 本次上传成功后的块级上传控制信息，用于后续[上传片(bput)](https://developer.qiniu.com/kodo/api/1251/bput)及[创建文件(mkfile)](https://developer.qiniu.com/kodo/api/1287/mkfile)。本字段是只能被七牛服务器解读使用的不透明字段，上传端不应修改其内容。每次返回的 ctx 都只对应紧随其后的下一个上传数据片，上传非对应数据片会返回 701 状态码。例如`\"ctx\":\"U1nAe4qJVwz4dYNslBCNNg...E5SEJJQQ==\"`。 \nchecksum | 上传块 sha1，使用URL安全的Base64编码，客户可通过此字段对上传块的完整性进行校验。例如`\"checksum\":\"wQ-csvpBHkZrhihcytio7HXizco=\"`。 \ncrc32 | 上传块 crc32，客户可通过此字段对上传块的完整性进行校验。例如`\"crc32\":659036110`。 \noffset | 下一个上传块在切割块中的偏移。例如`\"offset\":4194304`。 \nhost | 后续上传接收地址。例如`\"host\":\"http://upload.qiniup.com\"`。 \nexpired_at | ctx 过期时间，ctx 过期后会删除未完成[创建文件](https://developer.qiniu.com/kodo/api/1287/mkfile)的块数据。例如`\"expired_at\":1514446175`。 \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /mkblk/4194304 HTTP/1.1\n User-Agent: curl/7.30.0\n Host: upload.qiniup.com\n Accept: */*\n Authorization: UpToken QNJi_bYJlmO5LeY08FfoNj9w_r...(过长已省略)\n \n <firstChunkBinary>\n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx\n Date: Thu, 21 Dec 2017 07:29:35 GMT\n Content-Type: application/json\n Connection: keep-alive\n Cache-Control: no-store\n Content-Length: 340\n X-Log: qtbl.get;RS\n X-Reqid: swEAAMipp-5bIjMT\n \n {\n ctx: \"U1nAe4qJVwz4dYNslBCNNgE...PMXE5SEJJQQ==\", \n checksum: \"wQ-csvpBHkZrhihcytio7HXizco=\", \n crc32: 659036110, \n offset: 4194304, \n host: \"http://upload.qiniup.com\", \n expired_at: 1514446175\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储上传片"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > [分片上传 v1\n版](https://developer.qiniu.com/kodo/api/7443/shard-to-upload) > 上传片\n\n# 上传片\n\n最近更新时间: 2024-06-04 19:05:28\n\n# **描述**\n\n上传指定块的一片数据，具体数据量可根据现场环境调整。同一块的每片数据必须串行上传。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /bput/<ctx>/<nextChunkOffset> HTTP/1.1\n Host: <UpHost>\n Content-Type: application/octet-stream\n Content-Length: <nextChunkSize>\n Authorization: UpToken <UploadToken>\n \n <nextChunkBinary>\n \n\n使用说明：\n\n * 可以复用创建块时使用的[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)。\n * 上传凭证将被重新验证，若已过期，可以使用重新生成的凭证。\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 类型 | 说明 \n---|---|---|--- \nctx | 是 | string | 前一次上传返回的块级上传控制信息。 \nnextChunkOffset | 是 | int64 | 当前片在整个块中的起始偏移。 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | 上传域名。\n* 七牛对象存储支持的区域和对应区域上传域名列表见 [存储区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq)\n* 后续片的上传为上一次上传响应返回的后续上传接收地址 \nContent-Type | 是 | 固定为`application/octet-stream`。 \nContent-Length | 是 | 当前片的内容长度，单位为字节。 \nAuthorization | 是 | 该参数应严格按照[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)格式进行填充，否则会返回 401 错误码。一个合法的 Authorization 值应类似于`Authorization: UpToken QNJi_bYJlmO5LeY08FfoNj9w_r...`。 \n \n \n\n### **请求内容**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nnextChunkBinary | 是 | 当前片的二进制内容 \n \n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **响应内容**\n\n名称 | 说明 \n---|--- \nctx | 本次上传成功后的块级上传控制信息，用于后续[上传片(bput)](https://developer.qiniu.com/kodo/api/1251/bput)及[创建文件(mkfile)](https://developer.qiniu.com/kodo/api/1287/mkfile)。本字段是只能被七牛服务器解读使用的不透明字段，上传端不应修改其内容。每次返回的 ctx 都只对应紧随其后的下一个上传数据片，上传非对应数据片会返回 701 状态码。例如`\"ctx\":\"U1nAe4qJVwz4dYNslBCNNg...E5SEJJQQ==\"`。 \nchecksum | 上传块校验码。例如`\"checksum\":\"wQ-csvpBHkZrhihcytio7HXizco=\"`。 \ncrc32 | 上传块 crc32，客户可通过此字段对上传块的完整性进行校验。例如`\"crc32\":659036110`。 \noffset | 下一个上传片在上传块中的偏移。例如`\"offset\":4194304`。 \nhost | 后续上传接收地址。例如`\"host\":\"http://upload.qiniup.com\"`。 \nexpired_at | ctx 过期时间，ctx 过期后会删除未完成[创建文件](https://developer.qiniu.com/kodo/api/1287/mkfile)的块数据。例如`\"expired_at\":1514446175`。 \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储创建文件"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > [分片上传 v1\n版](https://developer.qiniu.com/kodo/api/7443/shard-to-upload) > 创建文件\n\n# 创建文件\n\n最近更新时间: 2021-11-15 18:00:02\n\n# **描述**\n\n将上传好的所有数据块按指定顺序合并成一个资源文件。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /mkfile/<fileSize>/key/<encodedKey>/fname/<encodedFname>/mimeType/<encodedMimeType>/x:user-var/<encodedUserVars> HTTP/1.1\n Host: <UpHost>\n Content-Type: text/plain\n Content-Length: <ctxListSize>\n Authorization: UpToken <UploadToken>\n \n <lastCtxOfBlock1,lastCtxOfBlock2,lastCtxOfBlock3,...,lastCtxOfBlockN>\n \n\n使用说明：\n\n * 可以复用创建块时使用的上传凭证。\n * 上传凭证将被重新验证，若已过期，可以使用重新生成的凭证。\n * 若参数中指定了资源名，而所用上传策略的[scope](https://developer.qiniu.com/kodo/manual/1206/put-policy#scope)字段中也指定了资源名，且两者不一致，操作将失败且返回 401 状态码。\n * 若参数与上传策略[scope](https://developer.qiniu.com/kodo/manual/1206/put-policy#scope)字段中未指定资源名，则需要使用[insertOnly](https://developer.qiniu.com/kodo/manual/1206/put-policy#put-policy-insert-only)字段，才能达到同名文件上传**不被覆盖** 效果。\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 类型 | 说明 \n---|---|---|--- \nfileSize | 是 | int64 | 资源文件大小，单位字节。 \nencodedKey | | string | 进行[URL 安全的 Base64 编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64)后的资源名。若未指定，则使用[saveKey](https://developer.qiniu.com/kodo/manual/1206/put-policy#save-key)；若未指定 saveKey，则使用资源内容的 SHA1 值作为资源名。 \nencodedFname | | string | 进行[URL安全的Base64编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64)后的文件名称。若未指定，则[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)中无法使用fname, ext, fprefix。 \nencodedMimeType | | string | 进行[URL 安全的 Base64 编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64)后的文件 mimeType。若未指定，则根据文件内容自动检测 mimeType。 \nencodedUserVars | | string | 指定[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)，进行[URL 安全的 Base64 编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64)后的 user-var。 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | 上传域名。\n* 七牛对象存储支持的区域和对应区域上传域名列表见 [存储区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq)\n* 后续片的上传为上一次上传响应返回的后续上传接收地址 \nContent-Type | 是 | 固定为`text/plain`。 \nContent-Length | 是 | 所有块的 ctx 及分隔符的总长度，单位为字节。 \nAuthorization | 是 | 该参数应严格按照[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)格式进行填充，否则会返回 401 错误码。一个合法的 Authorization 值应类似于`Authorization: UpToken QNJi_bYJlmO5LeY08FfoNj9w_r...`。 \n \n \n\n### **请求内容**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nlastCtxOfBlock | 是 | 每个数据块最后一个数据片上传后得到的 ctx \n \n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nrequest-headers)。\n\n \n\n### **响应内容**\n\n名称 | 说明 \n---|--- \nhash | 资源内容的 SHA1 值。 \nkey | 实际资源名。 \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储分片上传 v2 版"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 分片上传 v2 版\n\n# 分片上传 v2 版\n\n最近更新时间: 2022-09-22 11:51:06\n\nMultipart Upload相关的接口：\n\n接口 | 说明 \n---|--- \n[initiateMultipartUpload](https://developer.qiniu.com/kodo/api/6365/initialize-multipartupload) | 通知服务端开启分块上传任务,得到全局唯一任务 UploadId \n[uploadPart](https://developer.qiniu.com/kodo/api/6366/upload-part) | 分块上传数据，需指定的任务 UploadId \n[completeMultipartUpload](https://developer.qiniu.com/kodo/api/6368/complete-multipart-upload) | 完成整个文件的分块上传，需指定的任务 UploadId \n[abortMultipartUpload](https://developer.qiniu.com/kodo/api/6367/abort-multipart-upload) | 中止分块上传任务，并且删除已经上传的块，需指定的任务 UploadId \n[listParts](https://developer.qiniu.com/kodo/api/6858/listparts) | 列举指定 UploadId 所属的所有已经上传成功 Part \n \n目前支持分片上传 v2 版 SDK 情况如下：\n\nSDK | 版本 \n---|--- \n[JavaScript SDK](https://developer.qiniu.com/kodo/sdk/1283/javascript) | v3.0.0 及以上 \n[Flutter SDK](https://developer.qiniu.com/kodo/sdk/7598/flutter-sdk) | 所有版本 \n[Rust SDK](https://developer.qiniu.com/kodo/sdk/11853/rust) | 所有版本 \n[Android SDK](https://developer.qiniu.com/kodo/sdk/1236/android) | v8.1.0 及以上 \n[Objective-C SDK](https://developer.qiniu.com/kodo/sdk/1240/objc) | v8.1.0 及以上 \n[Go SDK](https://developer.qiniu.com/kodo/sdk/1238/go) | v7.8.0 及以上 \n[Java SDK](https://developer.qiniu.com/kodo/sdk/1239/java) | v7.5.0 及以上 \n[Python SDK](https://developer.qiniu.com/kodo/sdk/1242/python) | v7.4.0 及以上 \n[C/C++ SDK](https://developer.qiniu.com/kodo/1255/cpp) | v7.1.0 及以上 \n[Node.js SDK](https://developer.qiniu.com/kodo/1289/nodejs) | v7.4.0 及以上 \n[PHP SDK](https://developer.qiniu.com/kodo/1241/php) | v7.4.0 及以上 \n[c# SDK](https://developer.qiniu.com/kodo/sdk/1237/csharp) | v8.0.0 及以上 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储初始化任务"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > [分片上传 v2\n版](https://developer.qiniu.com/kodo/api/6364/multipartupload-interface) >\n初始化任务\n\n# 初始化任务\n\n最近更新时间: 2024-06-04 19:08:01\n\n# **描述**\n\n使用 Multipart Upload 方式上传数据前，必须先调用 API 来获取一个全局唯一的 UploadId ，后续的块数据通过 uploadPart\nAPI 上传，整个文件完成 completeMultipartUpload API ，已经上传块的删除 abortMultipartUpload API\n都依赖该 UploadId 。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /buckets/<BucketName>/objects/<EncodedObjectName>/uploads HTTP/1.1\n Host: <UpHost>\n Authorization: UpToken <UploadToken>\n \n\n使用说明：\n\n * 初始化 Multipart Upload 请求，并不会影响已存在的同名 Object 。\n * 同一个 Object 可以同时拥有不同的 UploadId 。\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nBucketName | 是 | 空间名称 \nEncodedObjectName | 否 | 资源名，EncodedObjectName 需要经过 Base64 编码，如果表示不设置可以使用特殊字符 `~` 。具体可以参照：[URL 安全的 Base64 编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64) \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | 上传域名。对象存储支持的区域和对应区域上传域名列表见 [存储区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq) \nAuthorization | 是 | 该参数应严格按照[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)格式进行填充，否则会返回 401 错误码。一个合法的 Authorization 值应类似于 Authorization: UpToken QNJi_bYJlmO5LeY08FfoNj9w_r… \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nresponse-headers)。\n\n \n\n### **响应内容**\n\n名称 | 类型 | 说明 \n---|---|--- \nuploadId | string | 初始化文件生成的 id \nexpireAt | int64 | UploadId 的过期时间 Unix 时间戳，过期之后 UploadId 不可用，固定 7 天有效期，过期后会删除未[完成文件上传](https://developer.qiniu.com/kodo/api/6368/complete-multipart-upload)的块数据 \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /buckets/myBucket/objects/bXlPYmplY3Q=/uploads HTTP/1.1\n Host: up.qiniup.com\n User-Agent: Go-http-client/1.1\n Authorization: UpToken j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:nP7NSSyGo4x3W_nJ8T9X1gJrgpk=\n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Wed, 18 Dec 2019 17:02:11 GMT\n Server: nginx\n X-Reqid: SFkAAAC8BDebTtsU\n \n {\n \t \"uploadId\": \"5df9ea14834c512b2270234e\",\n \t \"expireAt\": 1576659776\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储分块上传数据"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > [分片上传 v2\n版](https://developer.qiniu.com/kodo/api/6364/multipartupload-interface) >\n分块上传数据\n\n# 分块上传数据\n\n最近更新时间: 2021-11-15 18:02:00\n\n# **描述**\n\n初始化一个 Multipart Upload 任务之后，可以根据指定的 EncodedObjectName 和 UploadId 来分 Part 上传数据。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n PUT /buckets/<BucketName>/objects/<EncodedObjectName>/uploads/<UploadId>/<PartNumber> HTTP/1.1\n Host: <UpHost>\n Content-Type: application/octet-stream\n Content-MD5: <PartMd5>\n Content-Length: <Size>\n Authorization: UpToken <UploadToken>\n \n \n <PartContent>\n \n\n使用说明：\n\n * 每一个上传的 Part 都有一个标识它的号码 PartNumber，范围是 1 - 10000，单个 Part大小范围 1 MB - 1 GB。Multipart Upload 要求除最后一个 Part 以外，其他的 Part 大小都要大于等于 1 MB。因不确定是否为最后一个 Part，uploadPart API 并不会立即校验上传 Part 的大小，当 completeMultipartUpload API 调用的时候才会校验。\n * 如果你用同一个 PartNumber 上传了新的数据，那么服务端已有的这个号码的 Part 数据将被覆盖。\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nBucketName | 是 | 空间名称 \nEncodedObjectName | 否 | 资源名，EncodedObjectName 需要经过 Base64 编码。具体可以参照：[URL 安全的 Base64 编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64) \nUploadId | 是 | 在服务端申请的 Multipart Upload 任务 id \nPartNumber | 是 | 每一个上传的 Part 都有一个标识它的号码 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | 上传域名。对象存储支持的区域和对应区域上传域名列表见 [存储区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq) \nAuthorization | 是 | 该参数应严格按照[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)格式进行填充，否则会返回 401 错误码。一个合法的 Authorization 值应类似于 Authorization: UpToken QNJi_bYJlmO5LeY08FfoNj9w_r… \nContent-Type | 是 | 固定为 `application/octet-stream` \nContent-MD5 | 否 | 上传块内容的 md5 值，如果指定服务端会进行校验，不指定不校验 \nContent-Length | 是 | 上传块大小，单位字节 \n \n \n\n### **请求内容**\n\n该请求操作的请求体块的内容。\n\n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nresponse-headers)。\n\n \n\n### **响应内容**\n\n名称 | 类型 | 说明 \n---|---|--- \netag | string | 上传块内容的 etag ，用来标识块，completeMultipartUpload API 调用的时候作为参数进行文件合成 \nmd5 | string | 上传块内容的 md5 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n612 | 目标资源不存在，当请求的 UploadId 不存在或者已经 complete 过的，都会返回 { “error” : “no such uploadId” } \n406 | 服务端校验失败，服务端收到数据与用户指定校验值不一致，当指定 Content-MD5 与服务端收到数据不一致，返回 { “error” : “hash not match” } \n400 | 不符合要求的 PartNumber，会返回 { “error” : “partNum should be set from 1 to 10000” } \n \n \n\n# **示例**\n\n### **请求示例**\n\n \n \n PUT /buckets/myBucket/objects/bXlPYmplY3Q=/uploads/myUploadID/1 HTTP/1.1\n Host: up.qiniup.com\n User-Agent: Go-http-client/1.1\n Content-Length: 200\n Authorization: UpToken j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:nP7NSSyGo4x3W_nJ8T9X1gJrgpk=\n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Wed, 18 Dec 2019 17:02:11 GMT\n Server: nginx\n X-Reqid: SFkAAAC8BDebTtsU\n \n {\n \t\"etag\": \"FqvtxHpe3j-rEzkImMUWDsmvu27D\",\n \t\"md5\": \"4f4acc5d8c71f5fbf04dace00b5360c8\"\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储完成文件上传"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > [分片上传 v2\n版](https://developer.qiniu.com/kodo/api/6364/multipartupload-interface) >\n完成文件上传\n\n# 完成文件上传\n\n最近更新时间: 2021-11-12 16:29:01\n\n# **描述**\n\n在将所有数据 Part 都上传完成后，必须调用 completeMultipartUpload API 来完成整个文件的 Multipart\nUpload。用户需要提供有效数据的 Part 列表（ 包括 PartNumber 和调用 uploadPart API 服务端返回的 Etag\n）。服务端收到用户提交的 Part 列表后，会逐一验证每个数据 Part 的有效性。当所有的数据 Part 验证通过后，会把这些数据 Part\n组合成一个完整的 Object。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /buckets/<BucketName>/objects/<EncodedObjectName>/uploads/<UploadId> HTTP/1.1\n Host: <UpHost>\n Content-Type: application/json\n Authorization: UpToken <UploadToken>\n \n {\n \"parts\": [{ \"etag\": \"<Etag>\", \"partNumber\": <PartNumber> }, ...],\n \"fname\": \"<Fname>\",\n \"mimeType\": \"<MimeType>\",\n \"metadata\": {\"x-qn-meta-<MetaKey>\": \"<MetaValue>\", ...},\n \"customVars\": {\"x:<CustomVarKey>\": \"<CustomVarValue>\", ...}\n }\n \n\n使用说明：\n\n * completeMultipartUpload 时会确认除最后一块以外所有块的大小是否都大于等于 1 MB ，并检查用户提交的 Part 列表中的每一个 PartNumber 和 Etag 。\n * 用户提交的 Part 列表中，Part 号码可以不连续，但必须是升序。\n * 服务端处理 completeMultipartUpload 请求成功后，该 UploadId 就会变成无效，再次请求与该 UploadId 相关操作都会失败。\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nBucketName | 是 | 空间名称 \nEncodedObjectName | 否 | 资源名，EncodedObjectName 需要经过 Base64 编码。具体可以参照：[URL 安全的 Base64 编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64) \nUploadId | 是 | 在服务端申请的 MultipartUpload 任务 id \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | 上传域名。七牛对象存储支持的区域和对应区域上传域名列表见 [存储区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq) \nAuthorization | 是 | 该参数应严格按照[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)格式进行填充，否则会返回 401 错误码。一个合法的 Authorization 值应类似于 Authorization: UpToken QNJi_bYJlmO5LeY08FfoNj9w_r… \nContent-Type | 是 | 固定为 `application/json` \n \n \n\n### **请求内容**\n\n参数名称 | 类型 | 必填 | 说明 \n---|---|---|--- \nparts | Array | 是 | 已经上传 Part 列表 （ 包括 PartNumber （ int ）和调用 uploadPart API 服务端返回的 Etag （ string ）） \nfname | string | 否 | 上传的原始文件名， 若未指定，则魔法变量中无法使用 fname，ext，suffix \nmimeType | string | 否 | 若指定了则设置上传文件的 mimeType， 若未指定，则根据文件内容自动检测 mimeType \nmetadata | - | 否 | 用户自定义文件 metadata 信息的 key 和 value， 可以设置多个，MetaKey 和 MetaValue 都是 string，其中 可以由字母、数字、下划线、减号组成，且长度小于等于 50，单个文件 MetaKey 和 Metavalue 总和大小不能超过 1024 字节 \ncustomVars | - | 否 | [用户自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars)，CustomVarKey 和 CustomVarValue 都是 string \n \n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nresponse-headers)。\n\n \n\n### **响应内容**\n\n名称 | 类型 | 说明 \n---|---|--- \nkey | string | 资源名称 \nhash | string | 目标资源的 hash 值，可用于 Etag 头部 \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n### **上传策略特殊说明**\n\n该操作的实现不支持上传策略中 \" returnUrl \"\n，请查阅[上传策略](https://developer.qiniu.com/kodo/manual/1206/put-policy)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /buckets/myBucket/objects/bXlPYmplY3Q=/uploads/myUploadId HTTP/1.1\n Host: up.qiniup.com\n Content-Type: application/json\n Authorization: UpToken <UploadToken>\n \n {\n \t\"parts\": [\n \t\t{\n \t\t\t\"partNumber\": 1,\n \t\t\t\"etag\": \"FqvtxHpe3j-rEzkImMUWDsmvu27D\"\n \t\t}\n \t],\n \t\"mimeType\": \"\"\n }\n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Wed, 18 Dec 2019 17:02:11 GMT\n Server: nginx\n X-Reqid: SFkAAAC8BDebTtsU\n \n {\n \t\"hash\": \"FqvtxHpe3j-rEzkImMUWDsmvu27D\",\n \t\"key\": \"myObject\"\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储终止上传"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > [分片上传 v2\n版](https://developer.qiniu.com/kodo/api/6364/multipartupload-interface) > 终止上传\n\n# 终止上传\n\n最近更新时间: 2021-11-12 16:29:39\n\n# **描述**\n\n该接口根据 UploadId 终止 Multipart Upload 。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n DELETE /buckets/<BucketName>/objects/<EncodedObjectName>/uploads/<UploadId> HTTP/1.1\n Host: <UpHost>\n Authorization: UpToken <UploadToken>\n \n\n使用说明：\n\n * 当调用该 API 终止 Multipart Upload 后，无法再使用这个 UploadId 做任何操作，已经上传的 Part 数据也会被删除。\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nBucketName | 是 | 空间名称 \nEncodedObjectName | 否 | 资源名，EncodedObjectName 需要经过 Base64 编码。具体可以参照：[URL 安全的 Base64 编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64) \nUploadId | 是 | 在服务端申请的 Multipart Upload 任务 id \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | 上传域名。七牛对象存储支持的区域和对应区域上传域名列表见 [存储区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq) \nAuthorization | 是 | 该参数应严格按照[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)格式进行填充，否则会返回 401 错误码。一个合法的 Authorization 值应类似于 Authorization: UpToken QNJi_bYJlmO5LeY08FfoNj9w_r… \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nresponse-headers)。\n\n \n\n### **响应内容**\n\n该请求操作的响应体为空。\n\n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n DELETE /buckets/myBucket/objects/bXlPYmplY3Q=/uploads/myUploadID/1 HTTP/1.1\n Host: up.qiniup.com\n Authorization: UpToken j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:nP7NSSyGo4x3W_nJ8T9X1gJrgpk=\n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Wed, 18 Dec 2019 17:02:11 GMT\n Server: nginx\n X-Reqid: SFkAAAC8BDebTtsU\n \n {\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储列举已上传分片"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > [分片上传 v2\n版](https://developer.qiniu.com/kodo/api/6364/multipartupload-interface) >\n列举已上传分片\n\n# 列举已上传分片\n\n最近更新时间: 2021-11-12 16:30:07\n\n# **描述**\n\nAPI 可列举出指定 UploadId 所属任务所有已经上传成功 Part。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n GET /buckets/<BucketName>/objects/<EncodedObjectName>/uploads/<UploadId>?max-parts=<MaxParts>&part-number-marker=<PartNumberMarker> HTTP/1.1\n Host: <UpHost>\n Authorization: UpToken <UploadToken>\n \n\n使用说明：\n\n * 返回结果按照 PartNumber 升序排列。\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 类型 | 说明 \n---|---|---|--- \nBucketName | 是 | 字符串 | 空间名称 \nEncodedObjectName | 否 | 字符串 | 资源名，EncodedObjectName 需要经过 Base64 编码。具体可以参照：[URL 安全的 Base64 编码](https://developer.qiniu.com/kodo/manual/1231/appendix#urlsafe-base64) \nUploadId | 是 | 字符串 | 在服务端申请的 Multipart Upload 任务 id \nmax-parts | 否 | 整数 | 响应中的最大 Part 数目。默认值 ：1,000，最大值 ：1,000 \npart-number-marker | 否 | 整数 | 指定列举的起始位置，只有 PartNumber 值大于该参数的 Part 会被列出。默认值 ：无 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | 上传域名。七牛对象存储支持的区域和对应区域上传域名列表见 [存储区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq) \nAuthorization | 是 | 该参数应严格按照[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)格式进行填充，否则会返回 401 错误码。一个合法的 Authorization 值应类似于 Authorization: UpToken QNJi_bYJlmO5LeY08FfoNj9w_r… \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应头**\n\n该请求操作的实现使用了所有操作的公共响应头。有关详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-\nresponse-headers)。\n\n \n\n### **响应内容**\n\n名称 | 类型 | 说明 \n---|---|--- \nuploadId | string | 初始化文件生成的 id \nexpireAt | int64 | UploadId 的过期时间 Unix 时间戳，过期之后 UploadId 不可用，固定 7 天有效期 \npartNumberMarker | int | 下次继续列举的起始位置，0 表示列举结束，没有更多分片 \nparts | Array | 已经上传 Part 列表（ 包括 PartNumber（ int ）、调用 uploadPart API服务端返回的 Etag（ string ）、分片大小 Size ( int64 )和分片上传时间 Unix 时间戳 PutTime ( int64 ) ) \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n GET /buckets/myBucket/objects/bXlPYmplY3Q=/uploads/myUploadID?max-parts=2 HTTP/1.1\n Host: up.qiniup.com\n Authorization: UpToken j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:nP7NSSyGo4x3W_nJ8T9X1gJrgpk=\n \n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 2\n Connection: keep-alive\n Content-Type: application/json\n Date: Wed, 18 Dec 2019 17:02:11 GMT\n Server: nginx\n X-Reqid: SFkAAAC8BDebTtsU\n \n {\n \t\"uploadId\": \"myUploadID\",\n \t\"expireAt\": 1590725318,\n \t\"partNumberMarker\": 3,\n \t\"parts\": [\n \t\t{\n \t\t\t\"size\": 4,\n \t\t\t\"etag\": \"FqlKj-XMsZumHEwIc9OR6YeYL7vT\",\n \t\t\t\"partNumber\": 1,\n \t\t\t\"putTime\": 1590725018\n \t\t},\n \t\t{\n \t\t\t\"size\": 9,\n \t\t\t\"etag\": \"FqvtxHpe3j-rEzkImMUWDsmvu27D\",\n \t\t\t\"partNumber\": 3,\n \t\t\t\"putTime\": 1590725019\n \t\t}\n \t]\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储资源列举"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 资源列举\n\n# 资源列举\n\n最近更新时间: 2024-07-18 20:51:12\n\n# **描述**\n\n本接口用于列举指定空间里的所有文件条目。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n GET /list?bucket=<Bucket>&marker=<Marker>&limit=<Limit>&prefix=<UrlEncodedPrefix>&delimiter=<UrlEncodedDelimiter> HTTP/1.1\n Host: rsf.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nbucket | 是 | 指定空间。 \nmarker | 否 | 上一次列举返回的位置标记，作为本次列举的起点信息。默认值为空字符串。 \nlimit | 否 | 本次列举的条目数，范围为1-1000。默认值为1000。 \nprefix | 否 | 指定前缀，只有资源名匹配该前缀的资源会被列出。默认值为空字符串。 \ndelimiter | 否 | 指定目录分隔符，列出所有公共前缀（模拟列出目录效果）。默认值为空字符串。 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \n`Authorization` | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回401错误码一个合法的Authorization值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 该请求操作的实现使用了所有操作的公共请求头。详情请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 该请求实现使用了所有操作的公共响应头。详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n字段名称 | 必响应项目 | 说明 \n---|---|--- \nmarker | 是 | 起始条目标记，将作为下一次列举的参数传入。如果没有剩余条目则返回空字符串。 \n \n类型：字符串 \ncommonPrefixes | 是 | 返回目录名的数组，如没有指定`delimiter`参数则返回空。 \n \n类型：数组 \nitems | 是 | 返回条目的数组。不能用来判断是否还有剩余条目。 \n \n类型：数组 \nkey | 是 | 资源名。 \n \n类型：字符串 \nputTime | 是 | 上传时间，单位：100纳秒，其值去掉低七位即为[Unix时间戳](https://developer.qiniu.com/kodo/glossary/1647/u)。 \n \n类型：数字 \nhash | 是 | 文件的`HASH`值，暨文件的七牛 ETag 值。 \n \n类型：字符串 \nfsize | 是 | 资源内容的大小，单位：字节。 \n \n类型：数字 \nmimeType | 是 | 资源的 MIME 类型。 \n \n类型：字符串 \nendUser | 否 | 资源内容的唯一属主标识，请参考[上传策略 (PutPolicy)](https://developer.qiniu.com/kodo/manual/1206/put-policy)。 \n \n类型：字符串 \ntype | 是 | 资源的存储类型，`0`表示标准存储，`1` 表示[低频存储](https://developer.qiniu.com/kodo/3956/kodo-category#IA)，`2` 表示[归档存储](https://developer.qiniu.com/kodo/3956/kodo-category#archive)，`3` 表示[深度归档存储](https://developer.qiniu.com/kodo/3956/kodo-category#deep_archive)，`4` 表示[归档直读存储](https://developer.qiniu.com/kodo/3956/kodo-category#archive_ir)。 \n \n类型：数字 \nstatus | 是 | 文件的存储状态，即禁用状态和启用状态间的的互相转换，`0`表示启用，`1`表示禁用，请参考：[文件状态](https://developer.qiniu.com/kodo/api/4173/modify-the-file-status)。 \n \n类型：数字 \nmd5 | 否 | 文件`md5`值，32位16进制组成的字符串，只有通过直传文件和追加文件API上传的文件，服务端确保有该字段返回，如请求时服务端没有返回md5字段，可以通过请求qhash/md5 方法来获取，比如 http://test.com/test.mp4?qhash/md5 \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。\n\n \n\n# **示例**\n\n### **列出所有 00 打头的资源**\n\n### **请求示例**\n\n \n \n GET /list?bucket=test02&prefix=00 HTTP/1.1\n Host: rsf.qiniuapi.com\n User-Agent: Go-http-client/1.1\n X-Qiniu-Date: 20171122T014120Z\n Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:XvRh0ABLViTohBkgKqa0upyiug0=\n Content-Type: application/x-www-form-urlencoded\n Accept-Encoding: gzip\n \n\n_注：要在`Authorization`头部的`<AccessToken>`前添加`Qiniu`和半角空格。_\n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 739\n Connection: keep-alive\n Content-Type: application/json\n Date: Wed, 22 Nov 2017 01:41:20 GMT\n Server: nginx\n X-Reqid: QBUAAKUcoGrgRPkU\n X-Reqid: QBUAAKUcoGrgRPkU\n X-Reqid: QBUAAKUcoGrgRPkU.peer\n \n {\n \"items\": [\n {\n \"key\": \"000001.pdf\", \n \"hash\": \"Fs3oFOyOFDUp5CEODM8J6xquSq3s\", \n \"fsize\": 452584, \n \"mimeType\": \"application/pdf\", \n \"putTime\": 15112568720620784, \n \t \"md5\": \"e41714a18899cf59c200a9bddfa78b95\",\n \"type\": 0, \n \"status\": 0\n }, \n {\n \"key\": \"000002.ico\", \n \"hash\": \"FpGrGHQOjETYnwxmSF3uXmFpmZIb\", \n \"fsize\": 5686, \n \"mimeType\": \"image/x-icon\", \n \"putTime\": 15112568850754920, \n \"type\": 0, \n \"status\": 0\n }, \n {\n \"key\": \"000003.png\", \n \"hash\": \"FreZ58OmkQe5ZRUktRsO3zoqRaHi\", \n \"fsize\": 21741, \n \"mimeType\": \"image/png\", \n \"putTime\": 15112568948976712, \n \"type\": 0, \n \"status\": 0\n }, \n {\n \"key\": \"000004.png\", \n \"hash\": \"FreZ58OmkQe5ZRUktRsO3zoqRaHi\", \n \"fsize\": 21741, \n \"mimeType\": \"image/png\", \n \"putTime\": 15112569033603324, \n \"type\": 0, \n \"status\": 0\n }\n ]\n }\n \n\n \n\n### **列出所有 00 打头的资源并每批 2 个**\n\n### **请求示例**\n\n \n \n GET /list?bucket=test02&prefix=00&limit=2 HTTP/1.1\n Host: rsf.qiniuapi.com\n User-Agent: Go-http-client/1.1\n Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:m-2lEHcnRVwgYBqJdC5SW7groT8=\n Content-Type: application/x-www-form-urlencoded\n Accept-Encoding: gzip\n \n\n_注：要在`Authorization`头部的`<AccessToken>`前添加`Qiniu`和半角空格。_\n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 352\n Connection: keep-alive\n Content-Type: application/json\n Date: Wed, 22 Nov 2017 01:46:58 GMT\n Server: nginx\n X-Log: TBLMGR:10;UC:21;CFGG:22;RSF:90;RSF:92;ZONEPROXY:148\n X-Reqid: pEYAABGkVfAuRfkU\n X-Reqid: pEYAABGkVfAuRfkU\n X-Reqid: pEYAABGkVfAuRfkU.peer\n \n {\n \"marker\": \"eyJjIjowLCJrIjoiMDAwMDAyLmljbyJ9\", \n \"items\": [\n {\n \"key\": \"000001.pdf\", \n \"hash\": \"Fs3oFOyOFDUp5CEODM8J6xquSq3s\", \n \"fsize\": 452584, \n \"mimeType\": \"application/pdf\", \n \"putTime\": 15112568720620784, \n \"type\": 0, \n \"status\": 0\n }, \n {\n \"key\": \"000002.ico\", \n \"hash\": \"FpGrGHQOjETYnwxmSF3uXmFpmZIb\", \n \"fsize\": 5686, \n \"mimeType\": \"image/x-icon\", \n \"putTime\": 15112568850754920, \n \"type\": 0, \n \"status\": 0\n }\n ]\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储资源元信息查询"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 资源元信息查询\n\n# 资源元信息查询\n\n最近更新时间: 2024-08-12 15:49:34\n\n# **描述**\n\n本接口仅用于获取资源的 `Metadata` 信息，不返回资源内容。 \n \n\n# **请求**\n\n### **请求语法**\n\n \n \n GET /stat/<EncodedEntryURI> HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nEncodedEntryURI | 是 | 具体请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \n`Authorization` | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回401错误码一个合法的 Authorization 值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 该请求操作的实现使用了所有操作的公共请求头。详情请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 该请求操作的实现使用了所有操作的公共响应头。详情请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n字段名称 | 必填 | 说明 \n---|---|--- \nfsize | 是 | 文件大小，int64 类型，单位为字节（Byte）。 \nhash | 是 | 文件`HASH`值，string 类型。 \nmimeType | 是 | 文件`MIME`类型，string 类型。 \ntype | 是 | 文件存储类型，uint32 类型，`0`表示标准存储，`1` 表示[低频存储](https://developer.qiniu.com/kodo/3956/kodo-category#IA)，`2` 表示[归档存储](https://developer.qiniu.com/kodo/3956/kodo-category#archive)，`3` 表示[深度归档存储](https://developer.qiniu.com/kodo/3956/kodo-category#deep_archive)，`4` 表示[归档直读存储](https://developer.qiniu.com/kodo/3956/kodo-category#archive_ir)、`5` 表示[智能分层存储](https://developer.qiniu.com/kodo/12747/storage-class-intelligent-tiering)。 \nputTime | 是 | 文件上传时间，int64 类型，[Unix时间戳](https://developer.qiniu.com/kodo/glossary/1647/u)格式，单位为 100 纳秒。例如：值为`13603956734587420`的时间，对应的实际时间为`2013-02-09 15:41:13`。 \nrestoreStatus | 否 | 归档/深度归档存储文件的解冻状态，uint32 类型，`2`表示解冻完成，`1`表示解冻中；归档/深度归档文件冻结时，不返回该字段。 \nx-qn-meta | 否 | 自定义元数据，含 `meta_key` 参数 及对应 `metaValue` 值；仅当自定义元数据后返回该字段。 \nstatus | 否 | 文件状态，uint32 类型。`1` 表示禁用；只有禁用状态的文件才会返回该字段。 \nmd5 | 否 | 文件 `md5` 值，string 类型，32 位 16 进制组成的字符串，只有通过直传文件和追加文件 API 上传的文件，服务端确保有该字段返回，如请求时服务端没有返回 md5 字段，可以通过请求 qhash/md5 方法来获取，比如 http://test.com/test.mp4?qhash/md5 \nexpiration | 否 | 文件过期删除日期，int64 类型，Unix 时间戳格式，具体文件过期日期计算参考 [生命周期管理](https://developer.qiniu.com/kodo/manual/3699/life-cycle-management)。文件在设置过期时间后才会返回该字段（通过生命周期规则设置文件过期时间，仅对该功能发布后满足规则条件新上传文件返回该字段；历史文件想要返回该字段需要在功能发布后可通过 [修改文件过期删除时间 API](https://developer.qiniu.com/kodo/api/1732/update-file-lifecycle) 或者 [修改文件生命周期 API](https://developer.qiniu.com/kodo/8062/modify-object-life-cycle) 指定过期时间；对于已经设置过过期时间的历史文件，到期都会正常过期删除，只是服务端没有该字段返回) 例如：值为`1568736000`的时间，表示文件会在`2019/9/18`当天内删除。 \ntransitionToIA | 否 | 文件生命周期中转为低频存储的日期，int64 类型，Unix 时间戳格式 ，具体日期计算参考 [生命周期管理](https://developer.qiniu.com/kodo/manual/3699/life-cycle-management)。文件在设置转低频后才会返回该字段（通过生命周期规则设置文件转低频，仅对该功能发布后满足规则条件新上传文件返回该字段；历史文件想要返回该字段需要在功能发布后可通过 [修改文件生命周期 API](https://developer.qiniu.com/kodo/8062/modify-object-life-cycle) 指定转低频时间；对于已经设置过转低频时间的历史文件，到期都会正常执行，只是服务端没有该字段返回) 例如：值为`1568736000`的时间，表示文件会在`2019/9/18`当天转为低频存储类型。 \ntransitionToIntelligentTiering | 否 | 文件生命周期中转为智能分层存储的日期，int64 类型，Unix 时间戳格式 ，具体日期计算参考 [生命周期管理](https://developer.qiniu.com/kodo/manual/3699/life-cycle-management)。文件在设置转智能分层后才会返回该字段 例如：值为`1568736000`的时间，表示文件会在`2021/9/18`当天转为智能分层存储类型。 \ntransitionToArchiveIR | 否 | 文件生命周期中转为归档直读存储的日期，int64 类型，Unix 时间戳格式 ，具体日期计算参考 [生命周期管理](https://developer.qiniu.com/kodo/manual/3699/life-cycle-management)。文件在设置转归档后才会返回该字段 例如：值为`1568736000`的时间，表示文件会在`2019/9/18`当天转为归档直读存储类型。 \ntransitionToARCHIVE | 否 | 文件生命周期中转为归档存储的日期，int64 类型，Unix 时间戳格式 ，具体日期计算参考 [生命周期管理](https://developer.qiniu.com/kodo/manual/3699/life-cycle-management)。文件在设置转归档后才会返回该字段（通过生命周期规则设置文件转归档，仅对该功能发布后满足规则条件新上传文件返回该字段；历史文件想要返回该字段需要在功能发布后可通过 [修改文件生命周期 API](https://developer.qiniu.com/kodo/8062/modify-object-life-cycle) 指定转归档时间；对于已经设置过转归档时间的历史文件，到期都会正常执行，只是服务端没有该字段返回) 例如：值为`1568736000`的时间，表示文件会在`2019/9/18`当天转为归档存储类型。 \ntransitionToDeepArchive | 否 | 文件生命周期中转为深度归档存储的日期，int64 类型，Unix 时间戳格式 ，具体日期计算参考 [生命周期管理](https://developer.qiniu.com/kodo/manual/3699/life-cycle-management)。文件在设置转深度归档后才会返回该字段 例如：值为`1568736000`的时间，表示文件会在`2019/9/18`当天转为深度归档存储类型。 \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。 \n \n\n# **示例**\n\n### **请求示例**\n\n \n \n GET /stat/ZGVtbzoyMDEzLTAyLTA5LTA3LTM5LTIwLmpwZw== HTTP/1.1\n User-Agent: curl/7.30.0\n Host: rs.qiniuapi.com\n Accept: */*\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r72Vsn...(过长已省略)\n \n\n_注：要在`Authorization`头部的`<AccessToken>`前添加`Qiniu`和半角空格。_\n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx/1.0.8\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Connection: keep-alive\n Cache-Control: no-store\n Content-Length: 121\n X-Log: qtbl.get;RS\n X-Reqid: swEAAMipp-5bIjMT\n \n {\n \t\"fsize\": 5122935,\n \t\"hash\": \"ljfockr0lOil_bZfyaI2ZY78HWoH\",\n \t\"mimeType\": \"application/octet-stream\",\n \t\"putTime\": 13603956734587420,\n \t\"md5\": \"e41714a18899cf59c200a9bddfa78b95\"\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储资源元信息修改"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 资源元信息修改\n\n# 资源元信息修改\n\n最近更新时间: 2023-03-02 18:57:34\n\n# **描述**\n\n本接口用于修改文件的 MIME 类型信息。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /chgm/<EncodedEntryURI>/mime/<EncodedMimeType>/x-qn-meta-<meta_key>/<EncodedMetaValue>/cond/<Encodedcond> HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n使用说明：\n\n * 归档/深度归档存储文件，只有解冻状态时可以修改 MIME 类型信息\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nEncodedEntryURI | 是 | 指定文件信息，具体请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \nEncodedMimeType | 否 | 自定义新的 mimeType，需要经过 Base64 编码，具体请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \n`mimetype` 命名规则： \n\\- 支持包括如下字符集：`a-z`, `A-Z`, `0-9`, `.`, `+`, `/`, `-`, `;`, `=`, `,`, `_`和空格 \n\\- 最大长度为 200 字节 \n\\- `mimetype`为空这里认为合法，因为如果为空后面会进一步检测并设置 \n\\- `mimetype`可以包括空格，例如：`text/plain`; `charset=iso-8859-1` \n\\- 禁止转义，如 `%0A` 表示 `\\n`，所以禁止出现 `%` \nmeta_key | 否 | 自定义新的 meta_key \n命名规则： \n\\- 支持字母、数字、下划线、减号组成 \n\\- 最大长度限制 50 字节 \n\\- 单个文件 meta_key 和 metaValue 总和大小不能超过 1024 字节 \n\\- 可以同时修改多个 meta 字段 \nEncodedMetaValue | 否 | 自定义元数据信息，需要经过 Base64 编码，具体请参考 [EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \n命名规则： \n\\- metaValue 规则和 mimeType 相同 \n\\- 单个文件 meta_key 和 metaValue 总和大小不能超过 1024 字节 \n\\- 可以同时修改多个 meta 字段 \nEncodedcond | 否 | 自定义条件信息，需要经过 Base64 编码，具体请参考 [EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \n当前支持设置 hash、mime、fsize、putTime 条件，只有条件匹配才会执行修改操作 \ncond 支持 condKey1=condVal1&condKey2=condVal2 格式 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \n`Authorization` | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回401错误码一个合法的Authorization值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他有关详细信息 | | 请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。\n\n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n \n\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 其它可能返回的头部信息，请参考[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，不返回任何内容。 \n如果请求失败，返回包含如下内容的 JSON 字符串（已格式化，便于阅读）：\n\n \n \n {\n \"error\": \"<errMsg string>\",\n }\n \n\n字段名称 | 必填 | 说明 \n---|---|--- \nerror | 是 | 与 HTTP 状态码对应的消息文本 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 更改成功 \n400 | 请求报文格式错误 \n当`<EncodedEntryURI>`解析失败，返回`400 Bad Request {\"error\":\"invalid argument\"}` \n当`<EncodedEntryURI>`不符合UTF-8编码，返回`400 Bad Request {\"error\":\"key must be utf8\nencoding\"}` \n当`mimeType`不合法时，返回`400 Bad Request {\"error\":\"Invalid mimeType\"}` \n401 | 管理凭证无效 \n403 | 禁止操作 \n当归档存储文件未解冻完成调用接口会返回`403 ArchiveUnrestored {\"error\":\"archive unrestored\"}` \n当深度归档存储文件未解冻完成调用接口会返回`403 DeepArchiveUnrestored {\"error\":\"deep archive\nunrestored\"}` \n612 | 目标资源不存在 \n613 | 当`cond`条件不满足时，返回`613 {\"error\": \"cond not match\"}` \n599 | 服务端操作失败 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇 599 错误，请将完整错误信息（包括所有 HTTP 响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /chgm/YnVja2V0OmtleQ==/x-qn-meta-meta_key/bWV0YV92YWx1ZQ==/cond/ZnNpemU9Ng== HTTP/1.1\n Host: rs.qiniuapi.com\n User-Agent: Go-http-client/1.1\n Content-Length: 0\n Authorization: Qiniu EmEtww5prO5pe8ts_mG.......1tXlEQ9hoG4:LuGCwpfK-rM=\n X-Qiniu-Date: 20060102T150405Z\n Content-Type: application/x-www-form-urlencoded\n Accept-Encoding: gzip\n \n\n_注：要在`Authorization` 头部的 `<AccessToken>` 前添加 `Qiniu` 和半角空格。_ \n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Content-Length: 0\n Connection: keep-alive\n X-Reqid: -nIAABnfaeIlucoU\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储资源移动／重命名"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 资源移动／重命名\n\n# 资源移动／重命名\n\n最近更新时间: 2023-03-02 18:57:57\n\n# **描述**\n\n本接口用于将源空间的指定文件移动到目标空间，或在同一空间内对文件重命名。 \n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /move/<EncodedEntryURISrc>/<EncodedEntryURIDest>/force/<true|false> \n HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n使用说明:\n\n * 源空间和目标空间必须属于相同账号，不支持跨账号移动文件\n * 文件不支持跨存储区域 move\n * 归档/深度归档存储文件，只有解冻状态才允许调用本接口。move 获得的目标文件为冻结状态。\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nEncodedEntryURISrc | 是 | 源文件，需要经过 Base64 编码，具体请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \nEncodedEntryURIDest | 是 | 目标文件，需要经过 Base64 编码，具体请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \nforce | 否 | bool 类型，默认 false。如果目标文件名已被占用，则返回错误码 614，且不做任何覆盖操作；如果指定为 true，会强制覆盖目标文件 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \n`Authorization` | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回401错误码一个合法的Authorization值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 该请求操作的实现使用了所有操作的公共请求头。详情请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。 \n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n \n\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 该请求实现使用了所有操作的公共响应头。详细信息，请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，不返回任何内容。 \n如果请求失败，返回包含如下内容的 JSON 字符串（已格式化，便于阅读）：\n\n \n \n {\n \"error\": \"<errMsg string>\",\n }\n \n\n字段名称 | 必填 | 说明 \n---|---|--- \nerror | 是 | 与 HTTP 状态码对应的消息文本 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 移动成功 \n400 | 请求报文格式错误 \n401 | 管理凭证无效 \n403 | 禁止操作 \n当归档存储文件未解冻完成调用接口会返回`403 ArchiveUnrestored {\"error\":\"archive unrestored\"}` \n当深度归档存储文件未解冻完成调用接口会返回`403 DeepArchiveUnrestored {\"error\":\"deep archive\nunrestored\"}` \n599 | 服务端操作失败 \n612 | 待移动文件不存在 \n614 | 目标文件已存在 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇 599 错误，请将完整错误信息（包括所有 HTTP 响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /move/bmV3ZG9jczpmaW5kX21hbi50eHQ=/bmV3ZG9jczpmaW5kLm1hbi50eHQ= HTTP/1.1\n User-Agent: curl/7.30.0\n Host: rs.qiniuapi.com\n Accept: */*\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu u8WqmQu1jH21kxpIQmo2LqntzugM1VoHE9_pozCU:2LJIG...(过长已省略)\n \n\n_注：要在`Authorization`头部的`<AccessToken>`前添加`Qiniu`和半角空格。_ \n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx/1.0.8\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Connection: keep-alive\n Content-Length: 0\n X-Reqid: wxIAAD3btw-v3TwT\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储资源复制"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 资源复制\n\n# 资源复制\n\n最近更新时间: 2023-03-02 18:58:09\n\n# **描述**\n\n本接口用于将指定文件复制为新命名文件。 \n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /copy/<EncodedEntryURISrc>/<EncodedEntryURIDest>/force/<true|false> \n HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n使用说明：\n\n * 源空间和目标空间必须属于相同账号，跨账号复制文件不支持。\n * 文件不支持跨存储区域复制。\n * 归档/深度归档存储文件，只有解冻状态时可以复制。copy 获得的目标文件为冻结状态。 \n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nEncodedEntryURISrc | 是 | 源文件，需要经过 Base64 编码，具体请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \nEncodedEntryURIDest | 是 | 目标文件，需要经过 Base64 编码，具体请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \nforce | 否 | bool 类型，默认 false。如果目标文件名已被占用，则返回错误码 614，且不做任何覆盖操作；如果指定为 true，会强制覆盖目标文件 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \n`Authorization` | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回 401 错误码一个合法的 Authorization 值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 该请求操作的实现使用了所有操作的公共请求头。详情请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。 \n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 该请求操作的实现使用了所有操作的公共响应头。详情请查阅[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，不返回任何内容。 \n如果请求失败，返回包含如下内容的 JSON 字符串（已格式化，便于阅读）：\n\n \n \n {\n \"error\": \"<errMsg string>\",\n }\n \n\n字段名称 | 必填 | 说明 \n---|---|--- \nerror | 是 | 与 HTTP 状态码对应的消息文本 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 复制成功 \n400 | 请求报文格式错误 \n401 | 管理凭证无效 \n403 | 禁止操作 \n当归档存储文件未解冻完成时调用接口会返回`403 ArchiveUnrestored {\"error\":\"archive unrestored\"}` \n当深度归档存储文件未解冻完成时调用接口会返回`403 DeepArchiveUnrestored {\"error\":\"deep archive\nunrestored\"}` \n599 | 服务端操作失败 \n612 | 待复制文件不存在 \n614 | 目标文件已存在 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇599错误，请将完整错误信息（包括所有HTTP响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /copy/bmV3ZG9jczpmaW5kX21hbi50eHQ=/bmV3ZG9jczpmaW5kLm1hbi50eHQ= HTTP/1.1\n User-Agent: curl/7.30.0\n Host: rs.qinuapi.com\n Accept: */*\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu u8WqmQu1jH21kxpIQmo2LqntzugM1VoHE9_pozCU:2LJIG...(过长已省略)\n \n\n_注: 要在`Authorization`头部的`<AccessToken>`前添加`Qiniu`和半角空格。_ \n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx/1.0.8\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Connection: keep-alive\n Content-Length: 0\n X-Reqid: wxIAAD3btw-v3TwT\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储资源删除"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 资源删除\n\n# 资源删除\n\n最近更新时间: 2023-03-02 18:58:19\n\n# **描述**\n\n本接口用于删除指定文件。 \n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /delete/<EncodedEntryURI> HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nEncodedEntryURI | 是 | 指定文件信息，详情请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \n`Authorization` | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回401错误码一个合法的Authorization值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 该请求操作的实现使用了所有操作的公共请求头。详情请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n# 响应\n\n## 响应语法\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 其它可能返回的头部信息，请参考[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，不返回任何内容。 \n如果请求失败，返回包含如下内容的 JSON 字符串（已格式化，便于阅读）：\n\n \n \n {\n \"error\": \"<errMsg string>\",\n }\n \n\n字段名称 | 必填 | 说明 \n---|---|--- \nerror | 是 | 与 HTTP 状态码对应的消息文本 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 删除成功 \n400 | 请求报文格式错误 \n401 | 管理凭证无效 \n599 | 服务端操作失败 \n612 | 待删除文件不存在 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇599错误，请将完整错误信息（包括所有HTTP响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。 \n \n\n# **示例**\n\n## 请求示例\n\n \n \n POST /delete/bmV3ZG9jczpmaW5kX21hbi50eHQ= HTTP/1.1\n User-Agent: curl/7.30.0\n Host: rs.qiniuapi.com\n Accept: */*\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu u8WqmQu1jH21kxpIQmo2LqntzugM1VoHE9_pozCU:2LJIG...(过长已省略)\n \n\n_注：要在`Authorization`头部的`<AccessToken>`前添加`Qiniu`和半角空格。_ \n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx/1.0.8\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Connection: keep-alive\n Content-Length: 0\n X-Reqid: wxIAAD3btw-v3TwT\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储批量操作"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 批量操作\n\n# 批量操作\n\n最近更新时间: 2022-06-10 12:01:53\n\n# **描述**\n\n本接口用于执行批量操作。 \n批量操作意指在单一请求中执行多次（最大限制1000次）\n[查询元信息](https://developer.qiniu.com/kodo/api/1308/stat)、[修改元信息](https://developer.qiniu.com/kodo/api/1252/chgm)、[移动](https://developer.qiniu.com/kodo/api/1288/move)、[复制](https://developer.qiniu.com/kodo/api/1254/copy)、[删除](https://developer.qiniu.com/kodo/api/1257/delete)、[修改状态](https://developer.qiniu.com/kodo/api/4173/modify-\nthe-file-\nstatus)、[修改存储类型](https://developer.qiniu.com/kodo/api/3710/chtype)、[修改生命周期](https://developer.qiniu.com/kodo/api/8062/modify-\nobject-life-cycle) 和 [解冻](https://developer.qiniu.com/kodo/api/6380/restore-\narchive) 操作，极大提高资源管理效率。 其中，解冻操作仅针对归档/深度归档存储文件有效。\n\n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /batch HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n op=<Operation>&op=<Operation>&...\n \n\n使用说明：\n\n * 要在 Authorization 头部的 `<AccessToken>` 前添加 Qiniu 和半角空格。\n * `op=<Operation>` 是单一文件管理指令（如：`/stat/<EncodeEntryURI>`，`/delete/<EncodeEntryURI>` 等）。\n\n \n \n\n### **请求参数**\n\n将根据具体 `op=<Operation>` 文件管理指令，使用相应参数。 \n常用参数 `EncodeEntryURI`、`EncodedEntryURISrc` 与 `EncodedEntryURIDest` 经过 Base64\n编码，具体请参考 请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-\nformat)。\n\n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 固定为 application/x-www-form-urlencoded \nAuthorization | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回 401 错误码一个合法的 Authorization 值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n \n \n #批量获取元信息\n op=/stat/<EncodedEntryURI>&op=/stat/<EncodedEntryURI>&...\n \n #批量复制资源\n op=/copy/<EncodedEntryURISrc>/<EncodedEntryURIDest>&op=/copy/<EncodedEntryURISrc>/<EncodedEntryURIDest>&.../force/<true|false> \n \n #批量移动资源\n op=/move/<EncodedEntryURISrc>/<EncodedEntryURIDest>&op=/move/<EncodedEntryURISrc>/<EncodedEntryURIDest>&.../force/<true|false> \n \n #批量删除资源\n op=/delete/<EncodedEntryURI>&op=/delete/<EncodedEntryURI>&...\n \t\n #批量解冻资源\n op=/restoreAr/<EncodedEntryURI>/freezeAfterDays/<FreezeAfterDays>&...\n \n #批量修改元信息\n ……\n #批量修改存储类型\n ……\n #批量修改状态\n ……\n #批量修改生命周期\n ……\n \n #混合多种操作\n op=/stat/<EncodedEntryURI>&op=/copy/<EncodedEntryURISrc>/<EncodedEntryURIDest>/force/<true|false>&op=/move/<EncodedEntryURISrc>/<EncodedEntryURIDest>/force/<true|false> &op=/delete/<EncodedEntryURI>&op=/restoreAr/<EncodedEntryURI>/freezeAfterDays/<FreezeAfterDays>&...\n \n\n_注：copy 和 move 操作需为每个文件指定force参数。_\n\n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n \n\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 其它可能返回的头部信息，请参考[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n \n \n #批量获取元信息\n [\n { \"code\": <HttpCode int>, \"data\": <Data> },\n { \"code\": <HttpCode int>, \"data\": <Data> },\n { \"code\": <HttpCode int>, \"data\": { \"error\": \"<ErrorMessage string>\" } },\n ...\n ]\n \n #批量复制资源\n [\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int>, \"data\": { \"error\": \"<ErrorMessage string>\" } },\n ...\n ]\n \n #批量移动资源\n [\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int>, \"data\": { \"error\": \"<ErrorMessage string>\" } },\n ...\n ]\n \n #批量删除资源\n [\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int>, \"data\": { \"error\": \"<ErrorMessage string>\" } },\n ...\n ]\n \t\n #批量解冻资源\n [\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int>, \"data\": { \"error\": \"<ErrorMessage string>\" } },\n ...\n ]\n \n #混合多种操作\n [\n { \"code\": <HttpCode int>, \"data\": <Data> },\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int> },\n { \"code\": <HttpCode int>, \"data\": { \"error\": \"<ErrorMessage string>\" } },\n ...\n ]\n \n\n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 所有请求操作都已成功完成 \n298 | 部分或所有请求操作失败（出错信息参看上述响应内容） \n400 | 请求报文格式错误 \n401 | 管理凭证无效 \n403 | 禁止操作 \n当非归档/深度归档存储类型 Object 调用此接口指定 op=restoreAr 时，返回`403 Fobbiden {\"error\":\n\"operation only allowed for archive or deep archive\"}` \n599 | 服务端操作失败 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇 599 错误，请将完整错误信息（包括所有 HTTP 响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。\n\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储修改文件状态"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 修改文件状态\n\n# 修改文件状态\n\n最近更新时间: 2023-03-02 18:59:11\n\n# **描述**\n\n本接口用于修改文件的存储状态，即禁用和启用状态间的的互相转换。 \n处于禁用状态的文件将只能通过签发 Token 的方式访问\n[下载凭证](https://developer.qiniu.com/kodo/manual/1202/download-token)。 \n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /chstatus/<EncodedEntryURI>/status/<status> HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nEncodedEntryURI | 是 | 指定文件信息，详情请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \nstatus | 是 | 值为数字，0表示启用，1表示禁用 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nAuthorization | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回 401 错误码一个合法的 Authorization 值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。 \n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 其它可能返回的头部信息，请参考[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，不返回任何内容。 \n如果请求失败，返回包含如下内容的 JSON 字符串（已格式化，便于阅读）：\n\n \n \n {\n \"error\": \"<errMsg string>\",\n }\n \n\n字段名称 | 必填 | 说明 \n---|---|--- \nerror | 是 | 与 HTTP 状态码对应的消息文本 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 更改成功 \n400 | 请求报文格式错误 \n当`<EncodedEntryURI>`解析失败，返回 `400 Bad Request {\"error\":\"invalid argument\"}` \n当`<EncodedEntryURI>`不符合 UTF-8 编码，返回 `400 Bad Request {\"error\":\"key must be\nutf8 encoding\"}` \n当文件当前状态和设置的状态已经一致，返回 `{\"error\":\"already enabled\"}` 或 `{\"error\":\"already\ndisabled\"}` \n401 | 管理凭证无效 \n612 | 目标文件不存在 \n599 | 服务端操作失败 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇 599 错误，请将完整错误信息（包括所有 HTTP 响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。 \n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /chstatus/aXRpc2F0ZXN0OmdvZ29waGVyLmpwZw==/status/1 HTTP/1.1\n User-Agent: curl/7.30.0\n Host: rs.qiniuapi.com\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu bt500PzCG9tV0bccCOdnrmCHPXCPLieGSDEprB7M:4wG...(过长已省略)\n \n\n_注：要在`Authorization`头部的`<AccessToken>`前添加`Qiniu`和半角空格。_ \n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx/1.4.4\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Content-Length: 0\n Connection: keep-alive\n X-Reqid: vDEAAG2lN7zSqpQT\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储修改文件存储类型"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 修改文件存储类型\n\n# 修改文件存储类型\n\n最近更新时间: 2024-08-12 15:47:43\n\n# **描述**\n\n本接口用于修改文件的存储类型信息，可以实现标准存储、低频访问存储、归档直读存储、归档存储和深度归档存储之间的互相转换。 \n低频访问存储、归档直读存储、归档存储、深度归档存储有最短存储时间要求，修改为其他存储类型时可能会产生提前删除的计量计费。详情参见\n[计量项与计费项](https://developer.qiniu.com/kodo/buying_guide/6379/metering-and-\nbilling) 说明 \n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /chtype/<EncodedEntryURI>/type/<type> HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n使用说明：\n\n * 归档/深度归档存储文件，只有解冻状态时可以修改存储类型。 \n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nEncodedEntryURI | 是 | 指定文件信息，详情请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \ntype | 是 | 值为数字，0 表示标准存储，1 表示低频访问存储，2 表示归档存储，3 表示深度归档存储，4 表示归档直读存储，5 表示智能分层存储 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nAuthorization | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回 401 错误码一个合法的 Authorization 值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。 \n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n \n\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 其它可能返回的头部信息，请参考[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，不返回任何内容。 \n如果请求失败，返回包含如下内容的 JSON 字符串（已格式化，便于阅读）：\n\n \n \n {\n \"error\": \"<errMsg string>\",\n }\n \n\n字段名称 | 必填 | 说明 \n---|---|--- \nerror | 是 | 与 HTTP 状态码对应的消息文本 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 更改成功 \n400 | 请求报文格式错误 \n当 `<EncodedEntryURI>` 解析失败，返回 `400 Bad Request {\"error\":\"invalid argument\"}` \n当 `<EncodedEntryURI>` 不符合UTF-8编码，返回 `400 Bad Request {\"error\":\"key must be\nutf8 encoding\"}` \n当文件类型已经是普通存储仍然转换成普通存储会返回 `400 Bad Request {\"error\":\"already in normal stat\"}` \n当文件类型已经是低频存储仍然转换成低频存储会返回 `400 Bad Request {\"error\":\"already in line stat\"}` \n当文件类型已经是归档直读存储仍然转换成归档制度存储会返回 `400 Bad Request {\"error\":\"already in archive_ir\nstat\"}` \n当文件类型已经是归档存储仍然转换成归档存储会返回 `400 Bad Request {\"error\":\"already in archive stat\"}` \n当文件类型已经是深度归档存储仍然转换成深度归档存储会返回 `400 Bad Request {\"error\":\"already in deep\narchive stat\"}` \n401 | 管理凭证无效 \n403 | 禁止操作 \n当归档存储文件未解冻完成时调用接口会返回 `403 ArchiveUnrestored {\"error\":\"archive unrestored\"}` \n当深度归档存储文件未解冻完成时调用接口会返回 `403 DeepArchiveUnrestored {\"error\":\"deep archive\nunrestored\"}` \n612 | 目标文件不存在 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇 599 错误，请将完整错误信息（包括所有 HTTP 响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /chtype/aXRpc2F0ZXN0OmdvZ29waGVyLmpwZw==/type/1 HTTP/1.1\n User-Agent: curl/7.30.0\n Host: rs.qiniuapi.com\n Accept: */*\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu bt500PzCG9tV0bccCOdnrmCHPXCPLieGSDEprB7M:4wG...(过长已省略)\n \n\n_注：要在`Authorization` 头部的 `<AccessToken>` 前添加 `Qiniu` 和半角空格。_ \n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx/1.4.4\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Content-Length: 0\n Connection: keep-alive\n X-Reqid: vDEAAG2lN7zSqpQT\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储解冻归档/深度归档存储文件"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 解冻归档/深度归档存储文件\n\n# 解冻归档/深度归档存储文件\n\n最近更新时间: 2023-03-02 18:59:42\n\n# **描述**\n\n本接口用于解冻归档/深度归档存储类型的文件，可设置解冻有效期1～7天。 \n归档存储文件完成解冻通常需要1～5分钟，深度归档存储文件完成解冻需要5～12小时。 \n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /restoreAr/<EncodedEntryURI>/freezeAfterDays/<FreezeAfterDays> HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nEncodedEntryURI | 是 | 指定文件信息，详情请参考 [EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \nFreezeAfterDays | 是 | 解冻有效时长，取值范围 1～7 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nAuthorization | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回 401 错误码一个合法的 Authorization 值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。 \n \n\n# **响应**\n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 其它可能返回的头部信息，请参考[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，不返回任何内容。 \n如果请求失败，返回包含如下内容的 JSON 字符串（已格式化，便于阅读）：\n\n \n \n {\n \"error\": \"<errMsg string>\",\n }\n \n\n字段名称 | 必填 | 说明 \n---|---|--- \nerror | 是 | 与 HTTP 状态码对应的消息文本 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 更改成功 \n400 | 请求报文格式错误 \n当 `Bucket` 为空时，返回 `400 Bad Request {\"error\":\"invalid argument\"}` \n当 `Object` 不符合 UTF-8 编码，返回 `400 Bad Request {\"error\":\"key must be utf8\nencoding\"}` \n当 `Object` 已经处于解冻状态时，返回 `400 Bad Request {\"error\":\"archive already restored\"}` \n当 `<FreezeAfterDays>` 不符合要求时，返回 `400 Bad Request {\"error\":\"invalid freeze\nafter days\"}` \n401 | 管理凭证无效 \n403 | 禁止操作 \n当非归档/深度归档存储类型 Object 调用此接口时，返回 `403 Fobbiden {\"error\": \"operation only allowed\nfor archive or deep archive\"}` \n612 | 目标资源不存在 \n599 | 服务端操作失败 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇 599 错误，请将完整错误信息（包括所有 HTTP 响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。 \n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /restoreAr/YnVja2V0LW1rdDNqbGNtemsyc2V2N3Rlb2ZjOktPRE8tS0VZLVRFU1QtYXJjaGl2ZS1UYmNZUEN0c3Ay/freezeAfterDays/1 HTTP/1.1\n Host: rs.qiniuapi.com\n User-Agent: Go-http-client/1.1\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu HwFOxpYCQU6oXoZXFOTh1mq5ZZig6Yyocgk3BTZZ:dkV6wjnPOasNG-WPDvbttUlYWaw=\n Content-Type: application/x-www-form-urlencoded\n \n\n_注：要在`Authorization` 头部的 `<AccessToken>` 前添加 `Qiniu` 和半角空格。_\n\n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Connection: keep-alive\n X-Reqid: ZhUAACe10_2tVfYV\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储修改文件过期删除时间"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 修改文件过期删除时间\n\n# 修改文件过期删除时间\n\n最近更新时间: 2023-03-02 18:59:52\n\n# **描述**\n\n本接口用于修改指定资源的过期删除时间。 \n修改指定资源生命周期其他时间，比如转低频存储时间和转归档存储时间，请参考\n[修改文件生命周期](https://developer.qiniu.com/kodo/api/8062/modify-object-life-\ncycle)。后续可以通过 [资源元信息查询](https://developer.qiniu.com/kodo/1308/stat)\n查看修改生命周期相关时间。 \n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /deleteAfterDays/<EncodedEntryURI>/<deleteAfterDays> HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n使用说明：\n\n * 文件在设置的 `<deleteAfterDays>` 天之后被删除， **删除后不可恢复**\n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nEncodedEntryURI | 是 | 指定文件信息，详情请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \ndeleteAfterDays | 是 | 值为数字，设置为 0 表示取消过期删除设置 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nAuthorization | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回 401 错误码一个合法的 Authorization 值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。 \n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n \n\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 其它可能返回的头部信息，请参考[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，不返回任何内容。 \n如果请求失败，返回包含如下内容的 JSON 字符串（已格式化，便于阅读）：\n\n \n \n {\n \"error\": \"<errMsg string>\",\n }\n \n\n字段名称 | 必填 | 说明 \n---|---|--- \nerror | 是 | 与 HTTP 状态码对应的消息文本 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 更新成功 \n400 | 请求报文格式错误 \n401 | 管理凭证无效 \n599 | 服务端操作失败 \n612 | 待设置生命周期的资源不存在 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇 599 错误，请将完整错误信息（包括所有 HTTP 响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /deleteAfterDays/bmV3ZG9jczpmaW5kX21hbi50eHQ=/1 HTTP/1.1\n User-Agent: curl/7.30.0\n Host: rs.qiniuapi.com\n X-Qiniu-Date: 20060102T150405Z\n Accept: */*\n Authorization: Qiniu u8WqmQu1jH21kxpIQmo2LqntzugM1VoHE9_pozCU:2LJIG...(过长已省略)\n \n\n_注：要在`Authorization` 头部的 `<AccessToken>` 前添加 `Qiniu` 和半角空格。_ \n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx/1.0.8\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Connection: keep-alive\n Content-Length: 0\n X-Reqid: wxIAAD3btw-v3TwT\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储修改文件生命周期"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 修改文件生命周期\n\n# 修改文件生命周期\n\n最近更新时间: 2024-08-12 15:48:14\n\n# **描述**\n\n本接口用于修改已上传文件 Object 的\n[生命周期](https://developer.qiniu.com/kodo/development_guidelines/8609/dev-life-\ncycle-management)。后续可以通过 [资源元信息查询](https://developer.qiniu.com/kodo/1308/stat)\n看到修改生命周期相关时间。 \n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /lifecycle/<EncodedEntryURI>/toIAAfterDays/<ToIAAfterDays>/toIntelligentTieringAfterDays/<ToIntelligentTieringAfterDays>/toArchiveAfterDays/<ToArchiveAfterDays>/toDeepArchiveAfterDays/<ToDeepArchiveAfterDays>/deleteAfterDays/<DeleteAfterDays> HTTP/1.1\n Host: rs.qiniuapi.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n \n\n## 请求参数\n\n参数名称 | 是否必填 | 说明 \n---|---|--- \nEncodedEntryURI | 是 | 指定文件信息，详情参考 [EncodedEntryURI](https://developer.qiniu.com/kodo/1276/data-format) \nToIAAfterDays | 否 | 指定文件上传后在设置的 ToIAAfterDays 转换到 低频存储类型，设置为 `-1` 表示取消已设置的转低频存储的生命周期规则 \nToIntelligentTieringAfterDays | 否 | 指定文件上传后在设置的 ToIntelligentTieringAfterDays 转换到 智能分层存储类型，设置为 `-1` 表示取消已设置的转智能分层存储的生命周期规则 \nToArchiveIRAfterDays | 否 | 指定文件上传后在设置的 ToArchiveIRAfterDays 转换到 归档直读存储类型， 设置为 `-1` 表示取消已设置的转归档直读存储的生命周期规则 \nToArchiveAfterDays | 否 | 指定文件上传后在设置的 ToArchiveAfterDays 转换到 归档存储类型， 设置为 `-1` 表示取消已设置的转归档存储的生命周期规则 \nToDeepArchiveAfterDays | 否 | 指定文件上传后在设置的 ToDeepArchiveAfterDays 转换到 深度归档存储类型， 设置为 `-1` 表示取消已设置的转深度归档存储的生命周期规则 \nDeleteAfterDays | 否 | 指定文件上传后在设置的 DeleteAfterDays 过期删除，删除后不可恢复，设置为 `-1` 表示取消已设置的过期删除的生命周期规则 \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nAuthorization | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回 401 错误码一个合法的 Authorization 值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。 \n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n \n\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 其它可能返回的头部信息，请参考[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，不返回任何内容。 \n如果请求失败，返回包含如下内容的 JSON 字符串（已格式化，便于阅读）：\n\n \n \n {\n \"error\": \"<errMsg string>\",\n }\n \n\n字段名称 | 必填 | 说明 \n---|---|--- \nerror | 是 | 与 HTTP 状态码对应的消息文本 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 更新成功 \n400 | 请求报文格式错误 \n401 | 管理凭证无效 \n599 | 服务端操作失败 \n612 | 待设置生命周期的资源不存在 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇 599 错误，请将完整错误信息（包括所有 HTTP 响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /lifecycle/bmV3ZG9jczpmaW5kX21hbi50eHQ=/ToArchiveAfterDays/-1 HTTP/1.1\n User-Agent: curl/7.30.0\n Host: rs.qiniuapi.com\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu u8WqmQu1jH21kxpIQmo2LqntzugM1VoHE9_pozCU:2LJIG...(过长已省略)\n \n\n_注：要在`Authorization` 头部的 `<AccessToken>` 前添加 `Qiniu` 和半角空格。_ \n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx/1.0.8\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Connection: keep-alive\n Content-Length: 0\n X-Reqid: wxIAAD3btw-v3TwT\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储镜像资源更新"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 镜像资源更新\n\n# 镜像资源更新\n\n最近更新时间: 2023-03-02 19:00:13\n\n# **描述**\n\n对设置了镜像存储的空间，使用本接口将镜像源站抓取指定名称的文件并存储到该空间中。 \n如果该空间中已存在该名称的文件，则会将镜像源站的文件覆盖空间中相同名称的文件。 \n \n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /prefetch/<EncodedEntryURI>\n Host: iovip-<Region>.qiniuio.com\n Content-Type: application/x-www-form-urlencoded\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n \n\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nEncodedEntryURI | 是 | 指定文件信息，详情请参考[EncodedEntryURI](https://developer.qiniu.com/kodo/api/1276/data-format) \n \n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | `iovip-<Region>.qiniuio.com` 中的 `<Region>` 为七牛各区域 ID，请参考七牛支持的 [区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq)查看具体域名。 \nAuthorization | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回 401 错误码一个合法的 Authorization 值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n该请求操作的请求体为空。 \n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n \n\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 其它可能返回的头部信息，请参考[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，不返回任何内容。 \n如果请求失败，返回包含如下内容的 JSON 字符串（已格式化，便于阅读）：\n\n \n \n {\n \"error\": \"<errMsg string>\",\n }\n \n\n字段名称 | 必填 | 说明 \n---|---|--- \nerror | 是 | 与 HTTP 状态码对应的消息文本 \n \n \n\n### **响应状态码**\n\nHTTP状态码 | 含义 \n---|--- \n200 | 抓取成功 \n400 | 请求报文格式错误 \n401 | 管理凭证无效 \n404 | 抓取资源不存在 \n478 | 源站返回404外，所有非200的response都返回478。 \n599 | 服务端操作失败 \n其他错误码 | 请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-responses) \n \n如遇 599 错误，请将完整错误信息（包括所有 HTTP 响应头部）[提交工单\n__](https://support.qiniu.com/tickets/category)给我们。\n\n \n\n# **示例**\n\n### **请求示例**\n\n \n \n POST /prefetch/bmV3ZG9jczpmaW5kLm1hbi50eHQ= HTTP/1.1\n User-Agent: curl/7.30.0\n Host: iovip.qiniuio.com\n Accept: */*\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu u8WqmQu1jH21kxpIQmo2LqntzugM1VoHE9_pozCU:2LJIG...(过长已省略)\n \n\n_注：要在`Authorization` 头部的 `<AccessToken>` 前添加 `Qiniu` 和半角空格。_ \n \n\n### **响应示例**\n\n \n \n HTTP/1.1 200 OK\n Server: nginx/1.0.8\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Content-Type: application/json\n Connection: keep-alive\n Content-Length: 0\n X-Log: RS.in;RS.mo;qtbl.mv:3;MQ;MC/404;RS.mcd:1;RS:5\n X-Reqid: wxIAAD3btw-v3TwT\n \n\n_注：本接口在执行同步操作时，如果抓取的资源过大或者源站响应过慢，可能会导致超时。_\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储异步第三方资源抓取"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > [Object\n接口](https://developer.qiniu.com/kodo/api/1274/rs) > 异步第三方资源抓取\n\n# 异步第三方资源抓取\n\n最近更新时间: 2024-08-12 15:50:51\n\n# **描述**\n\n本接口用于从指定 URL 抓取资源，并将该资源存储到指定空间中。每次只抓取一个文件，抓取时可以指定保存空间名和最终资源名。\n\n \n\n# **发起任务:**\n\n# **请求**\n\n### **请求语法**\n\n \n \n POST /sisyphus/fetch HTTP/1.1\n Host: api-<Region>.qiniuapi.com\n Content-Type: application/json\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu <AccessToken>\n Body:\n {\n \"url\" : \"<url>\",\n \"host\" : \"<host>\",\n \"bucket\": \"<bucket>\",\n \"key\": \"<key>\",\n \"md5\": \"<md5>\",\n \"callbackurl\": \"<callbackurl>\",\n \"callbackbody\": \"<callbackbody>\",\n \"callbackbodytype\": \"<callbackbodytype>\",\n \"file_type\":<file_type>\n ...\n }\n \n\n使用说明：\n\n * 抓取动作是异步操作，接受到抓取请求后服务端直接返回成功，资源会在后台进行抓取后存入存储，并产生一个回调请求通知业务服务器（如果存在回调参数）。\n * 因为各种原因抓取失败时会产生一个 json 格式的 _**特殊回调**_ 通知业务服务器。\n * 如果被抓取的源站屏蔽（屏蔽可能是抓取源站有 IP、UA 等限制策略）来自七牛的抓取操作，那么不能确保一定可以抓取成功。 \n \n\n### **请求参数**\n\n该请求操作的参数为空，请参考操作内容中的参数。\n\n \n\n### **请求头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nHost | 是 | `api-<Region>.qiniuapi.com` 中的 `<Region>` 为七牛各区域 ID，请参考七牛支持的 [区域列表](https://developer.qiniu.com/kodo/1671/region-endpoint-fq) \nAuthorization | 是 | 该参数应严格按照[管理凭证](https://developer.qiniu.com/kodo/manual/1201/access-token)格式进行填充，否则会返回 401 错误码一个合法的 Authorization 值应类似于：`Qiniu QNJi_bYJlmO5LeY08FfoNj9w_r7...` \n其他 | | 请查阅[公共请求头](https://developer.qiniu.com/kodo/api/3924/common-request-headers) \n \n \n\n### **请求内容**\n\n参数名称 | 类型 | 默认值 | 必填 | 说明 \n---|---|---|---|--- \nurl | string | N/A | 是 | 需要抓取的 url,支持设置多个用于高可用,以’;'分隔,当指定多个 url 时可以在前一个 url 抓取失败时重试下一个 \nbucket | string | N/A | 是 | 所在区域的 bucket \nhost | string | 空 | 否 | 从指定 url 下载数据时使用的 Host \nkey | string | 空 | 否 | 文件存储的 key,不传则使用文件 hash 作为 key \nmd5 | string | 空 | 否 | 文件 md5,传入以后会在存入存储时对文件做校验，校验失败则不存入指定空间 \netag | string | 空 | 否 | 文件 etag,传入以后会在存入存储时对文件做校验，校验失败则不存入指定空间,相关算法参考 https://github.com/qiniu/qetag \ncallbackurl | string | 空 | 否 | 回调 URL，详细解释请参考上传策略中的[callbackUrl](https://developer.qiniu.com/kodo/manual/1206/put-policy#put-policy-callback-url) \ncallbackbody | string | 空 | 否 | 回调 Body，如果 callbackurl 不为空则必须指定。上传成功后，七牛云向业务服务器发送 Content-Type: application/x-www-form-urlencoded 的 POST 请求。业务服务器可以通过直接读取请求的 query 来获得该字段，支持[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)、但不支持自定义变量。callbackBody 要求是合法的 url query string。例如 key=$(key)&hash=$(etag)&w=$(imageInfo.width)&h=$(imageInfo.height)。如果 callbackBodyType 指定为 application/json，则 callbackBody 应为 json 格式，例如:{“key”:\"$(key)\",“hash”:\"$(etag)\",“w”:\"$(imageInfo.width)\",“h”:\"$(imageInfo.height)\"}。 \ncallbackbodytype | string | 空 | 否 | 回调 Body 内容类型,默认为\"application/x-www-form-urlencoded\"，详细解释请参考上传策略中的[callbackBodyType](https://developer.qiniu.com/kodo/manual/1206/put-policy#put-policy-callback-body-type)。 \ncallbackhost | string | 空 | 否 | 回调时使用的 Host \nfile_type | int | 0 | 否 | 存储文件类型 0:标准存储(默认), 1:低频存储, 2:归档存储, 3:深度归档存储, 4:归档直读存储, 5:智能分层存储 \nmode | string | 空 | 否 | 可选填⼊ m3u8，此时会解析 m3u8 并下载对应 ts 落存储, 必须指定 key。m3u8 文件的解析，只支持相对路径模式：ts 文件和 m3u8 文件将保存在指定的同一目录下。 \nignore_same_key | bool | false | 否 | 如果已存在同名⽂会重试抓取。当为 true 时，如果空间中已经存在同名文件则放弃本次抓取(仅对比 key，不校验文件内容)。 \n \n \n\n \n\n# **响应**\n\n### **响应语法**\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n Cache-Control: no-store\n Body: \n {\n }\n \n\n \n\n### **响应头**\n\n头部名称 | 必填 | 说明 \n---|---|--- \nContent-Type | 是 | 正常情况下该值将被设为 `application/json`，表示返回 JSON 格式的文本信息。 \n其他 | | 其它可能返回的头部信息，请参考[公共响应头](https://developer.qiniu.com/kodo/api/3924/common-request-headers)。 \n \n \n\n### **响应内容**\n\n如果请求成功，则返回\n\n \n \n {\"id\":\"<ID>\",\"wait\":<Wait>}\n \n\n参数名称 | 说明 \n---|--- \nid | 异步任务Id \nwait | 当前任务前面的排队任务数量,0表示当前任务正在进行,-1表示任务已经至少被处理过一次（可能会进入重试逻辑） \n \n如果抓取失败，则返回特殊回调消息体格式 （特殊回调消息体包含发起请求时的参数和错误信息,示例不包含所有参数）\n\n \n \n {\n \"url\" : \"<url>\",\n \"bucket\": \"<bucket>\",\n \"key\": \"<key>\",\n \"md5\": \"<md5>\",\n \"callbackurl\": \"<callbackurl>\",\n \"callbackbody\": \"<callbackbody>\",\n \"callbackbodytype\": \"<callbackbodytype>\",\n \"file_type\":<file_type>,\n \"err\":\"<err>\",\n \"code\":<code>\n }\n \n\n参数名称 | 说明 \n---|--- \nerr | 错误信息 \ncode | 错误码 \n \n \n\n### **响应状态码**\n\n该操作的实现不会返回特殊错误。有关错误和错误代码列表的一般信息，请查阅[错误响应](https://developer.qiniu.com/kodo/api/3928/error-\nresponses)。 \n \n\n# **示例**\n\n### **请求**\n\n**发起异步任务**\n\n \n \n POST /sisyphus/fetch HTTP/1.1\n Host: api-z0.qiniuapi.com\n Content-Type: application/json\n User-Agent: Go-http-client/1.1\n X-Qiniu-Date: 20060102T150405Z\n Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:FwliyUEz-rL1rb9qVkd0xYosBng=\n Body:\n {\n \"url\" : \"http://www.qiniu.com\",\n \"bucket\": \"test\",\n \"key\": \"qiniu\",\n \"callbackurl\": \"http://www.qiniu.com/callback\",\n \"callbackbody\": \"$(bucket)\"\n }\n \n\n_注：要在`Authorization` 头部的 `<AccessToken>` 前添加 `Qiniu` 和半角空格。_\n\n \n\n### **响应**\n\n \n \n HTTP/1.1 200 OK\n Content-Length: 94\n Connection: keep-alive\n Content-Type: application/json\n Date: Mon, 02 Jan 2006 15:04:05 GMT\n Server: nginx\n X-Reqid: jXwAAH8259lkr-UU\n Body:\n {\"id\":\"eyJ6b25lIjoiejAiLCJwYXJ0X2lkIjo2Mywib2Zmc2V0IjowfQ==\",\"wait\":-1}\n \n \n\n \n\n# **查询任务:**\n\n# **请求**\n\n### **请求语法**\n\n \n \n GET /sisyphus/fetch?id=<ID> HTTP/1.1\n Host: api-<Region>.qiniuapi.com\n Authorization: Qiniu <AccessToken>\n \n\n### **请求参数**\n\n参数名称 | 必填 | 说明 \n---|---|--- \nID | 是 | 异步任务 ID \n \n \n\n# **响应**\n\n### **响应内容**\n\n \n \n {\"id\":\"<ID>\",\"wait\":<Wait>}\n \n\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储数据统计接口"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > API 文档 > 数据统计接口\n\n# 数据统计接口\n\n最近更新时间: 2024-08-12 15:23:48\n\n数据统计相关的接口：\n\n接口 | 说明 \n---|--- \n[space](https://developer.qiniu.com/kodo/api/3908/statistic-space) | 获取标准存储的存储量统计 \n[count](https://developer.qiniu.com/kodo/3914/count) | 获取标准存储的文件数量统计 \n[space_line](https://developer.qiniu.com/kodo/api/3910/space-line) | 获取低频存储的存储量统计 \n[count_line](https://developer.qiniu.com/kodo/api/3915/count-line) | 获取低频存储的文件数量统计 \n[space_intelligent_tiering](https://developer.qiniu.com/kodo/api/12755/space-intelligent-tiering) | 获取智能分层存储的存储量统计 \n[count_intelligent_tiering](https://developer.qiniu.com/kodo/api/12756/count-intelligent-tiering) | 获取智能分层存储的文件数量统计 \n[count_intelligent_tiering_monitor](https://developer.qiniu.com/kodo/api/12757/count-intelligent-tiering-monitor) | 获取智能分层存储的监控文件数 \n[space_archive_ir](https://developer.qiniu.com/kodo/api/12613/space-archive-ir) | 获取归档直读存储的存储量统计 \n[count_archive_ir](https://developer.qiniu.com/kodo/api/12614/count-archive-ir) | 获取归档直读存储的文件数量统计 \n[space_archive](https://developer.qiniu.com/kodo/api/6462/space-archive) | 获取归档存储的存储量统计 \n[count_archive](https://developer.qiniu.com/kodo/api/6463/count-archive) | 获取归档存储的文件数量统计 \n[space_deep_archive](https://developer.qiniu.com/kodo/api/11180/space-deep-archive) | 获取深度归档存储的存储量统计 \n[count_deep_archive](https://developer.qiniu.com/kodo/api/11181/count-deep-archive) | 获取深度归档存储的文件数量统计 \n[blob_transfer](https://developer.qiniu.com/kodo/api/3911/blob-transfer) | 获取跨区域同步流量统计 \n[rs_chtype](https://developer.qiniu.com/kodo/api/3913/rs-chtype) | 获取存储类型请求次数统计 \n[blob_io](https://developer.qiniu.com/kodo/api/3820/blob-io) | 获取外网流出流量统计，CDN回源流出流量统计，数据读取统计， GET请求次数统计 \n[rs_put](https://developer.qiniu.com/kodo/api/3912/rs-put) | 获取 PUT 请求次数统计 \n \n注：接口提供 2018-01-01 号及之后的数据查询，历史数据默认不提供，如有需要请工单联系我们。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储鸿蒙(Harmony) SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > 鸿蒙(Harmony) SDK\n\n# 鸿蒙(Harmony) SDK\n\n最近更新时间: 2024-05-08 10:58:48\n\n## 快速使用\n\n 1. 安装SDK\n\n \n \n ohpm install @qiniu/upload\n \n\n 2. 导入SDK\n\n \n \n import { createDirectUploadTask, createMultipartUploadV1Task, createMultipartUploadV2Task, UploadFile } from '@qiniu/upload';\n \n\n 3. 创建上传任务\n\n \n \n // 创建上传数据\n const file = UploadFile.fromUri('datashare://xxxx')\n const file = UploadFile.fromPath('/data/storage/xxx')\n const file = UploadFile.fromString('string content')\n const file = UploadFile.fromArrayBuffer(new ArrayBuffer(1e3))\n \n // 创建直传任务\n const uploadTask = createDirectUploadTask(file, config);\n \n // 创建分片上传任务\n const uploadTask = createMultipartUploadV2Task(file, config);\n \n // 部分老私有云不支持 v2，推荐用 v1\n const uploadTask = createMultipartUploadV1Task(file, config);\n \n\n 1. 设置任务回调函数\n\n \n \n // 设置进度回调函数\n uploadTask.onProgress((progress, context) => {\n // 处理进度回调\n });\n \n // 设置完成回调函数\n uploadTask.onComplete((result, context) => {\n // 处理完成回调\n });\n \n // 设置错误回调函数\n uploadTask.onError((error, context) => {\n // 处理错误回调\n });\n \n\n 5. 启动任务\n\n \n \n uploadTask.start()\n \n\n 6. 简单模式\n\n如果你不需要关心进度信息，可以通过 start 快速获取任务的状态信息\n\n \n \n createMultipartUploadV2Task(file, config).start()\n .then((result) => {\n // 处理任务完成结果\n })\n .catch((error) => {\n // 处理任务启动失败错误\n });\n \n\n## 接口说明\n\n### TokenProvider\n\n \n \n type TokenProvider = () => Promise<string>\n \n\n * 一个用于获取上传所需 token 的函数类型。\n * 返回一个 Promise，该 Promise 提供上传所需的 token。\n\n### Context\n\n \n \n interface Context<ProgressKey extends string = string> {\n host?: Host;\n token?: Token;\n result?: string;\n error?: UploadError;\n progress: Progress<ProgressKey>;\n }\n \n\n * 上传的上下文接口，用于存储任务相关的信息。\n * `host`：上传使用的 host。\n * `token`：上传使用的 token。\n * `result`：上传成功的信息。\n * `error`：队列的错误。\n * `progress`：整体的任务进度信息。\n\n### UploadConfig\n\n \n \n interface UploadConfig {\n tokenProvider: TokenProvider;\n apiServerUrl?: string;\n uploadHosts?: []string;\n logLevel?: LogLevel;\n protocol?: HttpProtocol;\n vars?: Record<string, string>;\n }\n \n\n * 上传配置接口，用于配置上传任务的相关参数。\n * `tokenProvider`：用于获取上传所需 token 的函数，必传。\n * `apiServerUrl`：服务的接口地址，可选；默认为七牛公有云，示例：<https://api.qiniu.com>[ __](https://api.qiniu.com)该配置仅当未设置`uploadHosts` 时生效，SDK 将会通过指定的 api 服务提供的接口来动态获取上传地址，私有云请联系集群运维人员，并确认集群是否支持 `v4/query` 接口\n * `uploadHosts`: 上传服务地址，可选；手动指定上传服务地址，示例：up.qiniu.com\n * `protocol`：HTTP 协议，可选，默认 HTTPS。\n * `logLevel`：日志级别，可选。\n * `vars`: 上传过程中的自定义变量，可选。\n\n### OnError\n\n \n \n type OnError = (error: UploadError, context: Context) => void;\n \n\n * 错误回调函数类型。\n\n### OnProgress\n\n \n \n type OnProgress = (progress: Progress, context: Context) => void;\n \n\n * 进度回调函数类型。\n\n#### Progress\n\n \n \n type Progress<Key extends string = string> = {\n /** 上传的文件总大小；单位 byte */\n size: number\n /** 目前处理的百分比进度；范围 0-1 */\n percent: number\n /** 具体每个部分的进度信息； */\n details: Record<Key, {\n /** 子任务的处理数据大小；单位 byte */\n size: number\n /** 目前处理的百分比进度；范围 0-1 */\n percent: number\n /** 该处理是否复用了缓存； */\n fromCache: boolean\n }>\n }\n \n\n### OnComplete\n\n \n \n type OnComplete = (result: string, context: Context) => void;\n \n\n * 完成回调函数类型。\n * 接收一个上下文参数，并返回 `void`。\n\n### UploadTask\n\n \n \n interface UploadTask {\n onProgress(fn: OnProgress): void;\n onComplete(fn: OnComplete): void;\n onError(fn: OnError): void;\n cancel(): Promise<Result>;\n start(): Promise<Result>;\n }\n \n\n * 上传任务接口，用于控制上传任务的执行和处理回调函数。\n * `onProgress(fn: OnProgress)`：设置进度回调函数。\n * `onComplete(fn: OnComplete)`：设置完成回调函数。\n * `onError(fn: OnError)`：设置错误回调函数。\n * `cancel()`：取消上传任务，并返回一个 Promise，该 Promise 在解析时提供任务结果。\n * `start()`：启动上传任务，并返回一个 Promise， 该 Promise 在解析时提供任务结果。\n\n## 贡献代码\n\n 1. 登录 <https://github.com>[__](https://github.com)\n\n 2. Fork [email protected]:qiniu/js-sdk.git\n\n 3. 创建您的特性分支 (git checkout -b new-feature)\n\n 4. 提交您的改动 (git commit -am ‘Added some features or fixed a bug’)\n\n 5. 将您的改动记录提交到远程 git 仓库 (git push origin new-feature)\n\n 6. 然后到 github 网站的该 git 远程仓库的 new-feature 分支下发起 Pull Request\n\n### 许可证\n\n> Copyright © 2023 qiniu.com\n\n### 基于 MIT 协议发布\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Android SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > Android SDK\n\n# Android SDK\n\n最近更新时间: 2024-08-05 18:24:28\n\nAndroid SDK 只包含了最终用户使用场景中的必要功能。相比服务端 SDK 而言，客户端 SDK 不会包含对云存储服务的管理和配置功能。\n\n * [Android SDK 下载地址 __](https://github.com/qiniu/android-sdk/releases)\n * [Android SDK 源码地址 __](https://github.com/qiniu/android-sdk)\n * [Android SDK 历史文档](https://developer.qiniu.com/kodo/sdk/android-sdk-6)\n\n**版本**\n\nQiniu SDK 版本 | 最低 Android版本 | 依赖库版本 \n---|---|--- \n8.8.x | Android 4.0+ | okhttp 4+ （如果要支持 Android 4.0+，需调整 okhttp 至 v3.12.+） \n8.7.x | Android 4.0+ | okhttp 4+ （如果要支持 Android 4.0+，需调整 okhttp 至 v3.12.+） \n8.6.x | Android 4.0+ | okhttp 4+ （如果要支持 Android 4.0+，需调整 okhttp 至 v3.12.+） \n8.5.x | Android 4.0+ | okhttp 4+ （如果要支持 Android 4.0+，需调整 okhttp 至 v3.12.+） \n8.4.x | Android 4.0+ | okhttp 4+ （如果要支持 Android 4.0+，需调整 okhttp 至 v3.12.+） \n8.3.1+ | Android 4.0+ | okhttp 4+ （如果要支持 Android 4.0+，需调整 okhttp 至 v3.12.+） \n8.3.0 | Android 5.0+ | okhttp 4+ \n8.2.x | Android 5.0+ | okhttp 4+ \n8.1.x | Android 5.0+ | okhttp 4+ \n8.0.x | Android 5.0+ | okhttp 4+ \n7.6.x | Android 5.0+ | okhttp 4+ \n7.5.x | Android 5.0+ | okhttp 4+ \n7.4.6 | Android 4.0+ | okhttp 3.12.6 \n7.3.x | Android 2.3+ | okhttp 3.11.0 \n7.2.x | Android 2.3+ | okhttp 3+ \n7.1.x | Android 2.3+ | okhttp 2.6+ \n7.0.8,7.0.9 | Android 2.2+ | android-async-http 1.4.9 \n7.0.7 | Android 2.2+ | android-async-http 1.4.8 \n \n### 注意\n\n * 如果要兼容 Android 4.x ，对应 okhttp 版本请调整至 3.12.+；maven 依赖版本调整方法可参考下方 **1.2 通过 maven**\n\n# 1 安装\n\n## 1.1 直接安装\n\n将 sdk jar文件 复制到项目中去， [jar包下载地址\n__](http://search.maven.org/#search%7Cga%7C1%7Ccom%2Fqiniu%2Fqiniu-android-\nsdk), 下载对应的 jar 包，以及搜索下载对应的依赖库\n\n[happy-dns下载地址 __](https://repo1.maven.org/maven2/com/qiniu/happy-dns/)\n\n## 1.2 通过 maven\n\nAndroid Studio中添加 dependencies 或者在项目中添加 maven 依赖\n\n \n \n // 1 直接导入\n implementation 'com.qiniu:qiniu-android-sdk:8.8.+'\n \n // 2 如果要修改okhttp依赖的版本，可采用以下方式（强烈建议使用七牛库依赖的okhttp版本）\n implementation ('com.qiniu:qiniu-android-sdk:8.8.+'){\n exclude (group: 'com.squareup.okhttp3', module: 'okhttp')\n }\n implementation 'com.squareup.okhttp3:okhttp:4.2.2'\n \n\n如果是 eclipse, 也可以直接添加依赖来处理。\n\n**相关链接**\n\n * [qiniu-android-sdk __](https://github.com/qiniu/android-sdk/)\n * [okhttp __](http://square.github.io/okhttp/)\n\n如果需要下载历史 jar 包，也可以在 maven 上直接下载，请参考 [这里\n__](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.qiniu%22%20AND%20a%3A%22qiniu-\nandroid-sdk%22)。\n\n# 2 推荐的使用姿势\n\nAndroid SDK 作为移动端的 SDK，在使用时会被嵌入到移动端的应用中，为了保证用户信息的安全以及业务的灵活性，我们给出以下几点建议：\n\n### 2.1 AccessKey 和 SecretKey 下发\n\n账户以及 iam 子账户的密钥对 AccessKey 和 SecretKey\n不要固化在客户端中，其涉及相关参数通过用户自己的业务服务端来生成并下发（比如上传的 Token）。业务服务端集中管理 AccessKey 和\nSecretKey ，避免泄漏；其次 AccessKey 、SecretKey 和客户端应用需解耦，其因泄露更换时不会产生不必要麻烦。\n\n### 2.2 上传域名下发，并可以下发多个域名\n\nSDK 上传过程：\n\n 1. 获取七牛 Bucket 的上传域名； \n * 指定域名。通过指定区域 id 或直接给上传域名列表方式指定域名，详情见 域名配置 FixedZone；\n * SDK 自动查询域名。SDK 内部自动调用七牛服务端接口，查询 Bucket 的上传域名，详情见 域名配置 AutoZone；\n 2. 使用上传域名进行上传，上传过程会伴随主备重试，既多个域名时，一个域名上传失败，会尝试使用其他域名进行上传。\n\n**建议上传域名下发的方式**\n\n用户服务在下发上传 Token 时同时下发上传域名（可以在 App 需要进行上传时，先请求获取获取上传 Token 及上传域名），可下发多个域名，App\n在拿到 Token 和上传域名后，配置上传 Config 以及 UploadManager，进而进行上传操作。\n\n具体代码示例如下：\n\n \n \n // Upload_Domain1, Upload_Domain2 为服务下发的上传域名\n FixedZone fixedZone = new FixedZone(new String[]{\"Upload_Domain1\", \"Upload_Domain2\"});\n Configuration config = new Configuration.Builder()\n .zone(fixedZone)\n .build();\n UploadManager manager = new UploadManager(config);\n \n\n**域名下发的优点：**\n\n 1. 跳过域名查询过程，上传更高效。\n 2. 避免在 App 硬编码上传域名，导致使用不灵活，比如： \n * 在客户更换/增加区域时，由于 App 硬编码了区域，已发布的 App 无法处理此问题。\n * 某些客户生产环境使用的 Bucket 和 测试环境使用的 Bucket 不在同一个区域，在实际上线时错用了测试 Bucket 的区域，导致 Bucket 和区域不匹配，App 相关功能不可用。\n * 自定义域名，由于硬编码，老版本 App 也无法灵活应对。\n\n除了上面的问题，还有很多情景不再列举，上面问题的根本原因是由于 App 硬编码了区域的上传域名导致 App\n不能灵活应对上传域名需要修改的场景，所以建议客户通过服务下发上传的方式来配置 SDK 的上传域名, 而不是直接硬编码上传域名。\n\n# 3 域名配置\n\n域名配置分为 FixZone 和 AutoZone 两种方式。\n\n## 3.1 FixZone\n\n在 FixZone 中，上传域名被固定，且不可更改。有两种配置方式：\n\n### 3.1.1 通过指定上传区域 ID 方式\n\n区域 ID 和区域域名对应关系参考 [这里 __](https://developer.qiniu.com/kodo/1671/region-\nendpoint-fq)\n\n \n \n // 指定上传区域为 华东-浙江\n FixedZone zone = FixedZone.createWithRegionId(\"z0\");\n \n\n这种方式硬编码了上传域名的区域，且不可更改，所以不建议在生产环境中使用，仅供测试使用。\n\n### 3.1.2 直接配置上传域名\n\n直接配置上传域名的方式可以灵活配置域名，我们不建议上传域名配置为固定域名，而是通过服务下发的方式进行配置。具体上传域名下发请参考**上传域名下发** 介绍。\n\n \n \n // Upload_Domain1, Upload_Domain2 为服务下发的上传域名\n FixedZone zone = new FixedZone(new String[]{\"Upload_Domain1\", \"Upload_Domain2\"});\n \n\n## 3.2 AutoZone\n\n如果用户不想关心上传域名相关的逻辑，而且没有任何自定义的需求，完全依赖七牛的上传域名，则可以使用 AutoZone。AutoZone 相对于 FixZone\n来说，在第一次上传时查询上传域名，后续会使用缓存的上传域名进行上传。在缓存有效期内不会更换上传域名，当前域名缓存有效期为 24 小时。 \n示例代码：\n\n \n \n // 不指定 uc 域名，使用七牛公有云默认域名\n AutoZone zone = new AutoZone();\n \n // 指定 uc 域名，公有云无需指定\n AutoZone zone = new AutoZone();\n zone.setUcServers(new String[]{\"UCHost0\", \"UCHost1\"});\n \n\n不过我们推荐用户使用**上传域名下发** 的方式来配置上传域名，防止后续业务变更需要。\n\n# 4 上传\n\n## 4.1 上传示例\n\nSDK 内置两种上传方式：表单上传和分片上传，并根据具体情况，内部做了自动切换。表单上传使用一个 HTTP POST\n请求完成文件的上传，因此比较适合较小的文件和较好的网络环境。相比而言，分片上传更能适应不稳定的网络环境，也比较适合上传比较大的文件（例如数百 MB\n或更大）。\n\n若需深入了解上传方式之间的区别，请参阅上传类型中\n[表单上传](https://developer.qiniu.com/kodo/manual/1272/form-upload) 、[分片上传 v1\n版](https://developer.qiniu.com/kodo/manual/1650/chunked-upload) 和 [分片上传 v2\n版](https://developer.qiniu.com/kodo/6364/multipartupload-interface) 接口说明。\n\nUploadManager.put 参数说明：\n\n参数 | 类型 | 说明 \n---|---|--- \ndata | byte[]/String/File | 数据，可以是 byte 数组、文件路径、文件、数据流和 Uri 资源 \nkey | String | 保存在服务器上的资源唯一标识，请参阅 [键值对](https://developer.qiniu.com/kodo/manual/1277/product-introduction#key-value) \ntoken | String | 服务器分配的 token \ncompletionHandler | UpCompletionHandler | 上传回调函数，必填 \noptions | UploadOptions | 如果需要进度通知、中途取消、指定 mimeType，则需要填写相应字段，详见下面的 UploadOptions 参数说明 \n \nUploadOptions 参数说明：\n\n参数 | 类型 | 说明 \n---|---|--- \nparams | Map<String, String> | 自定义变量，key 必须以 x: 开始 \nmimeType | String | 指定文件的 mimeType \nprogressHandler | UpProgressHandler | 上传进度回调 \ncancellationSignal | UpCancellationSignal | 取消上传，当 isCancelled() 返回 true 时，不再执行更多上传 \n \n \n import com.qiniu.android.common.FixedZone;\n import com.qiniu.android.http.ResponseInfo;\n import com.qiniu.android.storage.Configuration;\n import com.qiniu.android.storage.FileRecorder;\n import com.qiniu.android.storage.KeyGenerator;\n import com.qiniu.android.storage.Recorder;\n import com.qiniu.android.storage.UpCancellationSignal;\n import com.qiniu.android.storage.UpCompletionHandler;\n import com.qiniu.android.storage.UpProgressHandler;\n import com.qiniu.android.storage.UploadManager;\n import com.qiniu.android.storage.UploadOptions;\n import com.qiniu.android.utils.Utils;\n \n Recorder recorder = null;\n try {\n recorder = new FileRecorder(Utils.sdkDirectory() + \"/recorder\");\n } catch (IOException e) {\n e.printStackTrace();\n }\n \n // uploadHosts 建议通过服务方式下发，\n String[] uploadHosts = new String[]{\"Host0\", \"Host1\"};\n FixedZone zone = new FixedZone(uploadHosts);\n Configuration configuration = new Configuration.Builder()\n .zone(zone) // 配置上传区域\n .putThreshold(4 * 1024 * 1024) // 分片上传阈值：4MB，大于 4MB 采用分片上传，小于 4MB 采用表单上传\n .useConcurrentResumeUpload(true) // 开启分片上传\n .recorder(recorder) // 文件分片上传时断点续传信息保存，表单上传此配置无效\n .resumeUploadVersion(Configuration.RESUME_UPLOAD_VERSION_V2) // 使用分片 V2\n .build();\n UploadManager uploadManager = new UploadManager(configuration);\n \n UploadOptions options = new UploadOptions(null, null, true,\n new UpProgressHandler() {\n @Override\n public void progress(String key, double percent) {\n // 上传进度\n }\n }, new UpCancellationSignal() {\n @Override\n public boolean isCancelled() {\n // 当需要取消时，此处返回 true，SDK 内部会多次检查返回值，当返回值为 true 时会取消上传操作\n return false;\n }\n });\n \n String filePath = \"\"; // 文件路径\n String key = \"\"; // 文件 key\n String uploadToken = \"\"; // 上传的 Token\n uploadManager.put(filePath, key, uploadToken, new UpCompletionHandler() {\n @Override\n public void complete(String key, ResponseInfo info, JSONObject response) {\n if (info != null && info.isOK()) {\n // 上传成功\n } else {\n // 上传失败\n }\n }\n }, options);\n \n\n## 4.2 上传配置介绍\n\n### 4.2.1 开启传输加速\n\n默认情况下，SDK 未开启使用加速域名上传的功能，如需开启需按下面方式进行配置：\n\n \n \n // 1. 在七牛云存储控制台修改 Bucket 配置，域名管理 -> 开启传输加速（SDK 开启使用加速域名上传的功能仅仅是 SDK 支持\n // 使用加速域名，所以要想使用传输加速，七牛云服务端需开启此功能）\n // \n // 2. SDK 配置 \n // 方式一：使用 FixZone 配置\n // Upload_Domain1 和 Upload_Domain2 为加速域名，可以参考七牛云存储控制台域名管理页面，建议通过用户服务下发，不要硬编码\n Zone zone = new FixedZone(new String[]{\"Upload_Domain1\", \"Upload_Domain2\"});\n Configuration configuration = new Configuration.Builder()\n .zone(zone) // 区域必须使用 AutoZone，默认是 AutoZone，所以 zone 也可以不配置\n .build();\n \n // 方式二：使用 AutoZone（v8.8.0 开始支持）\n Configuration configuration = new Configuration.Builder()\n .accelerateUploading(true) // 开启传输加速，此参数仅对使用 QNAutoZone 时有效\n .zone(new AutoZone()) // 默认是 AutoZone，所以 zone 也可以不配置\n .build();\n \n\n### 4.2.2 使用 HTTP/3 协议\n\n导入 [HTTP/3 client 插件 __](https://github.com/qiniu/qiniu-android-curl-\nplugin)，http3 client 插件依赖于 Android SDK v8.5.0及以上版本\n\n安装导入\n\n \n \n // 移除 qiniu-android-sdk 依赖 : implementation 'com.qiniu:qiniu-android-sdk:x.x.+' \n implementation 'com.qiniu:qiniu-android-curl-plugin:1.0.0'\n \n\n使用 CurlClient\n\n \n \n import com.qiniu.client.curl.CurlClient;\n import com.qiniu.android.storage.GlobalConfiguration;\n import com.qiniu.android.storage.Configuration;\n import com.qiniu.android.storage.UploadManager;\n \n // 开启 HTTP/3\n GlobalConfiguration.getInstance().enableHttp3 = true;\n \n // @param caPath: SSL 证书本地路径；如果想自定义 CA 可设置此选项，此处为 CA 文件的本地路径。\n // \t\t\t\t 如果未定义（caPath 配置 null）则使用 SDK 内部提供的 CA 证书，证书来源：https://curl.se/ca/cacert.pem\n CurlClient client = new CurlClient(caPath);\n Configuration config = new Configuration.Builder()\n .requestClient(client) // 指定 HTTP/3 Client\n .build();\n UploadManager manager = new UploadManager(config);\n \n\n### 4.2.3 DNS 预解析\n\nDNS 预解析是对 SDK 上传的一种优化，SDK 会先对上传域名提前做 DNS 解析并缓存（会根据有效期定期刷新缓存），等上传时直接使用缓存的 IP\n地址进行上传，可以跳过 DNS 解析阶段，提高上传的效率，在弱网场景效果比较明显。\n\n * 从 7.4.0 开始增加了 DNS 预解析和缓存策略，减少 DNS 解析错误。\n * 从 8.0.0 开始增加了每 2 分钟（进程非挂起状态）自动刷新缓存策略。同时增加了 DNS 预解析 开关控制，默认开启，可以通过 GlobalConfiguration.getInstance().isDnsOpen = false 关闭 DNS 预解析。\n * 从 8.3.2 开始对 DNS 预解析缓存增加缓存有效期，默认 10 分钟，支持手动修改有效期 GlobalConfiguration.getInstance().dnsCacheMaxTTL 时长，单位为 s。\n\nSDK 内置服务系统 DNS 解析和 HTTP DNS 解析（从 8.4.0 开始），如果这两个 DNS 解析不能满足您的需求，那么可以选择自定义 DNS\n解析。如果您自定义了 DNS 解析，那么在 DNS 预取时会优先使用您自定义的 DNS 解析，SDK 内部有 DNS 解析缓存相关的逻辑，用户无需考虑\nDNS 解析缓存相关的逻辑。一般情况下，我们不建议用户自己自定义 DNS 预解析。\n\n下方为 8.4.0 以上版本使用外部 DNS 组件 HappyDns 的示例代码(实例仅为使用方式演示，请根据您的需求自行处理 DNS\n解析细节)，如果找不到 Dns 类，可在工程的 Gradle 配置中依赖 HappyDns\n\n \n \n implementation 'com.qiniu:happy-dns:2.0.1'\n \n\n具体实例代码如下:\n\n \n \n import com.qiniu.android.dns.DnsManager;\n import com.qiniu.android.dns.Domain;\n import com.qiniu.android.dns.IResolver;\n import com.qiniu.android.dns.NetworkInfo;\n import com.qiniu.android.dns.Record;\n import com.qiniu.android.dns.dns.DnsUdpResolver;\n import com.qiniu.android.dns.dns.DohResolver;\n import com.qiniu.android.http.dns.Dns;\n import com.qiniu.android.http.dns.IDnsNetworkAddress;\n \n import java.io.IOException;\n import java.net.UnknownHostException;\n import java.util.ArrayList;\n import java.util.List;\n \n class CustomDns {\n \n public static Dns buildDefaultDns() {\n // 可添加修改 多个 IResolver\n // 适当调整不同 IResolver 的加入顺序，比如:223.5.5.5，119.29.29.29，114.114.114.114，8.8.8.8 等\n IResolver[] resolvers = new IResolver[2];\n // 自定义 DNS 服务器地址: UDP\n resolvers[0] = new DnsUdpResolver(\"8.8.8.8\");\n // 自定义 DNS 服务器地址：Doh\n resolvers[1] = new DohResolver(\"https://dns.alidns.com/dns-query\");\n \n final DnsManager dnsManager = new DnsManager(NetworkInfo.normal, resolvers);\n Dns dns = new Dns() {\n // 若抛出异常 Exception ，sdk 会使用 okhttp 组件默认 dns 解析结果\n @Override\n public List<IDnsNetworkAddress> lookup(String hostname) throws UnknownHostException {\n Domain domain = new Domain(hostname);\n List<IDnsNetworkAddress> addressList = null;\n try {\n Record[] records = dnsManager.queryRecords(domain);\n if (records != null && records.length > 0) {\n addressList = new ArrayList<>();\n for (Record record : records) {\n String source = \"customized\";\n DemoDnsNetworkAddress address = new DemoDnsNetworkAddress(hostname, record.value, (long) record.ttl, source, record.timeStamp);\n addressList.add(address);\n }\n }\n } catch (IOException ignored) {\n }\n return addressList;\n }\n };\n return dns;\n }\n \n public static class DemoDnsNetworkAddress implements IDnsNetworkAddress {\n private final String hostValue;\n private final String ipValue;\n private final Long ttlValue;\n private final String sourceValue;\n private final Long timestampValue;\n \n DemoDnsNetworkAddress(String hostValue,\n String ipValue,\n Long ttlValue,\n String sourceValue,\n Long timestampValue) {\n this.hostValue = hostValue;\n this.ipValue = ipValue;\n this.ttlValue = ttlValue;\n this.sourceValue = sourceValue;\n this.timestampValue = timestampValue;\n }\n \n @Override\n public String getHostValue() {\n return hostValue;\n }\n \n @Override\n public String getIpValue() {\n return ipValue;\n }\n \n @Override\n public Long getTtlValue() {\n return ttlValue;\n }\n \n @Override\n public String getSourceValue() {\n return sourceValue;\n }\n \n @Override\n public Long getTimestampValue() {\n return timestampValue;\n }\n }\n }\n \n // 在 UploadManager 初始化之前配置 \n GlobalConfiguration.getInstance().dns = CustomDns.buildDefaultDns();\n uploadManager = new UploadManager();\n \n\n### 4.2.4 其他配置\n\n \n \n // 自定义请求 client，需要自行实现\n IRequestClient client = null;\n \n // 定义分片上传时，断点续传信息保存的 Recorder\n Recorder recorder = null;\n try {\n recorder = new FileRecorder(Utils.sdkDirectory() + \"/recorder\");\n } catch (IOException e) {\n e.printStackTrace();\n }\n \n // 断点续传信息保存时使用的 key 的生成器，根据 key 可以获取相应文件的上传信息\n // 需要确保每个文件的 key 是唯一的，下面为默认值\n // 可以自定义，也可以不配置（keyGenerator 参数可以不传）\n KeyGenerator keyGenerator = new KeyGenerator() {\n @Override\n public String gen(String key, File file) {\n return key + \"_._\" + new StringBuffer(file.getAbsolutePath()).reverse();\n }\n @Override\n public String gen(String key, String sourceId) {\n if (sourceId == null) {\n sourceId = \"\";\n }\n return key + \"_._\" + sourceId;\n }\n };\n \n // 定义代理\n ProxyConfiguration proxy = new ProxyConfiguration(\"192.168.1.1\", 8888);\n Configuration configuration = new Configuration.Builder()\n .requestClient(client) // 自定义请求 client，内部所有请求都会走此 client\n .zone(new AutoZone()) // 配置上传区域，使用 AutoZone\n .recorder(recorder, keyGenerator) // 文件分片上传时断点续传信息保存，表单上传此配置无效\n .proxy(proxy)\n .useHttps(false)\n .chunkSize(4*1024*1024) // 文件采用分片上传时，分片大小为 4MB\n .putThreshold(4 * 1024 * 1024) // 分片上传阈值：4MB，大于 4MB 采用分片上传，小于 4MB 采用表单上传\n .connectTimeout(10) // 请求连接超时 10s\n .writeTimeout(30) // 请求写超时 30s\n .responseTimeout(10) // 请求响应超时 10s\n .retryMax(1) // 单个域名/IP请求失败后最大重试次数为 1 次\n .retryInterval(500) // 重试时间间隔\n .allowBackupHost(true) // 是否使用备用域名进行重试\n .urlConverter(new UrlConverter() {\n @Override\n public String convert(String url) {\n // 公有云不可配置\n return url;\n }\n })\n .useConcurrentResumeUpload(true) // 开启并发分片上传\n .concurrentTaskCount(3) // 使用并发分片上传时，一个文件并发上传的分片个数\n .resumeUploadVersion(Configuration.RESUME_UPLOAD_VERSION_V2) // 使用分片 V2\n .build();\n \n // 用于服务器上传回调通知的自定义参数，参数的key必须以x: 开头 eg: x:foo\n Map<String, String> params = new HashMap<>();\n // 用于设置meta数据，参数的key必须以x-qn-meta- 开头 eg: x-qn-meta-key\n Map<String, String> metaDataParam = new HashMap<>();\n // 指定文件 mime type\n String mimeType = \"\";\n UploadOptions options = new UploadOptions(params, null, mimeType, true,\n new UpProgressHandler() {\n @Override\n public void progress(String key, double percent) {\n // 上传进度\n }\n }, new UpCancellationSignal() {\n @Override\n public boolean isCancelled() {\n // 当需要取消时，此处返回 true，SDK 内部会多次检查返回值，当返回值为 true 时会取消上传操作\n return false;\n }\n }, null);\n \n // 关闭 DNS 预解析\n GlobalConfiguration.getInstance().isDnsOpen = false;\n // 关闭网络状态检测，当因网络异常而失败时，会检测网络状态，进而根据情况调整重试逻辑\n GlobalConfiguration.getInstance().connectCheckEnable = false;\n \n\n# 5 下载文件\n\n该 SDK 并未提供下载文件相关的功能接口，因为文件下载是一个标准的 HTTP GET 过程。开发者只需理解资源 URI 的组成格式即可非常方便的构建资源\nURI，并在必要的时候加上 [下载凭证](https://developer.qiniu.com/kodo/manual/1202/download-\ntoken) ，即可使用 HTTP GET 请求获取相应资源。\n\n从安全性和代码可维护性的角度考虑，我们建议下载 URL 的拼接过程也在业务服务器进行，让客户端从业务服务器请求。\n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n\n# 常见问题\n\n**1\\. 混淆处理** \n对 七牛 的 SDK 不需要做特殊混淆处理，如果有混淆，请将 七牛 相关的包都排除。\n\n * 在 Android Studio 中，混淆配置在 proguard-rules.pro 里面加上下面几行混淆代码就行：\n\n \n \n -keep class com.qiniu.**{*;}\n -keep class com.qiniu.**{public <init>();}\n -ignorewarnings\n \n\n**注意：**\n\n * ignorewarnings 这个也是必须加的，如果不加这个，编译的时候可能可以通过，但是 release 的时候还是会出现错误。\n * 在 eclipse 中，混淆配置在 proguard-project.txt 里面加上下面几行混淆代码就行：\n\n \n \n -keep class com.qiniu.**{*;}\n -keep class com.qiniu.**{public <init>();}\n -ignorewarnings\n \n\n**2\\. 为什么进度会在 95% 停很久？**\n\n因为上传进度是用 sdk 写入 socket 的字节数／总字节数作为进度，但写入 socket\n不等于服务器收到并且处理完成，中间还有一段时间，如果只是用字节数就会出现更怪异的情况，在 100% 停留很久，所以综合考虑就使用了 95% 这个值。\n\n如果您发现上传卡在 95% 很长的时间，请检查是否使用了上传回调业务服务器的功能，请确保业务服务器接受到上传回调后可以返回正确的状态码和回复内容。\n\n**3\\. 如何才能得到下载的 url ？**\n\n上传没有域名概念，只有 bucket ，一个 bucket 可以绑定多个域名。下载的 url 可以用 bucket 里的域名加 key 拼接而成，私有\nurl 还要加上 token。\n\n**4\\. 如何跳过 https 证书验证？**\n\n在部分测试环境发生 Trust anchor for certification path not found 异常，可以设置跳过 https 证书验证：在\nConfiguration 配置 useHttps( false ) 开启。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](http://support.qiniu.com/)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](http://support.qiniu.com/)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2021 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Android SDK历史文档"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [Android\nSDK](https://developer.qiniu.com/kodo/sdk/1236/android) > Android SDK历史文档\n\n# Android SDK历史文档\n\n最近更新时间: 2017-07-25 10:39:01\n\nAndroid SDK只包含了最终用户使用场景中的必要功能。相比服务端SDK而言，客户端SDK不会包含对云存储服务的管理和配置功能。\n\n该SDK支持不低于2.3的Android版本（api9）。\n\n * [SDK 下载地址](https://codeload.github.com/qiniu/android-sdk/zip/master)\n * [SDK 源码地址](https://github.com/qiniu/android-sdk)\n\n# 使用场景\n\n在使用Android\nSDK开发基于七牛云存储的应用之前，请理解正确的开发模型。客户端属于不可控的场景，恶意用户在拿到客户端后可能会对其进行反向工程，因此客户端程序中不可包含任何可能导致安全漏洞的业务逻辑和关键信息。\n\n我们推荐的安全模型如下所示：\n\n\n\n开发者需要合理划分客户端程序和业务服务器的职责范围。分发给最终用户的客户端程序中不应有需要使用管理凭证及SecretKey的场景。这些可能导致安全风险的使用场景均应被设计为在业务服务器上进行。\n\n更多的相关内容请查看[编程模型](https://developer.qiniu.com/kodo/manual/programming-\nmodel)和[安全机制](https://developer.qiniu.com/kodo/manual/security)。\n\n# 接入SDK\n\n该SDK没有包含工程文件，这时需要自己新建一个工程，然后将src里面的代码复制到代码目录里面。\n\n# 安全性\n\n该SDK未包含凭证生成相关的功能。开发者对安全性的控制应遵循[安全机制](https://developer.qiniu.com/kodo/manual/security)中建议的做法，即客户端应向业务服务器每隔一段时间请求上传凭证，而不是直接在客户端使用AccessKey/SecretKey生成对应的凭证。在客户端使用SecretKey会导致严重的安全隐患。\n\n开发者可以在生成上传凭证前通过配置上传策略以控制上传的后续动作，例如在上传完成后通过回调机制通知业务服务器。该工作在业务服务器端进行，因此非本SDK的功能范畴。\n\n完整的内容请参考[上传策略](https://developer.qiniu.com/kodo/manual/put-\npolicy)，[上传凭证](https://developer.qiniu.com/kodo/manual/upload-\ntoken)，[下载凭证](https://developer.qiniu.com/kodo/manual/download-token)。\n\n# 上传文件\n\n开发者可以选择SDK提供的两种上传方式：表单上传和分片上传。表单上传使用一个HTTP\nPOST请求完成文件的上传，因此比较适合较小的文件和较好的网络环境。相比而言，分片上传更能适应不稳定的网络环境，也比较适合上传比较大的文件（数百MB或更大）。\n\n若需深入了解上传方式之间的区别，可以参考：[表单上传](https://developer.qiniu.com/kodo/manual/form-\nupload)接口说明，[分片上传](https://developer.qiniu.com/kodo/manual/chunked-\nupload)接口说明。\n\n## 简单直传\n\n开发者可以通过调用`IO.put()`方法来以表单形式上传一个文件。使用该方式时应确认相应的资源大小合适于使用单一HTTP请求即可上传。过大的文件在使用该方式上传时比较容易出现超时失败的问题。该方式比较适合用于上传经压缩的小图片和短音频等，不适合用于上传较大的视频（例如尺寸超过100MB的）。\n\n该方法的详细说明如下：\n\n \n \n public static UploadTaskExecutor put(Authorizer auth, String key,\n InputStreamAt isa, PutExtra extra, CallBack callback);\n \n\n参数说明：\n\n参数 | 类型 | 说明 \n---|---|--- \n`auth` | `Authorizer` | 用于设置或获取上传token。获取新的token后，设置到auth中，下次上传(如分片上传的下一片)会使用新的token，减少token过期。 \n`key` | `String` | 将保存为的资源唯一标识。请参考[键值对](https://developer.qiniu.com/kodo/manual/1277/product-introduction#key-value)。 \n`isa` | `InputStreamAt` | 待上传的Uri、File、InputStream、byte[]的包装类。 \n`extra` | [`PutExtra`](https://github.com/qiniu/android-sdk/blob/6.x/src/com/qiniu/rs/PutExtra.java) | 上传额外参数。可以设置MIME类型等。 \n`callback` | [`CallBack`](https://github.com/qiniu/android-sdk/blob/6.x/src/com/qiniu/rs/CallBack.java) | 开发者需实现该接口以获取上传进度和上传结果。 \n若上传成功，该接口中的`onSuccess()`方法将被调用。否则`onFailure()`方法将被调用。\n`onProgress()`会在文件上传量发生更改的时候被调用。运行在主线程中。 \n \n返回值： `UploadTaskExecutor` 提供 `cancel` 等方法。\n\n开发者可以在调用方法前构造一个`PutExtra`对象，设置对应的上传参数以控制上传行为。可以设置的参数如下：\n\n参数 | 类型 | 说明 \n---|---|--- \n`mimeType` | `String` | 指定上传文件的MIME类型。如果未指定，服务端将做自动检测。一般情况下无需设置。 \n`crc32` | `long` | 本文件的CRC校验码。服务端在上传完成后可以进行一次校验确认文件的完整性。 \n`params` | `HashMap<String, String>` | 可设置魔法变量和自定义变量。变量可帮助开发者快速的在客户端、业务服务器、云存储服务之间传递资源元信息。详见[变量](https://developer.qiniu.com/kodo/manual/vars)。 \n \n以下是一个关于`PutExtra`使用的示例：\n\n \n \n extra.mimeType = \"application/json\"; // 强制设置MIME类型\n \n extra.params = new HashMap<String, String>();\n extra.params.put(\"x:a\", \"bb\"); // 设置一个自定义变量\n \n\n表单上传的示例代码请参见SDK示例中[`MyActivity.doUpload()`](https://github.com/qiniu/android-\nsdk/blob/6.x/src/com/qiniu/demo/MyActivity.java)方法的实现。\n\n## 断点续上传\n\n可基于分片上传机制实现断点续上传功能。\n\n \n \n public static UploadTaskExecutor put(Authorizer auth, String key,\n InputStreamAt input, PutExtra extra, CallBack callback)\n \n public static UploadTaskExecutor put(Authorizer auth, String key,\n InputStreamAt input, PutExtra extra, List<Block> blocks, CallBack callback)\n \n public Block(int idx, String ctx, int length, String host)\n \n\n具体用法和`IO.put`的类似。`blocks`为已上传的块断点记录，以4M为一个断点记录单元。\n\n参数 | 类型 | 说明 \n---|---|--- \n`idx` | `int` | 待上传资源的第几块，从 0 开始 \n`ctx` | `String` | 上传成功后的块级上传控制信息 \n`length` | `int` | 块的长度。小于等于4M \n`host` | `String` | 后续上传接收地址 \n \n`CallBack#onBlockSuccess(Block blk)` 一个块上传成功后，会调用此回调，可根据情况保存断点记录。\n\n分片上传的示例代码请参见SDK示例中[`MyResumableActivity.doResumableUpload()`](https://github.com/qiniu/android-\nsdk/blob/6.x/src/com/qiniu/demo/MyResumableActivity.java)方法的实现。\n\n实际情况中，本地文件可能修改，在恢复上传前先做相应的校验。\n\n# 下载文件\n\n该SDK并未提供下载文件相关的功能接口，因为文件下载是一个标准的HTTP\nGET过程。开发者只需理解资源URI的组成格式即可非常方便的构建资源URI，并在必要的时候加上下载凭证，即可使用HTTP GET请求获取相应资源。\n\n从安全性和代码可维护性的角度考虑，我们建议下载URL的拼装过程也在业务服务器进行，让客户端从业务服务器请求。\n\n# 线程安全性\n\nAndroid 一般的情况下会使用一个主线程来控制UI，非主线程无法控制UI，在Android4.0+之后不能在主线程完成网络请求，\n该SDK是根据以上的使用场景设计，所有网络的操作均使用AsyncTask异步运行，所有回调函数又都回到了主线程（`onSuccess()`,\n`onFailure()`, `onProgress()`）,在回调函数内可以直接操作UI控件。\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 `git checkout -b my-new-feature`\n\n 3. 提交您的改动 `git commit -am 'Added some feature'`\n\n 4. 将您的修改记录提交到远程 `git` 仓库 `git push origin my-new-feature`\n\n 5. 然后到 github 网站的该 `git` 远程仓库的 `my-new-feature` 分支下发起 Pull Request\n\n# 许可证\n\nCopyright (c) 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Android SDK V7"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [Android\nSDK](https://developer.qiniu.com/kodo/sdk/1236/android) > [Android\nSDK历史文档](https://developer.qiniu.com/kodo/sdk/1664/android-sdk-6) > Android\nSDK V7\n\n# Android SDK V7\n\n最近更新时间: 2021-07-08 14:57:06\n\n本文档适用于 v7.x 版本 Android SDK \nAndroid SDK 只包含了最终用户使用场景中的必要功能。相比服务端 SDK 而言，客户端 SDK 不会包含对云存储服务的管理和配置功能。\n\n * [Android SDK 下载地址 __](https://github.com/qiniu/android-sdk/releases)\n * [Android SDK 源码地址 __](https://github.com/qiniu/android-sdk)\n * [Android SDK 历史文档](https://developer.qiniu.com/kodo/sdk/android-sdk-6)\n\n# 安装\n\n### Gradle\n\n`compile 'com.qiniu:qiniu-android-sdk:7.6.4'`\n\n### 相关链接\n\n * [qiniu-android-sdk __](https://github.com/qiniu/android-sdk/)\n * [okhttp __](http://square.github.io/okhttp/)\n\n如果需要下载历史 jar 包，也可以在 maven 上直接下载，请参考[这里\n__](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.qiniu%22%20AND%20a%3A%22qiniu-\nandroid-sdk%22)。\n\n# 安全机制\n\n该 SDK\n未包含凭证生成相关的功能。开发者对安全性的控制应遵循[安全机制](https://developer.qiniu.com/kodo/manual/security)中建议的做法，即客户端应向业务服务器每隔一段时间请求[上传凭证](https://developer.qiniu.com/kodo/manual/upload-\ntoken)，而不是直接在客户端使用 AccessKey / SecretKey 生成对应的凭证。在客户端使用 SecretKey 会导致严重的安全隐患。\n\n开发者可以在生成上传凭证前通过配置[上传策略](https://developer.qiniu.com/kodo/manual/put-\npolicy)来控制上传的后续动作，例如在上传完成后通过回调机制通知业务服务器。该工作在业务服务器端进行，因此非本 SDK 的功能范畴。\n\n七牛的服务端SDK提供了上传凭证的生成功能，请参考各个服务端语言的SDK文档。\n\n# 初始化\n\n一般情况下可以直接使用默认设置，不用单独配置。可以配置超时时长、分片上传阀值等。\n\n \n \n Configuration config = new Configuration.Builder()\n .connectTimeout(10) // 链接超时。默认10秒\n .useHttps(true) // 是否使用https上传域名\n .responseTimeout(60) // 服务器响应超时。默认60秒\n .recorder(recorder) // recorder分片上传时，已上传片记录器。默认null\n .recorder(recorder, keyGen) // keyGen 分片上传时，生成标识符，用于片记录器区分是那个文件的上传记录\n .zone(FixedZone.zone0) // 设置区域，不指定会自动选择。指定不同区域的上传域名、备用域名、备用IP。\n .build();\n \n // 重用uploadManager。一般地，只需要创建一个uploadManager对象\n UploadManager uploadManager = new UploadManager(config, 3);//配置3个线程数并发上传；不配置默认为3，只针对file.size>4M生效。线程数建议不超过5，上传速度主要取决于上行带宽，带宽很小的情况单线程和多线程没有区别\n \n \n\n# 版本\n\nQiniu SDK 版本 | 最低 Android版本 | 依赖库版本 \n---|---|--- \n7.6.x | Android 5.0+ | okhttp 4+ \n7.5.x | Android 5.0+ | okhttp 4+ \n7.4.6 | Android 4.0+ | okhttp 3.12.6 \n7.3.x | Android 2.3+ | okhttp 3.11.0 \n7.2.x | Android 2.3+ | okhttp 3+ \n7.1.x | Android 2.3+ | okhttp 2.6+ \n7.0.8,7.0.9 | Android 2.2+ | android-async-http 1.4.9 \n7.0.7 | Android 2.2+ | android-async-http 1.4.8 \n \n### 注意\n\n * 推荐使用最新版：7.6.4，7.6.4使用okhttp4.2.2\n * 7.4.6是在7.6.4版本上降低okhttp版本，其他功能不变，AndroidNetwork.getMobileDbm()可以获取手机信号强度，需要如下权限(API>=18时生效)\n\n \n \n <uses-permission android:name=\"android.permission.ACCESS_COARSE_LOCATION\"/>\n <uses-permission android:name=\"android.permission.ACCESS_FINE_LOCATION\"/>\n \n\n * 从 7.3.13 开始，不在强制依赖 `happy-dns-android`，默认不再提供 `httpDns`，可以调用 `Configuration.Builder#dns(com.qiniu.android.http.Dns)`方法设置外部 `Dns`，自定义 `Dns` 要求实现 `com.qiniu.android.http.Dns` 接口。\n * 从7.5.0开始增加了DNS预取和缓存策略，减少dns解析错误\n * 如果可以明确 区域 的话，最好指定固定区域，这样可以少一步网络请求，少一步出错的可能。\n\n下方为使用外部 `dns` 组件 `httpDns` 的示例代码：\n\n \n \n import com.qiniu.android.http.Dns;\n \n \tpublic Dns buildDefaultDns() {\n // 可添加修改 多个 IResolver \n // 适当调整不同 IResolver 的加入顺序，比如 223.5.5.5，119.29.29.29，114.114.114.114，8.8.8.8 等 \n ArrayList<IResolver> rs = new ArrayList<IResolver>(3);\n try {\n IResolver r1 = new Resolver(InetAddress.getByName(\"119.29.29.29\"));\n rs.add(r1);\n } catch (Exception ex) {\n ex.printStackTrace();\n }\n try {\n rs.add(new Resolver(InetAddress.getByName(\"114.114.114.114\")));\n } catch (Exception ex) {\n ex.printStackTrace();\n }\n try {\n // 读取系统相关属性\n // android 27 及以上 会报错\n IResolver r2 = AndroidDnsServer.defaultResolver();\n rs.add(r2);\n } catch (Exception ex) {\n ex.printStackTrace();\n }\n if (rs.size() == 0) {\n return null;\n }\n \n final DnsManager happlyDns = new DnsManager(NetworkInfo.normal, rs.toArray(new IResolver[rs.size()]));\n \n Dns dns = new Dns() {\n // 若抛出异常 Exception ，sdk 会使用 okhttp 组件默认 dns 解析结果 \n @Override\n public List<InetAddress> lookup(String hostname) throws UnknownHostException {\n InetAddress[] ips;\n try {\n ips = happlyDns.queryInetAdress(new Domain(hostname));\n } catch (IOException e) {\n e.printStackTrace();\n throw new UnknownHostException(e.getMessage());\n }\n if (ips == null || ips.length == 0) {\n throw new UnknownHostException(hostname + \" resolve failed.\");\n }\n List<InetAddress> l = new ArrayList<>();\n Collections.addAll(l, ips);\n return l;\n }\n };\n return dns;\n }\n \t\n \tConfiguration config = new Configuration.Builder()\n \t\t\t\t\t\t// .xxxx(xxxx) // 设置其它属性\n \t\t\t\t\t\t.dns(buildDefaultDns()).build();\n \tuploadManager = new UploadManager(config);\n \t\n \n\n * 部分老本版（7.3.12 及以下版本）默认使用 `happy-dns-android` ，在 android 8 下运行可能报错 `java.io.IOException: cant get local dns server`，可以禁用外部 `dns`，规避错误:\n\n \n \n Configuration config = new Configuration.Builder()\n //.xxxx()\n .dns(null)\n //.yyyy()\n .build();\n \n \n\n# 上传文件\n\nSDK 内置两种上传方式：表单上传和分片上传，并根据具体情况，内部做了自动切换。表单上传使用一个 HTTP POST\n请求完成文件的上传，因此比较适合较小的文件和较好的网络环境。相比而言，分片上传更能适应不稳定的网络环境，也比较适合上传比较大的文件（例如数百 MB\n或更大）。\n\n若需深入了解上传方式之间的区别，请参阅上传类型中[表单上传](https://developer.qiniu.com/kodo/manual/form-\nupload)和[分片上传](https://developer.qiniu.com/kodo/manual/chunked-upload)接口说明。\n\nUploadManager.put 参数说明：\n\n参数 | 类型 | 说明 \n---|---|--- \ndata | byte[]/String/File | 数据，可以是 byte 数组、文件路径、文件 \nkey | String | 保存在服务器上的资源唯一标识，请参阅[键值对](https://developer.qiniu.com/kodo/manual/1277/product-introduction#key-value) \ntoken | String | 服务器分配的 token \ncompletionHandler | UpCompletionHandler | 上传回调函数，必填 \noptions | UploadOptions | 如果需要进度通知、中途取消、指定 mimeType，则需要填写相应字段，详见下面的 UploadOptions 参数说明 \n \nUploadOptions 参数说明：\n\n参数 | 类型 | 说明 \n---|---|--- \nparams | Map<String, String> | 自定义变量，key 必须以 x: 开始 \nmimeType | String | 指定文件的 mimeType \nprogressHandler | UpProgressHandler | 上传进度回调 \ncancellationSignal | UpCancellationSignal | 取消上传，当 isCancelled() 返回 true 时，不再执行更多上传 \n \n## 简单上传\n\n可以参考[简单上传demo __](https://github.com/JemyCheung/upload_android)\n\n \n \n //指定zone的具体区域 \n //FixedZone.zone0 华东机房\n //FixedZone.zone1 华北机房\n //FixedZone.zone2 华南机房\n //FixedZone.zoneNa0 北美机房\n \n //自动识别上传区域 \n //AutoZone.autoZone\n \n \n //Configuration config = new Configuration.Builder()\n //.zone(Zone.autoZone)\n //.zone(FixedZone.zone0)\n //.build();\n //UploadManager uploadManager = new UploadManager(config);\n data = <File对象、或 文件路径、或 字节数组>\n String key = <指定七牛服务上的文件名，或 null>;\n String token = <从服务端SDK获取>;\n uploadManager.put(data, key, token,\n new UpCompletionHandler() {\n @Override\n public void complete(String key, ResponseInfo info, JSONObject res) {\n //res包含hash、key等信息，具体字段取决于上传策略的设置\n if(info.isOK()) {\n Log.i(\"qiniu\", \"Upload Success\");\n } else {\n Log.i(\"qiniu\", \"Upload Fail\");\n //如果失败，这里可以把info信息上报自己的服务器，便于后面分析上传错误原因\n }\n Log.i(\"qiniu\", key + \",\\r\\n \" + info + \",\\r\\n \" + res);\n }\n }, null);\n \n \n\n回调参数说明：\n\n参数 | 说明 \n---|--- \nkey | uploadManager.put(file, key, …) 方法指定的 key \ninfo | http 请求的状态信息等，可记入日志，isOK() 返回 true 表示上传成功 \nresponse | 七牛反馈的信息。可从中解析保存在七牛服务的 key 等信息，具体字段取决上传策略的设置 \n \n**注意：**可能会抛出文件不存在，没有权限访问等异常。\n\n## 上传进度\n\n \n \n uploadManager.put(data, key, token,handler,\n new UploadOptions(null, null, false,\n new UpProgressHandler(){\n public void progress(String key, double percent){\n Log.i(\"qiniu\", key + \": \" + percent);\n }\n }, null));\n \t\t\t\t\n \n\n**注意：**progress(key, percent) 中的 key 即 uploadManager.put(file, key, …) 方法指定的\nkey。\n\n## 取消上传\n\n内部代码会检测 UpCancellationSignal##isCancelled() 的返回值，当其返回 true 时，将停止上传。可外部维护一个变量\nisCancelled，当点击取消按钮时，设置 isCancelled = true; 。例如：\n\n \n \n // 初始化、执行上传\n private volatile boolean isCancelled = false;\n \n uploadManager.put(data, key, token,handler,\n new UploadOptions(null, null, false, progressHandler,\n new UpCancellationSignal(){\n public boolean isCancelled(){\n return isCancelled;\n }\n }));\n \n \n // 点击取消按钮，让UpCancellationSignal##isCancelled()方法返回true，以停止上传\n private void cancell() {\n isCancelled = true;\n }\n \n \n\n## 记录断点\n\n分片上传中，可将各个已上传的块记录下来，再次上传时，已上传的部分不用再次上传。断点记录类需实现\ncom.qiniu.android.storage.Recorder 接口。已提供保存到文件的 FileRecorder 实现。\n\n \n \n String dirPath = <断点记录文件保存的文件夹位置>\n Recorder recorder = null;\n try {\n recorder = new FileRecorder(dirPath);\n }catch (Exception e){\n \n }\n \n //默认使用key的url_safe_base64编码字符串作为断点记录文件的文件名\n //避免记录文件冲突（特别是key指定为null时），也可自定义文件名(下方为默认实现)：\n KeyGenerator keyGen = new KeyGenerator(){\n public String gen(String key, File file){\n // 不必使用url_safe_base64转换，uploadManager内部会处理\n // 该返回值可替换为基于key、文件内容、上下文的其它信息生成的文件名\n return key + \"_._\" + new StringBuffer(file.getAbsolutePath()).reverse();\n }\n };\n \n // 重用uploadManager。一般地，只需要创建一个uploadManager对象\n //UploadManager uploadManager = new UploadManager(recorder); // 1\n //UploadManager uploadManager = new UploadManager(recorder, keyGen); // 2\n // 或在初始化时指定：\n Configuration config = new Configuration.Builder()\n // recorder分片上传时，已上传片记录器\n // keyGen分片上传时，生成标识符，用于片记录器区分是哪个文件的上传记录\n .recorder(recorder, keyGen) \n .build();\n UploadManager uploadManager = new UploadManager(config);\n \n uploadManager.put(data, key, ...)\n \n \n\n# 下载文件\n\n该 SDK 并未提供下载文件相关的功能接口，因为文件下载是一个标准的 HTTP GET 过程。开发者只需理解资源 URI 的组成格式即可非常方便的构建资源\nURI，并在必要的时候加上[下载凭证](https://developer.qiniu.com/kodo/manual/download-\ntoken)，即可使用 HTTP GET 请求获取相应资源。\n\n从安全性和代码可维护性的角度考虑，我们建议下载 URL 的拼接过程也在业务服务器进行，让客户端从业务服务器请求。\n\n# 线程安全性\n\nAndroid 一般情况下会使用一个主线程来控制 UI，非主线程无法控制 UI，在 Android4.0+ 之后不能在主线程完成网络请求，该 SDK\n是根据以上的使用场景设计，所有的网络操作均使用独立的线程异步运行，UpCompletionHandler##complete、UpProgressHandler##progress\n是在主线程调用的，在回调函数内可以直接操作 UI 控件。\n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n\n# 常见问题\n\n**1\\. 混淆处理**\n\n对七牛的 SDK 不需要做特殊混淆处理，如果有混淆，请将七牛相关的包都排除。\n\n * 在 Android Studio 中，混淆配置在 proguard-rules.pro 里面加上下面几行混淆代码就行：\n\n \n \n -keep class com.qiniu.**{*;}\n -keep class com.qiniu.**{public <init>();}\n -ignorewarnings\n \n\n**注意：** -ignorewarnings 这个也是必须加的，如果不加这个，编译的时候可能可以通过，但是 release 的时候还是会出现错误。\n\n * 在 eclipse 中，混淆配置在 proguard-project.txt 里面加上下面几行混淆代码就行：\n\n \n \n -keep class com.qiniu.**{*;}\n -keep class com.qiniu.**{public <init>();}\n -ignorewarnings\n \n\n**2\\. 为什么进度会在 95% 停很久？**\n\n因为上传进度是用 sdk 写入 socket 的字节数／总字节数作为进度，但写入 socket\n不等于服务器收到并且处理完成，中间还有一段时间，如果只是用字节数就会出现更怪异的情况，在 100% 停留很久，所以综合考虑就使用了 95% 这个值。\n\n如果您发现上传卡在 95% 很长的时间，请检查是否使用了上传回调业务服务器的功能，请确保业务服务器接受到上传回调后可以返回正确的状态码和回复内容。\n\n**3\\. 如何才能得到下载的 url ？**\n\n上传没有域名概念，只有 bucket ，一个 bucket 可以绑定多个域名。下载的 url 可以用 bucket 里的域名加 key 拼接而成，私有\nurl 还要加上 token。\n\n**4\\. 如何跳过 https 证书验证？**\n\n在部分测试环境发生 Trust anchor for certification path not found 异常，可以设置跳过 https 证书验证：在\nConfiguration 配置 useHttps(false) 开启。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](http://support.qiniu.com/)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](http://support.qiniu.com/)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储C/C++ SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > C/C++ SDK\n\n# C/C++ SDK\n\n最近更新时间: 2024-01-02 10:55:21\n\n本 SDK 使用符合 C89 标准的 C 语言实现。由于 C 语言的普适性，原则上此 SDK 可以跨所有主流平台，不仅可以直接在 C 和 C++\n的工程中使用，也可以用于与 C 语言交互性较好的语言中，例如 C#（使用 P/Invoke 交互）、Java（使用 JNI 交互）、Lua 等。\n\n本开发指南假设开发者使用的开发语言是 C/C++，C-SDK 以开源方式提供。开发者可以从本文档提供的下载地址查看和下载 SDK\n的源代码，并按自己的工程现状进行合理使用，例如编译为静态库或者动态库后进行链接，或者直接将 SDK\n的源代码加入到自己的工程中一起编译，以保持工程设置的简单性。\n\n * [C/C++ SDK 源码地址 __](https://github.com/qiniu/c-sdk)\n * [C/C++ SDK Demo __](https://github.com/qiniu/c-sdk/tree/master/examples)\n\n从 v5.0.0 版本开始，我们对 SDK 的内容进行了精简。所有管理操作， \n例如创建/删除 bucket，为 bucket 绑定域名\n(publish)，设置数据处理的样式分隔符，新增数据处理样式等都去除了，建议统一到七牛[开发者平台\n__](https://portal.qiniu.com/)完成。另外，此前服务端还有自己独有的上传 API，现在也推荐统一成基于客户端上传的工作方式。\n\n从内容上来说，C-SDK 主要包含如下几方面的内容：\n\n * 公共部分，所有情况下都用到：qiniu/base.c、qiniu/conf.c、qiniu/http.c\n * 客户端上传文件：qiniu/base_io.c、qiniu/io.c\n * 客户端断点续上传：qiniu/base_io.c、qiniu/io.c、qiniu/multipart_upload.c\n * 数据处理：qiniu/fop.c\n * 服务端操作：qiniu/auth_mac.c（授权），qiniu/rs.c（资源管理，上传凭证 uptoken/下载凭证 dntoken 生成）\n * cdn相关功能：qiniu/cdn.c\n\n# 安装\n\nC-SDK 使用[cURL __](http://curl.haxx.se/)进行网络相关操作。无论是作为客户端还是服务端，都需要依赖\ncURL。如果作为服务端，C-SDK 因为需要用 HMAC 进行数字签名做授权（简称签名授权），所以依赖了[OpenSSL\n__](http://www.openssl.org/)库。C-SDK 并没有带上这 2 个外部库，因此在使用 C-SDK\n之前，首先确认您的当前开发环境中是否已经安装了这 2 个外部库，然后检查这 2 个外部库的头文件目录和库文件目录是否都已经加入到了项目工程的设置。\n\n在主流的 *nix 环境下，通常[cURL __](http://curl.haxx.se/)和[OpenSSL\n__](http://www.openssl.org/)都已经随系统默认安装到了 /usr/include 和 /usr/lib\n目录下。如果您的系统还没有这些库，请自行安装。\n\n如果你使用 gcc 进行编译，服务端典型的链接选项是：-lcurl -lssl -lcrypto -lm，客户端则是：-lcurl -lm。\n\n如果在项目构建过程中出现环境相关的编译错误和链接错误，请确认这些选项是否都已经正确配置，以及所依赖的库是否都已经正确安装。\n\n**ACCESS_KEY 和 SECRET_KEY**\n\n如果你的服务端采用 C-SDK，那么使用 C-SDK 前，您需要拥有一对有效的 AccessKey 和 SecretKey\n用来进行签名授权。可以通过如下步骤获得：\n\n 1. 点击[注册🔗 __](https://portal.qiniu.com/signup)开通 七牛开发者帐号\n 2. 登录七牛开发者平台，点击[个人中心 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\nC-SDK 的 conf.h 文件中声明了对应的两个变量：QINIU_ACCESS_KEY 和\nQINIU_SECRET_KEY。您需要在启动程序之初初始化这两个变量为七牛颁发的 AccessKey 和 SecretKey。\n\n**初始化**\n\n对于服务端而言，常规程序流程是：\n\n \n \n Qiniu_Client client;\n \n QINIU_ACCESS_KEY = \"<Please apply your access key>\";\n QINIU_SECRET_KEY = \"<Dont send your secret key to anyone>\";\n \n Qiniu_Servend_Init(-1); /* 全局初始化函数，整个进程只需要调用一次 */\n Qiniu_Client_InitMacAuth(&client, 1024, NULL); /* HTTP客户端初始化。HTTP客户端是线程不安全的，不要在多个线程间共用 */\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n \n ...\n \n Qiniu_Client_Cleanup(&client); /* 每个HTTP客户端使用完后释放 */\n Qiniu_Servend_Cleanup(); /* 全局清理函数，只需要在进程退出时调用一次 */\n \n\n对于客户端而言，常规程序流程是：\n\n \n \n Qiniu_Client client;\n \n Qiniu_Global_Init(-1); /* 全局初始化函数，整个进程只需要调用一次 */\n Qiniu_Client_InitNoAuth(&client, 1024); /* HTTP客户端初始化。HTTP客户端是线程不安全的，不要在多个线程间共用 */\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n \n ...\n \n Qiniu_Client_Cleanup(&client); /* 每个HTTP客户端使用完后释放 */\n Qiniu_Global_Cleanup(); /* 全局清理函数，只需要在进程退出时调用一次 */\n \n\n两者主要的区别在于：\n\n * 客户端没有 QINIU_ACCESS_KEY、QINIU_SECRET_KEY 变量（不需要初始化）。\n\n * 客户端没有签名授权，所以初始化 Qiniu_Client 对象应该用 Qiniu_Client_InitNoAuth 而不是 Qiniu_Client_InitMacAuth。\n\n * 客户端初始化／清理用 Qiniu_Global_Init/Cleanup，而服务端用 Qiniu_Servend_Init/Cleanup 这对函数。\n\n# 内存管理\n\n在 C-SDK\n中，有一些函数会涉及到内存的动态分配。这些函数的一惯处理方式是在函数内部申请内存，并以指针的形式直接返回。这就要求函数调用者在得到指针后，需要在恰当的时机去释放这些内存。对于特殊的结构体，C-SDK\n都会提供特定的函数来释放内存，例如 Qiniu_Buffer 提供了 Qiniu_Buffer_Cleanup 函数。而对于其他基本数据类型的指针，则由\nQiniu_Free 函数来负责释放不再使用的内存。\n\n## HTTP 客户端\n\n在 C-SDK 中，HTTP 客户端叫 Qiniu_Client。在某些语言环境中，这个类是线程安全的，多个线程可以共享同一份实例，但在 C-SDK\n中它被设计为线程不安全的。一个重要的原因是我们试图简化内存管理的负担。HTTP 请求结果的生命周期被设计成由 Qiniu_Client\n负责，在下一次请求时会自动释放上一次 HTTP 请求的结果。如果某个 HTTP 请求结果的数据需要长期使用，建议您复制一份，如：\n\n \n \n void stat(Qiniu_Client* client, const char* bucket, const char* key) {\n \tQiniu_RS_StatRet ret;\n \tQiniu_Error err = Qiniu_RS_Stat(client, &ret, bucket, key);\n \tif (err.code != 200) {\n \t\tdebug(client, err);\n \t\treturn;\n \t}\n \tprintf(\"hash: %s, fsize: %lld, mimeType: %s\\n\", ret.hash, ret.fsize, ret.mimeType);\n }\n \n\n这个例子中，Qiniu_RS_Stat 请求返回了 Qiniu_Error 和 Qiniu_RS_StatRet 两个结构体。其中的 Qiniu_Error\n类型如下：\n\n \n \n typedef struct _Qiniu_Error {\n \tint code;\n \tconst char* message;\n } Qiniu_Error;\n \n\nQiniu_RS_StatRet 类型如下：\n\n \n \n typedef struct _Qiniu_RS_StatRet {\n \tconst char* hash;\n \tconst char* mimeType;\n \tQiniu_Int64 fsize;\n \tQiniu_Int64 putTime;\n \tQiniu_Int64 type;\n } Qiniu_RS_StatRet;\n \n\n**注意：*_Qiniu_Error.message、Qiniu_RS_StatRet.hash、Qiniu_RS_StatRet.mimeType\n都声明为 const char_ 类型，是个只读字符串，并不管理字符串内容的生命周期。 \n这些字符串什么时候失效？下次 Qiniu_Client 发生网络 API 请求时失效。如果您需要长久使用，建议您复制一份，如：\n\n \n \n hash = strdup(ret.hash);\n \n\n## 错误处理与调试\n\n在 HTTP 请求出错的时候，C-SDK 统一返回了一个 Qiniu_Error 结构体：\n\n \n \n typedef struct _Qiniu_Error {\n \tint code;\n \tconst char* message;\n } Qiniu_Error;\n \n\n即一个错误码和对应的描述消息。这个错误码有可能是 cURL 的错误码，表示请求发送环节发生了意外，或者是一个 HTTP\n错误码，表示请求发送正常，服务器端处理请求后返回了 HTTP 错误码。\n\n如果一切正常，code 应该是 200，即 HTTP 的 OK 状态码。如果不是 200，则需要对 code 值进行相应分析。对于低于 200\n的值，可以查看[cURL错误码 __](http://curl.haxx.se/libcurl/c/libcurl-\nerrors.html)，否则应查看七牛[HTTP状态码 __](https://support.qiniu.com/question/156583)。\n\n如果 message 指示的信息还不够友好，也可以尝试把整个 HTTP 返回包打印出来看看：\n\n \n \n void debug(Qiniu_Client* client, Qiniu_Error err)\n {\n \tprintf(\"\\nerror code: %d, message: %s\\n\", err.code, err.message);\n \tprintf(\"respose header:\\n%s\", Qiniu_Buffer_CStr(&client->respHeader));\n \tprintf(\"respose body:\\n%s\", Qiniu_Buffer_CStr(&client->b));\n }\n \n\n# 文件上传\n\n * 上传流程\n * 上传凭证\n * 简单上传凭证\n * 覆盖上传凭证\n * 自定义上传回复凭证\n * 带回调业务服务器的凭证\n * 带数据处理的凭证\n * 带自定义参数的凭证\n * 综合上传凭证\n * 服务器直传\n * 构建配置流程\n * 文件上传（表单方式）\n * 文件分片上传（断点续传）\n * 解析自定义回复内容\n * 业务服务器验证存储服务回调\n\n## 上传流程\n\n在七牛云存储中，整个上传流程大致分为以下几步：\n\n 1. 业务服务器颁发[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)给客户端（终端用户）\n 2. 客户端凭借上传凭证上传文件到七牛\n 3. 在七牛获得完整数据后，发起一个 HTTP 请求回调到业务服务器\n 4. 业务服务器保存相关信息，并返回一些信息给七牛\n 5. 七牛原封不动地将这些信息转发给客户端（终端用户）\n\n**注意：**回调到业务服务器的过程是可选的，它取决于业务服务器颁发的上传凭证。如果没有回调，七牛会返回一些标准的信息（例如文件的 hash）给客户端。 \n如果上传发生在业务服务器，以上流程简化为：\n\n 1. 业务服务器生成上传凭证\n 2. 凭借上传凭证上传文件到七牛\n 3. 后续工作，例如保存一些相关信息\n\n## 上传凭证\n\n \n上传凭证实际上是用 AccessKey/SecretKey 进行数字签名的上传策略\nQiniu_RS_PutPolicy，它控制着整个上传流程的行为。具体上传策略参数的解释可见\n[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)\n\n \n \n typedef struct _Qiniu_RS_PutPolicy {\n const char *scope;\n const char *saveKey;\n Qiniu_Uint32 isPrefixalScope;\n const char *callbackUrl;\n const char *callbackHost;\n const char *callbackBody;\n const char *callbackBodyType;\n const char *callbackFetchKey;\n const char *returnUrl;\n const char *returnBody;\n const char *endUser;\n const char *persistentOps;\n const char *persistentNotifyUrl;\n const char *persistentPipeline;\n const char *mimeLimit;\n Qiniu_Uint64 fsizeLimit;\n Qiniu_Uint64 fsizeMin;\n Qiniu_Uint32 detectMime;\n Qiniu_Uint32 insertOnly;\n Qiniu_Uint32 expires;\n Qiniu_Uint32 deleteAfterDays;\n Qiniu_Uint32 fileType;\n } Qiniu_RS_PutPolicy;\n \n\n在构建上传凭证之前，我们首先要定义鉴权对象Qiniu_mac\n\n \n \n Qiniu_Mac mac;\n mac.accessKey = \"your access key\";\n mac.secretKey = \"your secret key\";\n \n\n### **简单上传的凭证**\n\n最简单的上传凭证只需要`AccessKey`，`SecretKey`和`Bucket`就可以。\n\n \n \n //简单上传凭证\n char *bucket=\"your bucket name\";\n Qiniu_RS_PutPolicy putPolicy;\n Qiniu_Zero(putPolicy);\n putPolicy.scope = bucket;\n char *uptoken = Qiniu_RS_PutPolicy_Token(&putPolicy, &mac);\n printf(\"simple:\\t%s\\n\\n\", uptoken);\n Qiniu_Free(uptoken);\n \n\n默认情况下，在不指定上传凭证的有效时间情况下，默认有效期为1个小时。也可以自行指定上传凭证的有效期，例如：\n\n \n \n //自定义凭证有效期（示例2小时，expires单位为秒，为上传凭证的有效时间）\n Qiniu_RS_PutPolicy putPolicy;\n Qiniu_Zero(putPolicy);\n putPolicy.scope = bucket;\n putPolicy.expires = 7200; //单位秒\n char *uptoken = Qiniu_RS_PutPolicy_Token(&putPolicy, &mac);\n printf(\"returnBody:\\t%s\\n\\n\", uptoken);\n \n\n### **覆盖上传的凭证**\n\n覆盖上传除了需要`简单上传`所需要的信息之外，还需要想进行覆盖的文件名称，这个文件名称同时可是客户端上传代码中指定的文件名，两者必须一致。\n\n \n \n //覆盖上传\n Qiniu_RS_PutPolicy putPolicy;\n Qiniu_Zero(putPolicy);\n char *keyToOverwrite = \"qiniu.png\";\n putPolicy.scope = Qiniu_String_Concat3(bucket, \":\",keyToOverwrite);\n char *uptoken = Qiniu_RS_PutPolicy_Token(&putPolicy, &mac);\n printf(\"overwrite:\\t%s\\n\\n\", uptoken);\n \n\n### **自定义上传回复的凭证**\n\n默认情况下，文件上传到七牛之后，在没有设置`returnBody`或者`回调`相关的参数情况下，七牛返回给上传端的回复格式为`hash`和`key`，例如：\n\n \n \n {\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"key\":\"qiniu.jpg\"}\n \n\n有时候我们希望能自定义这个返回的JSON格式的内容，可以通过设置`returnBody`参数来实现，在`returnBody`中，我们可以使用七牛支持的[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)和[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)。\n\n \n \n //自定义返回值\n Qiniu_RS_PutPolicy putPolicy;\n Qiniu_Zero(putPolicy);\n putPolicy.scope = bucket;\n putPolicy.returnBody = \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"fsize\\\":$(fsize),\\\"bucket\\\":\\\"$(bucket)\\\",\\\"name\\\":\\\"$(x:name)\\\"}\";\n char *uptoken = Qiniu_RS_PutPolicy_Token(&putPolicy, &mac);\n printf(\"returnBody:\\t%s\\n\\n\", uptoken);\n \n \n\n则文件上传到七牛之后，收到的回复内容如下：\n\n \n \n {\"key\":\"qiniu.jpg\",\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"bucket\":\"if-bc\",\"fsize\":39335,\"name\":\"qiniu\"}\n \n\n### **带回调业务服务器的凭证**\n\n上面生成的`自定义上传回复`的上传凭证适用于上传端（无论是客户端还是服务端）和七牛服务器之间进行直接交互的情况下。在客户端上传的场景之下，有时候客户端需要在文件上传到七牛之后，从业务服务器获取相关的信息，这个时候就要用到七牛的上传回调及相关回调参数的设置。\n\n \n \n Qiniu_RS_PutPolicy putPolicy;\n Qiniu_Zero(putPolicy);\n putPolicy.scope = bucket;\n putPolicy.callbackUrl = \"http://api.example.com/upload/callback\";\n putPolicy.callbackBodyType = \"application/json\";\n putPolicy.callbackBody = \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"fsize\\\":$(fsize),\\\"bucket\\\":\\\"$(bucket)\\\",\\\"name\\\":\\\"$(x:name)\\\"}\";\n char *uptoken = Qiniu_RS_PutPolicy_Token(&putPolicy, &mac);\n printf(\"callback(json):\\t%s\\n\\n\", uptoken);\n \n\n在使用了上传回调的情况下，客户端收到的回复就是业务服务器响应七牛的JSON格式内容。 \n通常情况下，我们建议使用`application/json`格式来设置`callbackBody`，保持数据格式的统一性。实际情况下，`callbackBody`也支持`application/x-www-\nform-urlencoded`格式来组织内容，这个主要看业务服务器在接收到`callbackBody`的内容时如何解析。例如：\n\n \n \n Qiniu_RS_PutPolicy putPolicy;\n Qiniu_Zero(putPolicy);\n putPolicy.scope = bucket;\n putPolicy.callbackUrl = \"http://api.example.com/upload/callback\";\n //putPolicy.callbackBodyType = \"application/json\";\n putPolicy.callbackBody =\"key=$(key)&hash=$(etag)&bucket=$(bucket)&fsize=$(fsize)&name=$(x:name)\" ;\n char *uptoken = Qiniu_RS_PutPolicy_Token(&putPolicy, &mac);\n printf(\"callback(json):\\t%s\\n\\n\", uptoken);\n \n\n### **带数据处理的凭证**\n\n七牛支持在文件上传到七牛之后，立即对其进行多种指令的数据处理，这个只需要在生成的上传凭证中指定相关的处理参数即可。\n\n \n \n //持久化数据处理的上传凭证\n char *saveMp4Entry = Qiniu_String_Concat3(bucket, \":\", \"avthumb_test_target.mp4\");\n char *saveMp4EntryEncoded = Qiniu_String_Encode(saveMp4Entry);\n \n char *saveJpgEntry = Qiniu_String_Concat3(bucket, \":\", \"vframe_test_target.jpg\");\n char *saveJpgEntryEncoded = Qiniu_String_Encode(saveJpgEntry);\n \n Qiniu_Free(saveMp4Entry);\n Qiniu_Free(saveJpgEntry);\n \n char *avthumbMp4Fop = Qiniu_String_Concat2(\"avthumb/mp4|saveas/\", saveMp4EntryEncoded);\n char *vframeJpgFop = Qiniu_String_Concat2(\"vframe/jpg/offset/1|saveas/\", saveJpgEntryEncoded);\n \n Qiniu_Free(saveMp4EntryEncoded);\n Qiniu_Free(saveJpgEntryEncoded);\n \n char *fops[] = {avthumbMp4Fop, vframeJpgFop};\n char *persistentFops = Qiniu_String_Join(\";\", fops, 2);\n \n putPolicy.scope = bucket;\n putPolicy.persistentPipeline = \"sdktest\";\n putPolicy.persistentNotifyUrl = \"http://api.example.com/pfop/notify\";\n putPolicy.persistentOps = persistentFops;\n \n uptoken = Qiniu_RS_PutPolicy_Token(&putPolicy, &mac);\n printf(\"persistent:\\t%s\\n\\n\", uptoken);\n \n\n队列 pipeline 请参阅[创建私有队列 __](https://portal.qiniu.com/dora/media-\ngate/pipeline)；转码操作具体参数请参阅[音视频转码](https://developer.qiniu.com/dora/api/audio-\nand-video-transcoding-avthumb)；saveas\n请参阅[处理结果另存](https://developer.qiniu.com/dora/api/processing-results-save-\nsaveas)。\n\n### **带自定义参数的凭证**\n\n存储支持客户端上传文件的时候定义一些自定义参数，这些参数可以在`returnBody`和`callbackBody`里面和七牛内置支持的魔法变量（即系统变量）通过相同的方式来引用。这些自定义的参数名称必须以`x:`开头。例如客户端上传的时候指定了自定义的参数`x:name`和`x:age`分别是`string`和`int`类型。那么可以通过下面的方式引用：\n\n \n \n returnBody: '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\",\"age\":$(x:age)}'\n }\n \n\n或者\n\n \n \n callbackBody: '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\",\"age\":$(x:age)}',\n }\n \n\n### **综合上传凭证**\n\n上面的生成上传凭证的方法，都是通过设置[上传策略🔗](https://developer.qiniu.com/kodo/manual/1206/put-\npolicy)相关的参数来支持的，这些参数可以通过不同的组合方式来满足不同的业务需求，可以灵活地组织你所需要的上传凭证。\n\n## 服务端直传\n\n服务端直传是指客户利用七牛服务端SDK从服务端直接上传文件到七牛云，交互的双方一般都在机房里面，所以服务端可以自己生成上传凭证，然后利用SDK中的上传逻辑进行上传，最后从七牛云获取上传的结果，这个过程中由于双方都是业务服务器，所以很少利用到上传回调的功能，而是直接自定义`returnBody`来获取自定义的回复内容。\n\n### **构建配置流程**\n\n存储支持空间创建在不同的区域，并且支持http和https上传。 \n在使用七牛的 C-SDK 中的`Qiniu_Client_EnableAutoQuery(&client,\nQiniu_True)`函数可以开启`client`的区域自动检测功能，参数`Qiniu_True`代表使用https方式上传。此外也可以手动指定区域，通过使用`Qiniu_Region\n*region = Qiniu_Use_Region(regionId,\nQiniu_True)`函数可以生成对应的上传空间到`region`对象，参数`regionId`为七牛区域 ID\n字符串，参数`Qiniu_True`代表使用https方式上传。然后调用`Qiniu_Client_SpecifyRegion(&client,\nregion)`方法将`region`对象设置到`client`上，必须注意，在`client`被使用完毕后，需要额外调用`Qiniu_Region_Free(region)`回收`region`对象，否则会造成内存泄漏。\n\n其中关于`Region`对象和区域的关系如下：\n\n区域 | 对应函数 \n---|--- \n华东-浙江 | `Qiniu_Use_Region(\"z0\", Qiniu_True)` \n华北-河北 | `Qiniu_Use_Region(\"z1\", Qiniu_True)` \n华南-广东 | `Qiniu_Use_Region(\"z2\", Qiniu_True)` \n北美-洛杉矶 | `Qiniu_Use_Region(\"na0\", Qiniu_True)` \n亚太-新加坡 | `Qiniu_Use_Region(\"as0\", Qiniu_True)` \n华东-浙江2 | `Qiniu_Use_Region(\"cn-east-2\", Qiniu_True)` \n \n### **文件上传（表单方式）**\n\n最简单的就是上传本地文件，直接指定文件的完整路径即可上传。\n\n \n \n Qiniu_Global_Init(-1);\n \n Qiniu_Mac mac;\n mac.accessKey = \"your access key\";\n mac.secretKey = \"your secret key\";\n \n char *bucket = \"your bucket name\";\n char *key = \"qiniu.mp4\";\n char *localFile = \"/Users/jemy/Documents/qiniu.mp4\";\n \n Qiniu_Io_PutRet putRet;\n Qiniu_Client client;\n Qiniu_RS_PutPolicy putPolicy;\n Qiniu_Io_PutExtra putExtra;\n Qiniu_Zero(putPolicy);\n Qiniu_Zero(putExtra);\n \n putPolicy.scope = bucket;\n \n char *uptoken = Qiniu_RS_PutPolicy_Token(&putPolicy, &mac);\n \n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_Io_PutFile(&client, &putRet, uptoken, key, localFile, &putExtra);\n if (error.code != 200) {\n printf(\"upload file %s:%s error.\\n\", bucket, key);\n debug_log(&client, error);\n } else {\n /*200, 正确返回了, 你可以通过statRet变量查询一些关于这个文件的信息*/\n printf(\"upload file %s:%s success.\\n\\n\", bucket, key);\n printf(\"key:\\t%s\\n\",putRet.key);\n printf(\"hash:\\t%s\\n\", putRet.hash);\n }\n Qiniu_Free(uptoken);\n Qiniu_Client_Cleanup(&client);\n \n\n### **文件分片上传（断点续传）**\n\n除了基本的上传外，七牛还支持将文件切成若干块。可以选择分片上传版本，推荐 Qiniu_Multipart_PutFile，表示 [分片上传 v2\n版](https://developer.qiniu.com/kodo/api/6364/multipartupload-\ninterface)，Qiniu_Rio_PutFile，表示 [分片上传 v1\n版](https://developer.qiniu.com/kodo/api/7443/shard-to-upload)。 \n断点续上传、分块上传的基本样例：\n\n分片上传 v2 版 （v7.1.0之上版本支持）\n\n \n \n int resumable_upload(Qiniu_Client* client, char* uptoken, const char* key, const char* localFile, Qiniu_MultipartUpload_Result* putRet) {\n Qiniu_Error err;\n Qiniu_Recorder recorder;\n err = Qiniu_FileSystem_Recorder_New(\"/tmp\", &recorder);\n if (err.code != 200) {\n return err.code;\n }\n Qiniu_Multipart_PutExtra extra;\n Qiniu_Zero(extra);\n extra.recorder = &recorder; // 支持断点续传\n extra.partSize = 4 << 20 // 分片上传 v2 支持自定义分片大小，公有云片的大小范围在 1MB ~ 1GB 。 \n err = Qiniu_Multipart_PutFile(client, uptoken, key, localFile, &extra, putRet);\n recorder.free(&recorder);\n return err.code;\n }\n \n\n相比普通上传，断点续上传代码没有变复杂。基本上就只是将 Qiniu_Io_PutExtra 改为\nQiniu_Multipart_PutExtra，Qiniu_Io_PutFile 改为 Qiniu_Multipart_PutFile。\n\n实际上 Qiniu_Multipart_PutFile 多了不少配置项，其中最重要的是：recorder，它被用来设置断点的存储方式，例如可以用\nQiniu_FileSystem_Recorder_New 来创建基于文件系统的断点存储，你也可以基于 Qiniu_Recorder\n对象定义自己的断点存储方式。\n\n分片上传 v1 版\n\n \n \n int resumable_upload(Qiniu_Client* client, char* uptoken, const char* key, const char* localFile) {\n Qiniu_Error err;\n Qiniu_Recorder recorder;\n err = Qiniu_FileSystem_Recorder_New(\"/tmp\", &recorder);\n if (err.code != 200) {\n return err.code;\n }\n Qiniu_Rio_PutExtra extra;\n Qiniu_Zero(extra);\n extra.bucket = bucket;\n extra.recorder = &recorder; // 支持断点续传\n err = Qiniu_Rio_PutFile(client, NULL, uptoken, key, localFile, &extra);\n recorder.free(&recorder);\n return err.code;\n }\n \n\n### **解析自定义回复内容**\n\n有些情况下，七牛返回给上传端的内容不是默认的`hash`和`key`形式，这种情况下，可能出现在自定义`returnBody`或者自定义了`callbackBody`的情况下，前者一般是服务端直传的场景，而后者则是接受上传回调的场景，这两种场景之下，都涉及到需要将自定义的回复进行内容解析，一般建议在交互过程中，都采用`JSON`的方式，这样处理起来方法比较一致。\n\n### **业务服务器验证存储服务回调**\n\n在上传策略里面设置了上传回调相关参数的时候，七牛在文件上传到服务器之后，会主动地向`callbackUrl`发送POST请求的回调，回调的内容为`callbackBody`模版所定义的内容，如果这个模版里面引用了[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)或者[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)，那么这些变量会被自动填充对应的值，然后在发送给业务服务器。\n\n**注意** ：业务端服务器回调鉴权的Content-Type类型应该与上传策略中指定的callbackBodyType相同，默认为\napplication/x-www-form-urlencoded，当 Content-Type 为 application/x-www-form-\nurlencoded 时，签名内容必须包括请求内容。当 Content-Type 为 application/json 时，签名内容不包括请求内容。\n\n业务服务器在收到来自七牛的回调请求的时候，可以根据请求头部的`Authorization`字段来进行验证，查看该请求是否是来自七牛的未经篡改的请求,具体可以参考七牛的[回调鉴权](https://developer.qiniu.com/kodo/kb/1409/seven-\ncattle-callback-and-callback-authentication)。\n\n# 下载文件\n\n * 公开空间\n * 私有空间\n\n文件下载分为公开空间的文件下载和私有空间的文件下载。 \n\n## 公开空间\n\n \n每个 bucket 都会绑定一个或多个域名 (domain)。如果这个 bucket 是公开的，那么该 bucket 中的所有文件可以通过一个公开的下载\nurl 访问：\n\n \n \n http://domain/key\n \n\n其中 `domain` 是 bucket 对应的域名。七牛云存储为每一个 bucket 提供一个默认域名。默认域名可以到[七牛开发者平台\n__](https://portal.qiniu.com/)中的存储空间查询。\n\n假设某个 bucket 既绑定了七牛的二级域名，如：hello.qiniudn.com，也绑定了自定义域名（需要备案），如：hello.com。那么该\nbucket 中 key 为 test.mp4 的文件可以通过 `http://hello.qiniudn.com/qiniu.mp4` 或\n`http://hello.com/qiniu.mp4` 中任意一个 url 进行访问。\n\n## 私有空间\n\n如果某个 bucket 是私有的，那么这个 bucket 中的所有文件只能通过一个临时有效的 downloadUrl 访问：\n\n \n \n http://domain/key?e=<deadline>&token=<dntoken>\n \n\n其中 `dntoken`\n是由业务服务器签发的一个临时[下载凭证](https://developer.qiniu.com/kodo/manual/1202/download-\ntoken)，`deadline` 是其有效期。下载凭证不需要单独生成，C-SDK 提供了生成完整 downloadUrl 的方法（包含了\ndntoken），示例代码如下：\n\n \n \n char* downloadUrl(const char* domain, const char* key, Qiniu_Mac* mac) {\n \n char* url = 0;\n char* baseUrl = 0;\n \n Qiniu_RS_GetPolicy getPolicy;\n Qiniu_Zero(getPolicy);\n \n baseUrl = Qiniu_RS_MakeBaseUrl(domain, key);\n url = Qiniu_RS_GetPolicy_MakeRequest(&getPolicy, baseUrl, mac);\n Qiniu_Free(baseUrl);\n return url;\n }\n \n\n生成 downloadUrl 后，服务端下发 downloadUrl 给客户端。客户端收到 downloadUrl 后，和公有资源类似，直接用任意的\nHTTP 客户端就可以下载该资源了。需要注意的是，在 downloadUrl 失效却还没有完成下载时，需要重新向服务器申请授权。 \n\n# 资源管理\n\n资源管理包括的主要功能有： \n资源管理包括对存储在七牛云存储上的文件进行查看、删除、复制和移动处理。同时七牛云存储也支持对文件进行相应的批量操作。所有操作都会返回一个\nQiniu_Error 的结构体，用于记录本次操作的成功／失败信息。\n\n * 获取文件信息\n * 修改文件MimeType\n * 修改文件存储类型\n * 移动或重命名文件\n * 复制文件副本\n * 删除空间中的文件\n * 设置或更新文件生存时间\n * 获取指定前缀文件列表\n * 抓取网络资源到空间\n * 更新镜像存储空间中文件内容\n * 资源管理批量操作\n * 批量获取文件信息\n * 批量修改文件类型\n * 批量删除文件\n * 批量复制文件\n * 批量移动或重命名文件\n * 批量更新文件的有效期\n * 批量更新文件存储类型\n\n## 获取文件信息\n\n通过调用 Qiniu_RS_Stat，可以得到指定文件的属性信息。除了会返回一个 Qiniu_Error 结构体外，Qiniu_RS_Stat 还会返回\nQiniu_RS_StatRet 结构体，其中记录了被查询文件的一些属性信息。\n\n \n \n char *bucket=\"if-pbl\";\n char *key=\"qiniu.mp4\";\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_Stat(&client, &statRet, bucket, key);\n if (error.code != 200) {\n printf(\"stat file %s:%s error.\\n\", bucket, key);\n debug_log(&client, error);\n } else {\n /*200, 正确返回了, 你可以通过statRet变量查询一些关于这个文件的信息*/\n printf(\"stat file \\t%s:%s success.\\n\\n\", bucket, key);\n printf(\"file hash: \\t%s\\n\", statRet.hash);\n printf(\"file size: \\t%lld\\n\", statRet.fsize);\n printf(\"file put time: \\t%lld\\n\", statRet.putTime);\n printf(\"file mime type: \\t%s\\n\", statRet.mimeType);\n printf(\"file type: \\t%lld\\n\", statRet.type);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 修改文件MimeType\n\n \n \n char *bucket=\"if-pbl\";\n char *key=\"qiniu.mp4\";\n char *newMime=\"video/x-mp4\";\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_ChangeMime(&client, bucket, key, newMime);\n if (error.code != 200) {\n printf(\"change file mime %s:%s error.\\n\", bucket, key);\n debug_log(&client, error);\n } else {\n \tprintf(\"change file mime %s:%s success.\\n\\n\", bucket, key);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 修改文件存储类型\n\n \n \n char *bucket = \"if-pbl\";\n char *key = \"qiniu.mp4\";\n //fileType 为 0 表示普通存储，fileType 为 1 表示低频存储，fileType 为 2 表示归档存储，fileType 为 3 表示深度归档存储，fileType 为 4 表示归档直读存储\n int fileType = 1;\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_ChangeType(&client, bucket, key, fileType);\n if (error.code != 200) {\n printf(\"change file type %s:%s error.\\n\", bucket, key);\n debug_log(&client, error);\n } else {\n \tprintf(\"change file type %s:%s success.\\n\\n\", bucket, key);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 移动或重命名文件\n\n移动操作本身支持移动文件到相同，不同空间中，在移动的同时也可以支持文件重命名。唯一的限制条件是，移动的源空间和目标空间必须在同一个区域。\n\n源空间 | 目标空间 | 源文件名 | 目标文件名 | 描述 \n---|---|---|---|--- \nBucketA | BucketA | KeyA | KeyB | 相当于同空间文件重命名 \nBucketA | BucketB | KeyA | KeyA | 移动文件到BucketB，文件名一致 \nBucketA | BucketB | KeyA | KeyB | 移动文件到BucketB，文件名变成KeyB \n \n`move`操作支持强制覆盖选项，即如果目标文件已存在，可以设置强制覆盖选项`force`来覆盖那个文件的内容。\n\n \n \n char *srcbucket=\"if-pbl\";\n char *srcKey = \"qiniu.png\";\n char *destBucket = srcBucket;\n char *destKey = \"qiniu_move.png\";\n Qiniu_Bool force = Qiniu_True;\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_Move(&client, srcBucket, srcKey, destBucket, destKey, force);\n if (error.code != 200) {\n \tprintf(\"move file %s:%s -> %s:%s error.\\n\", srcBucket, srcKey, destBucket, destKey);\n \tdebug_log(&client, error);\n } else {\n \tprintf(\"move file %s:%s -> %s:%s success.\\n\", srcBucket, srcKey, destBucket, destKey);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 复制文件副本\n\n文件的复制和文件移动其实操作一样，主要的区别是移动后源文件不存在了，而复制的结果是源文件还存在，只是多了一个新的文件副本。\n\n \n \n char *srcBucket=\"if-pbl\";\n char *srcKey = \"qiniu.png\";\n char *destBucket = srcBucket;\n char *destKey = \"qiniu_copy.png\";\n Qiniu_Bool force = Qiniu_True;\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_Copy(&client, srcBucket, srcKey, destBucket, destKey, force);\n if (error.code != 200) {\n \tprintf(\"copy file %s:%s -> %s:%s error.\\n\", srcBucket, srcKey, destBucket, destKey);\n \tdebug_log(&client, error);\n } else {\n \tprintf(\"copy file %s:%s -> %s:%s success.\\n\", srcBucket, srcKey, destBucket, destKey);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 删除空间中的文件\n\n \n \n char *bucket=\"if-pbl\";\n char *key=\"qiniu.mp4\";\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_Delete(&client, bucket, key);\n if (error.code != 200) {\n printf(\"delete file %s:%s error.\\n\", bucket, key);\n debug_log(&client, error);\n } else {\n \tprintf(\"delete file %s:%s file success.\\n\", bucket, key);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 设置或更新文件的生存时间\n\n可以给已经存在于空间中的文件设置文件生存时间，或者更新已设置了生存时间但尚未被删除的文件的新的生存时间。\n\n \n \n char *bucket=\"if-pbl\";\n char *key=\"qiniu.mp4\";\n int days=7;\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_DeleteAfterDays(&client, bucket, key, days);\n if (error.code != 200) {\n printf(\"deleteAfterDays file %s:%s error.\\n\", bucket, key);\n debug_log(&client, error);\n } else {\n \tprintf(\"deleteAfterDays file %s:%s file success.\\n\", bucket, key);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 获取指定空间的文件列表\n\n \n \n // @param options 列举操作的可选参数\n // prefix 列举的文件前缀\n // marker 上一次列举返回的位置标记，作为本次列举的起点信息\n // limit 每次返回的最大列举文件数量\n // delimiter 指定目录分隔符\n char *bucket=\"if-pbl\";\n char **commonPrefixes = NULL;\n Qiniu_RSF_ListItem *items = NULL;\n char *prefix = \"\";\n char *delimiter = \"/\";\n char *marker = \"\";\n char *nextMarker = marker;\n Qiniu_Bool isNewMarker = Qiniu_False;\n Qiniu_RSF_ListRet listRet;\n int limit = 10;\n int i;\n \n //init\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n \n do {\n Qiniu_Error error = Qiniu_RSF_ListFiles(&client, &listRet, bucket, prefix, delimiter, nextMarker, limit);\n if (error.code != 200) {\n printf(\"list files of bucket %s error.\\n\", bucket);\n debug_log(&client, error);\n nextMarker = \"\";\n }\n else {\n /*200, 正确返回了, 你可以通过listRet变量查询文件列表信息*/\n printf(\"list files of bucket %s success.\\n\\n\", bucket);\n \n //check next marker\n if (isNewMarker == Qiniu_True) {\n free(nextMarker);\n }\n \n if (!str_empty(listRet.marker)) {\n nextMarker = strdup(listRet.marker);\n isNewMarker = Qiniu_True;\n }\n else {\n nextMarker = NULL;\n }\n printf(\"next marker: %s\\n\", nextMarker);\n \n //common prefixes\n commonPrefixes = listRet.commonPrefixes;\n for (i = 0; i < listRet.commonPrefixesCount; i++) {\n printf(\"commonPrefix: %s\\n\", *commonPrefixes);\n ++commonPrefixes;\n }\n \n //items\n items = listRet.items;\n for (i = 0; i < listRet.itemsCount; i++) {\n Qiniu_RSF_ListItem item = listRet.items[i];\n printf(\"key: %s, hash: %s, fsize: %lld, mime: %s, putTime: %lld, endUser: %s, type: %lld\\n\",\n item.key, item.hash, item.fsize, item.mimeType, item.putTime, item.endUser, item.type);\n }\n \n //free\n Qiniu_RSF_ListRet_Cleanup(&listRet);\n }\n } while (!str_empty(nextMarker));\n \n Qiniu_Client_Cleanup(&client);\n \n\n## 抓取网络资源到空间\n\n \n \n //fetch with key\n Qiniu_RS_FetchRet fetchRet;\n char *bucket=\"if-pbl\";\n char *resURL = \"http://devtools.qiniu.com/qiniu.png\";\n char *key = \"qiniu.png\";\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_Fetch(&client, &fetchRet, resURL, bucket, key);\n if (error.code != 200) {\n printf(\"fetch file %s -> %s:%s error.\\n\", resURL, bucket, key);\n debug_log(&client, error);\n } else {\n /*200, 正确返回了, 你可以通过fetchRet变量查询一些关于这个文件的信息*/\n printf(\"fetch file %s -> %s:%s success.\\n\", resURL, bucket, key);\n printf(\"file key: \\t%s\\n\", fetchRet.key);\n printf(\"file hash: \\t%s\\n\", fetchRet.hash);\n printf(\"file size: \\t%lld\\n\", fetchRet.fsize);\n printf(\"file mime type: \\t%s\\n\", fetchRet.mimeType);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 更新镜像空间中存储的文件内容\n\n \n \n char *bucket=\"if-pbl\";\n char *key=\"qiniu.mp4\";\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_Prefetch(&client, bucket, key);\n if (error.code != 200) {\n printf(\"prefetch file %s:%s error.\\n\", bucket, key);\n debug_log(&client, error);\n } else {\n printf(\"prefetch file \\t%s:%s success.\\n\\n\", bucket, key);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 资源管理批量操作\n\n### __ 批量获取文件信息 __\n\n \n \n Qiniu_RS_BatchStatRet *statRets;\n int i;\n char *bucket=\"if-pbl\";\n char *key=\"qiniu.mp4\";\n Qiniu_ItemCount entryCount = 10;\n Qiniu_RS_EntryPath *entries = (Qiniu_RS_EntryPath *) malloc(sizeof(Qiniu_RS_EntryPath) * entryCount);\n for (i = 0; i < entryCount; i++) {\n Qiniu_RS_EntryPath entry;\n entry.bucket = bucket;\n \n size_t indexLen = snprintf(NULL, 0, \"%d\", i) + 1;\n char *indexStr = (char *) calloc(sizeof(char), indexLen);\n snprintf(indexStr, indexLen, \"%d\", i);\n entry.key = Qiniu_String_Concat2(key, indexStr);\n Qiniu_Free(indexStr);\n entries[i] = entry;\n }\n \n statRets = (Qiniu_RS_BatchStatRet *) malloc(sizeof(Qiniu_RS_BatchStatRet) * entryCount);\n \n //init\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_BatchStat(&client, statRets, entries, entryCount);\n if (error.code / 100 != 2) {\n printf(\"batch stat file error.\\n\");\n debug_log(&client, error);\n } else {\n /*200, 正确返回了, 你可以通过statRets变量查询一些关于这个文件的信息*/\n printf(\"batch stat file success.\\n\\n\");\n \n for (i = 0; i < entryCount; i++) {\n Qiniu_RS_StatRet data = statRets[i].data;\n int code = statRets[i].code;\n if (code == 200) {\n printf(\"file hash: \\t%s\\n\", data.hash);\n printf(\"file size: \\t%lld\\n\", data.fsize);\n printf(\"file put time: \\t%lld\\n\", data.putTime);\n printf(\"file mime type: \\t%s\\n\", data.mimeType);\n printf(\"file type: \\t%lld\\n\", data.type);\n } else {\n printf(\"error: %s\\n\", statRets[i].error);\n }\n }\n }\n Qiniu_Client_Cleanup(&client);\n \n\n其中，entries 是一个指向 Qiniu_RS_EntryPath 结构体数组的指针，entryCount 为数组 entries 的长度。结构体\nQiniu_RS_EntryPath 中填写每个文件相应的 bucket 和 key：\n\n \n \n typedef struct _Qiniu_RS_EntryPath {\n const char* bucket;\n const char* key;\n } Qiniu_RS_EntryPath;\n \n\nQiniu_RS_BatchStat 会将文件信息（及成功／失败信息）依次写入一个由结构体 Qiniu_RS_BatchStatRet 组成的数组空间\nrets。因此，调用之前，需要先给 rets 申请好相应长度的内存空间。\n\n其中结构体 Qiniu_RS_BatchStatRet 的组成如下：\n\n \n \n typedef struct _Qiniu_RS_BatchStatRet {\n Qiniu_RS_StatRet data;\n const char* error;\n int code;\n }Qiniu_RS_BatchStatRet;\n \n\n### **批量修改文件类型**\n\n \n \n Qiniu_RS_BatchItemRet *itemRets;\n Qiniu_Client client;\n int i;\n char *key=\"qiniu.mp4\";\n Qiniu_ItemCount entryCount = 10;\n Qiniu_RS_EntryChangeMime *entries = (Qiniu_RS_EntryChangeMime *) malloc(\n sizeof(Qiniu_RS_EntryChangeMime) * entryCount);\n for (i = 0; i < entryCount; i++) {\n Qiniu_RS_EntryChangeMime entry;\n entry.bucket = bucket;\n \n size_t indexLen = snprintf(NULL, 0, \"%d\", i) + 1;\n char *indexStr = (char *) calloc(sizeof(char), indexLen);\n snprintf(indexStr, indexLen, \"%d\", i);\n entry.key = Qiniu_String_Concat2(key, indexStr);\n Qiniu_Free(indexStr);\n entry.mime = \"image/x-png\";\n entries[i] = entry;\n }\n \n itemRets = (Qiniu_RS_BatchItemRet *) malloc(sizeof(Qiniu_RS_BatchItemRet) * entryCount);\n \n //init\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_BatchChangeMime(&client, itemRets, entries, entryCount);\n if (error.code / 100 != 2) {\n printf(\"batch change file mime error.\\n\");\n debug_log(&client, error);\n } else {\n /*200, 正确返回了, 你可以通过itemRets变量查询一些关于这个文件的信息*/\n printf(\"batch change file mime success.\\n\\n\");\n \n for (i = 0; i < entryCount; i++) {\n int code = itemRets[i].code;\n if (code == 200) {\n printf(\"success: %d\\n\", code);\n } else {\n printf(\"code: %d, error: %s\\n\", code, itemRets[i].error);\n }\n }\n }\n Qiniu_Client_Cleanup(&client);\n \n\n### **批量删除文件**\n\n \n \n Qiniu_RS_BatchItemRet *itemRets;\n Qiniu_Client client;\n int i;\n char *key = \"qiniu.png\";\n char *bucket=\"if-pbl\";\n \n Qiniu_ItemCount entryCount = 10;\n Qiniu_RS_EntryPath *entries = (Qiniu_RS_EntryPath *) malloc(sizeof(Qiniu_RS_EntryPath) * entryCount);\n for (i = 0; i < entryCount; i++) {\n Qiniu_RS_EntryPath entry;\n entry.bucket = bucket;\n \n size_t indexLen = snprintf(NULL, 0, \"%d\", i) + 1;\n char *indexStr = (char *) calloc(sizeof(char), indexLen);\n snprintf(indexStr, indexLen, \"%d\", i);\n entry.key = Qiniu_String_Concat2(key, indexStr);\n entries[i] = entry;\n }\n \n itemRets = (Qiniu_RS_BatchItemRet *) malloc(sizeof(Qiniu_RS_BatchItemRet) * entryCount);\n \n //init\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_BatchDelete(&client, itemRets, entries, entryCount);\n if (error.code / 100 != 2) {\n printf(\"batch delete file error.\\n\");\n debug_log(&client, error);\n } else {\n printf(\"batch delete file success.\\n\\n\");\n \n for (i = 0; i < entryCount; i++) {\n int code = itemRets[i].code;\n if (code == 200) {\n printf(\"success: %d\\n\", code);\n } else {\n printf(\"code: %d, error: %s\\n\", code, itemRets[i].error);\n }\n }\n }\n Qiniu_Client_Cleanup(&client);\n \n\n### **批量复制文件**\n\n \n \n Qiniu_RS_BatchItemRet *itemRets;\n Qiniu_Client client;\n int i;\n \n char *key = \"qiniu.png\";\n char *bucket=\"if-pbl\";\n \n Qiniu_ItemCount entryCount = 10;\n Qiniu_RS_EntryPathPair *entryPairs = (Qiniu_RS_EntryPathPair *) malloc(sizeof(Qiniu_RS_EntryPathPair) * entryCount);\n for (i = 0; i < entryCount; i++) {\n //src\n Qiniu_RS_EntryPath srcEntry;\n srcEntry.bucket = bucket;\n srcEntry.key = key;\n \n //dest\n Qiniu_RS_EntryPath destEntry;\n destEntry.bucket = bucket;\n size_t indexLen = snprintf(NULL, 0, \"%d\", i) + 1;\n char *indexStr = (char *) calloc(sizeof(char), indexLen);\n snprintf(indexStr, indexLen, \"%d\", i);\n destEntry.key = Qiniu_String_Concat2(key, indexStr);\n Qiniu_Free(indexStr);\n \n //pack\n Qiniu_RS_EntryPathPair entryPair;\n entryPair.src = srcEntry;\n entryPair.dest = destEntry;\n entryPair.force = Qiniu_True;\n entryPairs[i] = entryPair;\n }\n \n itemRets = (Qiniu_RS_BatchItemRet *) malloc(sizeof(Qiniu_RS_BatchItemRet) * entryCount);\n \n //init\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_BatchCopy(&client, itemRets, entryPairs, entryCount);\n if (error.code / 100 != 2) {\n printf(\"batch copy file error.\\n\");\n debug_log(&client, error);\n } else {\n printf(\"batch copy file success.\\n\\n\");\n \n for (i = 0; i < entryCount; i++) {\n int code = itemRets[i].code;\n if (code == 200) {\n printf(\"success: %d\\n\", code);\n } else {\n printf(\"code: %d, error: %s\\n\", code, itemRets[i].error);\n }\n }\n }\n Qiniu_Client_Cleanup(&client);\n \n\n### **批量移动或重命名文件**\n\n \n \n Qiniu_RS_BatchItemRet *itemRets;\n Qiniu_Client client;\n int i;\n \n char *bucket=\"if-pbl\";\n char *key = \"qiniu.png\";\n \n Qiniu_ItemCount entryCount = 10;\n Qiniu_RS_EntryPathPair *entryPairs = (Qiniu_RS_EntryPathPair *) malloc(sizeof(Qiniu_RS_EntryPathPair) * entryCount);\n for (i = 0; i < entryCount; i++) {\n \n size_t indexLen = snprintf(NULL, 0, \"%d\", i) + 1;\n char *indexStr = (char *) calloc(sizeof(char), indexLen);\n snprintf(indexStr, indexLen, \"%d\", i);\n \n //src\n Qiniu_RS_EntryPath srcEntry;\n srcEntry.bucket = bucket;\n srcEntry.key = Qiniu_String_Concat2(key, indexStr);\n \n //dest\n Qiniu_RS_EntryPath destEntry;\n destEntry.bucket = bucket;\n destEntry.key = Qiniu_String_Concat3(key, indexStr, \"-move\");\n \n Qiniu_Free(indexStr);\n \n //pack\n Qiniu_RS_EntryPathPair entryPair;\n entryPair.src = srcEntry;\n entryPair.dest = destEntry;\n entryPair.force = Qiniu_True;\n entryPairs[i] = entryPair;\n }\n \n itemRets = (Qiniu_RS_BatchItemRet *) malloc(sizeof(Qiniu_RS_BatchItemRet) * entryCount);\n \n //init\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_BatchMove(&client, itemRets, entryPairs, entryCount);\n if (error.code / 100 != 2) {\n printf(\"batch move file error.\\n\");\n debug_log(&client, error);\n } else {\n printf(\"batch move file success.\\n\\n\");\n \n for (i = 0; i < entryCount; i++) {\n int code = itemRets[i].code;\n if (code == 200) {\n printf(\"success: %d\\n\", code);\n } else {\n printf(\"code: %d, error: %s\\n\", code, itemRets[i].error);\n }\n }\n }\n Qiniu_Client_Cleanup(&client);\n \n\n### **批量更新文件的有效期**\n\n \n \n Qiniu_RS_BatchItemRet *itemRets;\n Qiniu_Client client;\n int i;\n \n char *bucket=\"if-pbl\";\n char *key = \"qiniu.png\";\n \n Qiniu_ItemCount entryCount = 10;\n Qiniu_RS_EntryDeleteAfterDays *entries = (Qiniu_RS_EntryDeleteAfterDays *) malloc(\n sizeof(Qiniu_RS_EntryDeleteAfterDays) * entryCount);\n for (i = 0; i < entryCount; i++) {\n Qiniu_RS_EntryDeleteAfterDays entry;\n entry.bucket = bucket;\n \n size_t indexLen = snprintf(NULL, 0, \"%d\", i) + 1;\n char *indexStr = (char *) calloc(sizeof(char), indexLen);\n snprintf(indexStr, indexLen, \"%d\", i);\n entry.key = Qiniu_String_Concat2(key, indexStr);\n Qiniu_Free(indexStr);\n entry.days = 7;//设置7天有效期\n entries[i] = entry;\n }\n \n itemRets = (Qiniu_RS_BatchItemRet *) malloc(sizeof(Qiniu_RS_BatchItemRet) * entryCount);\n \n //init\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_BatchDeleteAfterDays(&client, itemRets, entries, entryCount);\n if (error.code / 100 != 2) {\n printf(\"batch deleteAfterDays file error.\\n\");\n debug_log(&client, error);\n } else {\n /*200, 正确返回了, 你可以通过itemRets变量查询一些关于这个文件的信息*/\n printf(\"batch deleteAfterDays file success.\\n\\n\");\n \n for (i = 0; i < entryCount; i++) {\n int code = itemRets[i].code;\n if (code == 200) {\n printf(\"success: %d\\n\", code);\n } else {\n printf(\"code: %d, error: %s\\n\", code, itemRets[i].error);\n }\n }\n }\n Qiniu_Client_Cleanup(&client);\n \n\n### **批量更新文件存储类型**\n\n \n \n Qiniu_RS_BatchItemRet *itemRets;\n Qiniu_Client client;\n int i;\n char *key = \"qiniu.png\";\n char *bucket=\"if-pbl\";\n \n Qiniu_ItemCount entryCount = 10;\n Qiniu_RS_EntryChangeType *entries = (Qiniu_RS_EntryChangeType *) malloc(\n sizeof(Qiniu_RS_EntryChangeType) * entryCount);\n for (i = 0; i < entryCount; i++) {\n Qiniu_RS_EntryChangeType entry;\n entry.bucket = bucket;\n \n size_t indexLen = snprintf(NULL, 0, \"%d\", i) + 1;\n char *indexStr = (char *) calloc(sizeof(char), indexLen);\n snprintf(indexStr, indexLen, \"%d\", i);\n entry.key = Qiniu_String_Concat2(key, indexStr);\n Qiniu_Free(indexStr);\n entry.fileType = 1;//改为低频存储\n entries[i] = entry;\n }\n \n itemRets = (Qiniu_RS_BatchItemRet *) malloc(sizeof(Qiniu_RS_BatchItemRet) * entryCount);\n \n //init\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n Qiniu_Error error = Qiniu_RS_BatchChangeType(&client, itemRets, entries, entryCount);\n if (error.code / 100 != 2) {\n printf(\"batch change file type error.\\n\");\n debug_log(&client, error);\n } else {\n /*200, 正确返回了, 你可以通过itemRets变量查询一些关于这个文件的信息*/\n printf(\"batch change file type success.\\n\\n\");\n \n for (i = 0; i < entryCount; i++) {\n int code = itemRets[i].code;\n if (code == 200) {\n printf(\"success: %d\\n\", code);\n } else {\n printf(\"code: %d, error: %s\\n\", code, itemRets[i].error);\n }\n }\n }\n Qiniu_Client_Cleanup(&client);\n \n\n# 持久化数据处理\n\n## 发送数据处理请求\n\n对于已经保存到七牛空间的文件，可以通过发送持久化的数据处理指令来进行处理，这些指令支持七牛官方提供的指令，也包括客户自己开发的自定义数据处理的指令。数据处理的结果还可以通过七牛主动通知的方式告知业务服务器。\n\n \n \n char *bucket=\"if-pbl\";\n char *key = \"qiniu.mp4\";\n char *pipeline = \"sdktest\";\n char *notifyURL = NULL;\n int force = 0;\n //init\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n Qiniu_Client_EnableAutoQuery(&client, Qiniu_True); /* 启用区域自动查询，无需手动设置区域 */\n \n char *saveMp4Entry = Qiniu_String_Concat3(bucket, \":\", \"avthumb_test_target.mp4\");\n char *saveMp4EntryEncoded = Qiniu_String_Encode(saveMp4Entry);\n Qiniu_Free(saveMp4Entry);\n \n char *saveJpgEntry = Qiniu_String_Concat3(bucket, \":\", \"vframe_test_target.jpg\");\n char *saveJpgEntryEncoded = Qiniu_String_Encode(saveJpgEntry);\n Qiniu_Free(saveJpgEntry);\n \n char *avthumbMp4Fop = Qiniu_String_Concat2(\"avthumb/mp4|saveas/\", saveMp4EntryEncoded);\n char *vframeJpgFop = Qiniu_String_Concat2(\"vframe/jpg/offset/1|saveas/\", saveJpgEntryEncoded);\n \n Qiniu_Free(saveMp4EntryEncoded);\n Qiniu_Free(saveJpgEntryEncoded);\n \n char *fops[] = {avthumbMp4Fop, vframeJpgFop};\n \n Qiniu_Error error = Qiniu_FOP_Pfop(&client, &pfopRet, bucket, key, fops, 2, pipeline, notifyURL, force);\n if (error.code != 200) {\n printf(\"video file pfop %s:%s error.\\n\", bucket, key);\n debug_log(&client, error);\n } else {\n /*200, 正确返回了, 你可以通过pfopRet变量查询任务ID*/\n printf(\"video file pfop %s:%s success, persistentId: %s .\\n\\n\", bucket, key, pfopRet.persistentId);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n# CDN相关功能\n\n * 文件刷新\n * 目录刷新\n * 文件预取操作\n * 获取域名流量\n * 获取域名带宽\n * 获取日志下载链接\n * 构建时间戳防盗链访问链接\n\nCDN的主要函数主要可以在cdn.h中看到，下面列举了主要的功能。\n\n## 文件刷新\n\n \n \n Qiniu_CDN_RefreshRet ret;\n Qiniu_Error error;\n char **p;\n int i;\n \n //刷新链接，单次请求链接不可以超过100个，如果超过，请分批发送请求\n //urls to refresh\n char *urls[] = {\n \"http://csdk.qiniudn.com/qiniu1.png\",\n \"http://csdk.qiniudn.com/qiniu2.png\",\n \"http://csdk.qiniudn.com/qiniu3.png\"\n };\n \n //init\n Qiniu_Zero(ret);\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n error = Qiniu_CDN_RefreshUrls(&client, &ret, urls, 3);\n if (error.code != 200) {\n printf(\"refresh urls error.\\n\");\n debug_log(&client, error);\n } else {\n printf(\"refresh urls success.\\n\");\n printf(\"Code: %d\\n\", ret.code);\n printf(\"Error: %s\\n\", ret.error);\n printf(\"RequestId: %s\\n\", ret.requestId);\n \n p = ret.invalidUrls;\n for (i = 0; i < ret.invalidUrlsCount; i++) {\n printf(\"InvalidUrl: %s\\n\", *p);\n ++p;\n }\n \n p = ret.invalidDirs;\n for (i = 0; i < ret.invalidDirsCount; i++) {\n printf(\"InvalidDir: %s\\n\", *p);\n ++p;\n }\n \n printf(\"UrlQuotaDay: %d\\n\", ret.urlQuotaDay);\n printf(\"UrlSurplusDay: %d\\n\", ret.urlSurplusDay);\n printf(\"DirQuotaDay: %d\\n\", ret.dirQuotaDay);\n printf(\"DirSurplusDay: %d\\n\", ret.dirSurplusDay);\n \n Qiniu_Free_CDNRefreshRet(&ret);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 目录刷新\n\n \n \n Qiniu_CDN_RefreshRet ret;\n Qiniu_Error error;\n char **p;\n int i;\n //刷新目录，刷新目录需要联系七牛技术支持开通权限\n //单次请求链接不可以超过10个，如果超过，请分批发送请求\n char *dirs[] = {\n \"http://csdk.qiniudn.com/image1/\",\n \"http://csdk.qiniudn.com/image2/\",\n \"http://csdk.qiniudn.com/image3/\"\n };\n \n //init\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n error = Qiniu_CDN_RefreshDirs(&client, &ret, dirs, 3);\n if (error.code != 200) {\n printf(\"refresh dirs error.\\n\");\n debug_log(&client, error);\n } else {\n printf(\"refresh dirs success.\\n\");\n printf(\"Code: %d\\n\", ret.code);\n printf(\"Error: %s\\n\", ret.error);\n printf(\"RequestId: %s\\n\", ret.requestId);\n \n p = ret.invalidUrls;\n for (i = 0; i < ret.invalidUrlsCount; i++) {\n printf(\"InvalidUrl: %s\\n\", *p);\n ++p;\n }\n \n p = ret.invalidDirs;\n for (i = 0; i < ret.invalidDirsCount; i++) {\n printf(\"InvalidDir: %s\\n\", *p);\n ++p;\n }\n \n printf(\"UrlQuotaDay: %d\\n\", ret.urlQuotaDay);\n printf(\"UrlSurplusDay: %d\\n\", ret.urlSurplusDay);\n printf(\"DirQuotaDay: %d\\n\", ret.dirQuotaDay);\n printf(\"DirSurplusDay: %d\\n\", ret.dirSurplusDay);\n \n Qiniu_Free_CDNRefreshRet(&ret);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 文件预取\n\n \n \n Qiniu_CDN_PrefetchRet ret;\n Qiniu_Error error;\n char **p;\n int i;\n //预取链接，单次请求链接不可以超过100个，如果超过，请分批发送请求\n //urls to refresh\n char *urls[] = {\n \"http://csdk.qiniudn.com/qiniu1.png\",\n \"http://csdk.qiniudn.com/qiniu2.png\",\n \"http://csdk.qiniudn.com/qiniu3.png\"\n };\n //init\n Qiniu_Zero(ret);\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n error = Qiniu_CDN_PrefetchUrls(&client, &ret, urls, 3);\n if (error.code != 200) {\n printf(\"prefetch urls error.\\n\");\n debug_log(&client, error);\n } else {\n printf(\"prefetch urls success.\\n\");\n printf(\"Code: %d\\n\", ret.code);\n printf(\"Error: %s\\n\", ret.error);\n printf(\"RequestId: %s\\n\", ret.requestId);\n \n p = ret.invalidUrls;\n for (i = 0; i < ret.invalidUrlsCount; i++) {\n printf(\"InvalidUrl: %s\\n\", *p);\n ++p;\n }\n printf(\"QuotaDay: %d\\n\", ret.quotaDay);\n printf(\"SurplusDay: %d\\n\", ret.surplusDay);\n Qiniu_Free_CDNPrefetchRet(&ret);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 获取域名流量\n\n \n \n Qiniu_CDN_FluxRet ret;\n Qiniu_Error error;\n int i, j;\n //urls to refresh\n char *domains[] = {\n \"csdk.qiniudn.com\",\n \"javasdk.qiniudn.com\"\n };\n int domainsCount = 2;\n char *startDate = \"2017-08-01\";\n char *endDate = \"2017-08-09\";\n char *g = \"day\";\n \n //init\n Qiniu_Zero(ret);\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n error = Qiniu_CDN_GetFluxData(&client, &ret, startDate, endDate, g, domains, domainsCount);\n if (error.code != 200) {\n printf(\"get domain flux error.\\n\");\n debug_log(&client, error);\n } else {\n printf(\"get domain flux success.\\n\\n\");\n printf(\"Code: %d\\n\", ret.code);\n printf(\"Error: %s\\n\", ret.error);\n printf(\"Domains: %d\\n\", ret.domainsCount);\n \n printf(\"-----------\\n\");\n \n for (i = 0; i < ret.timeCount; i++) {\n printf(\"%s\\t\", ret.time[i]);\n }\n printf(\"\\n\");\n \n //data\n for (i = 0; i < ret.domainsCount; i++) {\n printf(\"Domain:%s\\n\", domains[i]);\n Qiniu_CDN_FluxData fluxData = ret.data[i];\n if (fluxData.chinaCount == 0) {\n printf(\"China: no flux data\\n\");\n } else {\n printf(\"China: flux data\\n\");\n for (j = 0; j < fluxData.chinaCount; j++) {\n printf(\"%lld\\t\", fluxData.china[j]);\n }\n printf(\"\\n\");\n }\n \n if (fluxData.overseaCount == 0) {\n printf(\"Oversea: no flux data\\n\");\n } else {\n printf(\"Oversea: flux data\\n\");\n for (j = 0; j < fluxData.overseaCount; j++) {\n printf(\"%lld\\t\", fluxData.oversea[j]);\n }\n printf(\"\\n\");\n }\n printf(\"-----------\\n\");\n }\n \n \n Qiniu_Free_CDNFluxRet(&ret);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 获取域名带宽\n\n \n \n Qiniu_CDN_BandwidthRet ret;\n Qiniu_Error error;\n int i, j;\n \n //urls to refresh\n char *domains[] = {\n \"csdk.qiniudn.com\",\n \"javasdk.qiniudn.com\"\n };\n int domainsCount = 2;\n char *startDate = \"2017-08-01\";\n char *endDate = \"2017-08-09\";\n char *g = \"day\";\n \n //init\n Qiniu_Zero(ret);\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n error = Qiniu_CDN_GetBandwidthData(&client, &ret, startDate, endDate, g, domains, domainsCount);\n if (error.code != 200) {\n printf(\"get domain bandwidth error.\\n\");\n debug_log(&client, error);\n } else {\n printf(\"get domain bandwidth success.\\n\\n\");\n printf(\"Code: %d\\n\", ret.code);\n printf(\"Error: %s\\n\", ret.error);\n printf(\"Domains: %d\\n\", ret.domainsCount);\n \n printf(\"-----------\\n\");\n \n for (i = 0; i < ret.timeCount; i++) {\n printf(\"%s\\t\", ret.time[i]);\n }\n printf(\"\\n\");\n \n //data\n for (i = 0; i < ret.domainsCount; i++) {\n printf(\"Domain:%s\\n\", domains[i]);\n Qiniu_CDN_BandwidthData bandData = ret.data[i];\n if (bandData.chinaCount == 0) {\n printf(\"China: no bandwidth data\\n\");\n } else {\n printf(\"China: bandwidth data\\n\");\n for (j = 0; j < bandData.chinaCount; j++) {\n printf(\"%lld\\t\", bandData.china[j]);\n }\n printf(\"\\n\");\n }\n \n if (bandData.overseaCount == 0) {\n printf(\"Oversea: no bandwidth data\\n\");\n } else {\n printf(\"Oversea: bandwidth data\\n\");\n for (j = 0; j < bandData.overseaCount; j++) {\n printf(\"%lld\\t\", bandData.oversea[j]);\n }\n printf(\"\\n\");\n }\n printf(\"-----------\\n\");\n }\n \n \n Qiniu_Free_CDNBandwidthRet(&ret);\n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 获取日志下载链接\n\n \n \n Qiniu_CDN_LogListRet ret;\n Qiniu_Error error;\n int i, j;\n //urls to refresh\n char *domains[] = {\n \"csdk.qiniudn.com\",\n \"javasdk.qiniudn.com\"\n };\n int domainsCount = 2;\n char *day = \"2017-08-07\";\n \n //init\n Qiniu_Zero(ret);\n Qiniu_Client_InitMacAuth(&client, 1024, &mac);\n error = Qiniu_CDN_GetLogList(&client, &ret, domains, domainsCount,day);\n if (error.code != 200) {\n printf(\"get domain logs error.\\n\");\n debug_log(&client, error);\n } else {\n printf(\"get domain logs success.\\n\\n\");\n printf(\"Code: %d\\n\", ret.code);\n printf(\"Error: %s\\n\", ret.error);\n printf(\"Domains: %d\\n\", ret.domainsCount);\n \n printf(\"-----------\\n\");\n \n //data\n for (i = 0; i < ret.domainsCount; i++) {\n Qiniu_CDN_LogListData logData = ret.data[i];\n if (logData.itemsCount == 0) {\n printf(\"domain: %s, no log data\\n\", logData.domain);\n printf(\"-----------\\n\");\n } else {\n printf(\"domain: %s have %d log files\\n\", logData.domain, logData.itemsCount);\n for (j = 0; j < logData.itemsCount; j++) {\n printf(\"name: %s\\n\", logData.items[j].name);\n }\n printf(\"-----------\\n\");\n }\n }\n \n Qiniu_Free_CDNLogListRet(&ret);\n \n }\n Qiniu_Client_Cleanup(&client);\n \n\n## 构建时间戳防盗链访问链接\n\n具体算法可以参考：[时间戳防盗链](https://developer.qiniu.com/fusion/kb/timestamp-hotlinking-\nprevention)\n\n \n \n #include \"../qiniu/cdn.h\"\n #include \"../qiniu/tm.h\"\n #include <stdio.h>\n \n int main(int argc, char *argv[]) {\n char *host = \"http://v1.cdn.example.com\";\n char *fileName = \"video/caipu/201708/0600/s/5985f37b37025.mp4/eGgxMDgwcA.m3u8\";\n char *cryptKey = \"xxx\";\n char *queryStr = \"name=七牛&age=27\";\n \n char *finalUrl;\n Qiniu_Uint64 deadline = Qiniu_Tm_LocalTime() + 3600;\n \n finalUrl = Qiniu_CDN_CreateTimestampAntiLeechURL(host, fileName, queryStr, deadline, cryptKey);\n printf(\"%s\\n\", finalUrl);\n Qiniu_Free(finalUrl);\n }\n \n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n * [融合CDN API 参考](https://developer.qiniu.com/fusion)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n\n# 常见问题\n\n * API 的使用，可以参考我们为大家精心准备的[使用实例 __](https://github.com/qiniu/c-sdk/tree/master/examples)。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](https://support.qiniu.com/tickets/new)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储C# SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > C# SDK\n\n# C# SDK\n\n最近更新时间: 2024-01-02 10:54:48\n\n### C# SDK 使用指南\n\n[NuGet release __](https://www.nuget.org/packages/Qiniu)\n\n此 C# SDK 基于 .Net Standard 2.0，适用于 .NET Core 2.0 和 .NET Framework v4.6.1，详情\n[查看官网 __](https://docs.microsoft.com/en-us/dotnet/standard/net-standard)。 基于\n七牛云 API 参考手册构建。使用此 SDK\n构建您的网络应用程序，能让您以非常便捷地方式将数据安全地存储到七牛云上。无论您的网络应用是一个网站程序，还是包括从云端（服务端程序）到终端（手持设备应用）的架构的服务或应用，通过七牛云存储及其\nSDK，都能让您应用程序的终端用户高速上传和下载，同时也让您的服务端更加轻盈。\n\nC# SDK 属于服务端SDK之一，主要有如下功能：\n\n 1. 提供生成客户端上传所需的上传凭证的功能\n 2. 提供文件从服务端直接上七牛的功能\n 3. 提供对七牛空间中文件进行管理的功能\n 4. 提供对七牛空间中文件进行处理的功能\n 5. 提供七牛CDN相关的刷新，预取，日志功能\n\n# 开源\n\n * [c# SDK 项目地址 __](https://github.com/qiniu/csharp-sdk)\n * [c# SDK 发布地址 __](https://github.com/qiniu/csharp-sdk/releases)\n * [c# SDK 历史文档 __](https://developer.qiniu.io/kodo/sdk/1237/csharp)\n\n# 安装\n\n * 包管理器(NuGet)方式安装\n * 从源码编译\n\n**包管理器(NuGet)方式安装**\n\n从NuGet来安装，以Visual Studio 2013/2015为例(如果您的Visual Studio没有安装NuGet，请先[安装\n__](http://docs.nuget.org/docs/start-here/installing-\nnuget))。打开NuGet程序包管理器搜索Qiniu或者在控制台中键入以下命令：\n\n \n \n Install-Package Qiniu\n \n\n \n**从源码编译**\n\n当然，您也可以直接从源码编译\n\n \n \n git clone https://github.com/qiniu/csharp-sdk\n \n\n# 鉴权\n\nc# SDK 的所有的功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的`Access Key`和`Secret\nKey`，这对密钥可以通过如下步骤获得：\n\n 1. 点击[注册🔗 __](https://portal.qiniu.com/signup)开通 七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里🔗 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n# 文件上传\n\n * 上传流程\n * 客户端上传凭证\n * 简单上传凭证\n * 覆盖上传凭证\n * 自定义上传回复凭证\n * 带回调业务服务器的凭证\n * 带数据处理的凭证\n * 带自定义参数的凭证\n * 综合上传凭证\n * 服务器直传\n * 构建配置类\n * 文件上传（表单方式）\n * 字节数组上传（表单方式）\n * 数据流上传（表单方式）\n * 文件分片上传（断点续传）\n * 解析自定义回复内容\n * 业务服务器验证存储服务回调\n\n### 上传流程\n\n文件上传分为客户端上传（主要是指网页端和移动端等面向终端用户的场景）和服务端上传两种场景，具体可以参考文档[业务流程](https://developer.qiniu.com/kodo/manual/1205/programming-\nmodel)。\n\n服务端SDK在上传方面主要提供两种功能，一种是生成客户端上传所需要的上传凭证，另外一种是直接上传文件到云端。\n\n### 客户端上传凭证\n\n客户端（移动端或者Web端）上传文件的时候，需要从客户自己的业务服务器获取上传凭证，而这些上传凭证是通过服务端的SDK来生成的，然后通过客户自己的业务API分发给客户端使用。根据上传的业务需求不同，c#\nSDK支持丰富的上传凭证生成方式。\n\n创建各种上传凭证之前，我们需要定义好其中鉴权对象`mac`：\n\n \n \n Mac mac = new Mac(AccessKey, SecretKey);\n \n\n#### 简单上传的凭证\n\n最简单的上传凭证只需要`AccessKey`，`SecretKey`和`Bucket`就可以。\n\n \n \n PutPolicy putPolicy = new PutPolicy();\n putPolicy.Scope = Bucket;\n string token = Auth.CreateUploadToken(mac, putPolicy.ToJsonString());\n \n\n默认情况下，在不指定上传凭证的有效时间情况下，默认有效期为1个小时。也可以自行指定上传凭证的有效期，例如：\n\n \n \n //自定义凭证有效期（示例2小时，expires单位为秒，为上传凭证的有效时间）\n PutPolicy putPolicy = new PutPolicy();\n putPolicy.Scope = Bucket;\n putPolicy.SetExpires(7200);\n string token = Auth.CreateUploadToken(mac, putPolicy.ToJsonString());\n \n\n#### 覆盖上传的凭证\n\n覆盖上传除了需要`简单上传`所需要的信息之外，还需要想进行覆盖的文件名称，这个文件名称同时可是客户端上传代码中指定的文件名，两者必须一致。\n\n \n \n PutPolicy putPolicy = new PutPolicy();\n putPolicy.Scope = Bucket + \":\" + Key;\n putPolicy.SetExpires(7200);\n string token = Auth.CreateUploadToken(mac, putPolicy.ToJsonString());\n \n\n#### 自定义上传回复的凭证\n\n默认情况下，文件上传到存储之后，在没有设置`returnBody`或者`回调`相关的参数情况下，存储返回给上传端的回复格式为`hash`和`key`，例如：\n\n \n \n {\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"key\":\"qiniu.jpg\"}\n \n\n有时候我们希望能自定义这个返回的JSON格式的内容，可以通过设置`returnBody`参数来实现，在`returnBody`中，我们可以使用七牛支持的[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)和[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)。\n\n \n \n PutPolicy putPolicy = new PutPolicy();\n putPolicy.Scope = Bucket + \":\" + Key;\n putPolicy.ReturnBody = \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"fsiz\\\":$(fsize),\\\"bucket\\\":\\\"$(bucket)\\\",\\\"name\\\":\\\"$(x:name)\\\"}\";\n string token = Auth.CreateUploadToken(mac, putPolicy.ToJsonString());\n \n\n则文件上传到存储之后，收到的回复内容如下：\n\n \n \n {\"key\":\"qiniu.jpg\",\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"bucket\":\"if-bc\",\"fsize\":39335,\"name\":\"qiniu\"}\n \n\n#### 带回调业务服务器的凭证\n\n上面生成的`自定义上传回复`的上传凭证适用于上传端（无论是客户端还是服务端）和存储服务器之间进行直接交互的情况下。在客户端上传的场景之下，有时候客户端需要在文件上传到存储之后，从业务服务器获取相关的信息，这个时候就要用到存储的上传回调及相关回调参数的设置。\n\n \n \n putPolicy = new PutPolicy();\n putPolicy.Scope = Bucket;\n putPolicy.CallbackUrl = \"http://api.example.com/qiniu/upload/callback\";\n putPolicy.CallbackBody = \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"fsiz\\\":$(fsize),\\\"bucket\\\":\\\"$(bucket)\\\",\\\"name\\\":\\\"$(x:name)\\\"}\";\n putPolicy.CallbackBodyType = \"application/json\";\n upToken = Auth.CreateUploadToken(mac, putPolicy.ToJsonString());\n Console.WriteLine(upToken);\n \n\n在使用了上传回调的情况下，客户端收到的回复就是业务服务器响应七牛的JSON格式内容。 \n通常情况下，我们建议使用`application/json`格式来设置`callbackBody`，保持数据格式的统一性。实际情况下，`callbackBody`也支持`application/x-www-\nform-urlencoded`格式来组织内容，这个主要看业务服务器在接收到`callbackBody`的内容时如果解析。例如：\n\n \n \n putPolicy = new PutPolicy();\n putPolicy.Scope = Bucket;\n putPolicy.CallbackUrl = \"http://api.example.com/qiniu/upload/callback\";\n putPolicy.CallbackBody = \"key=$(key)&hash=$(etag)&bucket=$(bucket)&fsize=$(fsize)&name=$(x:name)\";\n upToken = Auth.CreateUploadToken(mac, putPolicy.ToJsonString());\n Console.WriteLine(upToken);\n \n\n#### 带数据处理的凭证\n\n七牛支持在文件上传到七牛之后，立即对其进行多种指令的数据处理，这个只需要在生成的上传凭证中指定相关的处理参数即可。\n\n \n \n putPolicy = new PutPolicy();\n string saveMp4Entry = Base64.UrlSafeBase64Encode(Bucket + \":avthumb_test_target.mp4\");\n string saveJpgEntry = Base64.UrlSafeBase64Encode(Bucket + \":vframe_test_target.jpg\");\n string avthumbMp4Fop = \"avthumb/mp4|saveas/\" + saveMp4Entry;\n string vframeJpgFop = \"vframe/jpg/offset/1|saveas/\" + saveJpgEntry;\n string fops = string.Join(\";\", new string[] { avthumbMp4Fop, vframeJpgFop });\n putPolicy.Scope = Bucket;\n putPolicy.PersistentOps = fops;\n putPolicy.PersistentPipeline = \"video-pipe\";\n putPolicy.PersistentNotifyUrl = \"http://api.example.com/qiniu/pfop/notify\";\n upToken = Auth.CreateUploadToken(mac, putPolicy.ToJsonString());\n Console.WriteLine(upToken);\n \n\n队列 pipeline 请参阅[创建私有队列 __](https://portal.qiniu.com/dora/media-\ngate/pipeline)；转码操作具体参数请参阅[音视频转码](https://developer.qiniu.com/dora/api/audio-\nand-video-transcoding-avthumb)；saveas\n请参阅[处理结果另存](https://developer.qiniu.com/dora/api/processing-results-save-\nsaveas)。\n\n#### 带自定义参数的凭证\n\n存储支持客户端上传文件的时候定义一些自定义参数，这些参数可以在`returnBody`和`callbackBody`里面和七牛内置支持的魔法变量（即系统变量）通过相同的方式来引用。这些自定义的参数名称必须以`x:`开头。例如客户端上传的时候指定了自定义的参数`x:name`和`x:age`分别是`string`和`int`类型。那么可以通过下面的方式引用：\n\n \n \n putPolicy.ReturnBody = \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"fsiz\\\":$(fsize),\\\"bucket\\\":\\\"$(bucket)\\\",\\\"name\\\":\\\"$(x:name)\\\"}\";\n \n\n或者\n\n \n \n putPolicy.CallbackBody = \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"fsiz\\\":$(fsize),\\\"bucket\\\":\\\"$(bucket)\\\",\\\"name\\\":\\\"$(x:name)\\\"}\";\n \n\n#### 综合上传凭证\n\n上面的生成上传凭证的方法，都是通过设置[上传策略🔗](https://developer.qiniu.com/kodo/manual/1206/put-\npolicy)相关的参数来支持的，这些参数可以通过不同的组合方式来满足不同的业务需求，可以灵活地组织你所需要的上传凭证。\n\n### 服务端直传\n\n服务端直传是指客户利用七牛服务端SDK从服务端直接上传文件到存锤，交互的双方一般都在机房里面，所以服务端可以自己生成上传凭证，然后利用SDK中的上传逻辑进行上传，最后从七牛云获取上传的结果，这个过程中由于双方都是业务服务器，所以很少利用到上传回调的功能，而是直接自定义`returnBody`来获取自定义的回复内容。\n\n#### 构建配置类\n\n存储支持空间创建在不同的机房，在使用七牛的 C# SDK\n中的`FormUploader`和`ResumeUploader`上传文件之前，必须要构建一个上传用的`config`对象，在该对象中，可以指定空间对应的`zone`以及其他的一些影响上传的参数。\n\n \n \n Config config = new Config();\n // 空间对应的机房\n config.Zone = Zone.ZONE_CN_East;\n // 是否使用https域名\n config.UseHttps = true;\n // 上传是否使用cdn加速\n config.UseCdnDomains = true;\n \n\n其中关于`Zone`对象和机房的关系如下：\n\n机 房 | Zone对象 \n---|--- \n华 东 | `ZONE_CN_East` \n华 北 | `ZONE_CN_North` \n华 南 | `ZONE_CN_South` \n北 美 | `ZONE_US_North` \n东南亚 | `ZONE_AS_Singapore` \n \n#### 文件上传（表单方式）\n\n最简单的就是上传本地文件，直接指定文件的完整路径即可上传。\n\n \n \n Mac mac = new Mac(AccessKey, SecretKey);\n // 上传文件名\n string key = \"key\";\n // 本地文件路径\n string filePath = \"D:\\\\tools\\\\putty.exe\";\n // 存储空间名\n string Bucket = \"7qiniu\";\n \n // 设置上传策略\n PutPolicy putPolicy = new PutPolicy();\n // 设置要上传的目标空间\n putPolicy.Scope = Bucket;\n // 上传策略的过期时间(单位:秒)\n putPolicy.SetExpires(3600);\n // 文件上传完毕后，在多少天后自动被删除\n putPolicy.DeleteAfterDays = 1;\n // 生成上传token\n string token = Auth.CreateUploadToken(mac, putPolicy.ToJsonString());\n \n Config config = new Config();\n // 设置上传区域\n config.Zone = Zone.ZONE_CN_East;\n // 设置 http 或者 https 上传\n config.UseHttps = true;\n config.UseCdnDomains = true;\n config.ChunkSize = ChunkUnit.U512K;\n // 表单上传\n FormUploader target = new FormUploader(config);\n HttpResult result = target.UploadFile(filePath, key, token, null);\n Console.WriteLine(\"form upload result: \" + result.ToString());\n \n\n#### 文件分片上传（断点续传）\n\n断点续传是在分片上传的基础上实现。SDK 内置两种上传方式：表单上传和分片上传。表单上传使用一个 HTTP POST\n请求完成文件的上传，因此比较适合较小的文件。相比而言，分片上传比较适合上传比较大的文件（例如数百 MB 或更大）。 \n若需深入了解上传方式之间的区别，请参阅上传类型中\n[表单上传](https://developer.qiniu.com/kodo/manual/1272/form-upload) 、[分片上传 v1\n版](https://developer.qiniu.com/kodo/manual/1650/chunked-upload) 和 [分片上传 v2\n版](https://developer.qiniu.com/kodo/6364/multipartupload-interface) 接口说明。 \n可以选择分片上传版本，推荐 extra.Version = “v2”，表示 分片上传 v2 版，默认分片上传 v1 版。\n\n \n \n Mac mac = new Mac(AccessKey, SecretKey);\n // 上传文件名\n string key = \"putty.exe\";\n // 本地文件路径\n string filePath = \"D:\\\\tools\\\\putty.exe\";\n // 空间名\n string Bucket = \"7qiniu\";\n // 设置上传策略\n PutPolicy putPolicy = new PutPolicy();\n putPolicy.Scope = Bucket + \":\" + key;\n putPolicy.SetExpires(3600);\n string token = Auth.CreateUploadToken(mac, putPolicy.ToJsonString());\n Config config = new Config();\n // 设置上传区域\n config.Zone = Zone.ZONE_CN_East;\n // 设置 http 或者 https 上传\n config.UseHttps = true;\n config.UseCdnDomains = true;\n config.ChunkSize = ChunkUnit.U512K;\n ResumableUploader target = new ResumableUploader(config);\n PutExtra extra = new PutExtra();\n //设置断点续传进度记录文件\n extra.ResumeRecordFile = ResumeHelper.GetDefaultRecordKey(filePath, key);\n Console.WriteLine(\"record file:\" + extra.ResumeRecordFile);\n extra.ResumeRecordFile = \"test.progress\";\n //指定分片上传版本，默认分片上传 v1\n extra.Version = \"v2\";\n // 分片上传 v2 指定 part 大小，默认大小为4MB 分片大小范围为1 MB - 1 GB\n extra.PartSize = 4 * 1024 * 1024;\n // 指定分片并发大小，默认为1 \n extra.BlockUploadThreads = 4;\n HttpResult result = target.UploadFile(filePath, key, token, extra);\n Console.WriteLine(\"resume upload: \" + result.ToString());\n \n\n### 解析自定义回复内容\n\n有些情况下，七牛返回给上传端的内容不是默认的`hash`和`key`形式，这种情况下，可能出现在自定义`returnBody`或者自定义了`callbackBody`的情况下，前者一般是服务端直传的场景，而后者则是接受上传回调的场景，这两种场景之下，都涉及到需要将自定义的回复进行内容解析，一般建议在交互过程中，都采用`JSON`的方式，这样处理起来方法比较一致，而且`JSON`的方法最通用，基本上了解回复结构就可以处理，这里不再赘述。\n\n### 业务服务器验证存储服务回调\n\n在上传策略里面设置了上传回调相关参数的时候，存储在文件上传到服务器之后，会主动地向`callbackUrl`发送POST请求的回调，回调的内容为`callbackBody`模版所定义的内容，如果这个模版里面引用了[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)或者[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)，那么这些变量会被自动填充对应的值，然后在发送给业务服务器。\n\n业务服务器在收到来自七牛的回调请求的时候，可以根据请求头部的`Authorization`字段来进行验证，查看该请求是否是来自七牛的未经篡改的请求,具体可以参考[回调鉴权](https://developer.qiniu.com/kodo/kb/1409/seven-\ncattle-callback-and-callback-authentication)。\n\n**注意** ：业务端服务器回调鉴权的Content-Type类型应该与上传策略中指定的callbackBodyType相同，默认为\napplication/x-www-form-urlencoded，当 Content-Type 为 application/x-www-form-\nurlencoded 时，签名内容必须包括请求内容。当 Content-Type 为 application/json 时，签名内容不包括请求内容。\n\n# 下载文件\n\n * 公开空间\n * 私有空间\n\n文件下载分为公开空间的文件下载和私有空间的文件下载。\n\n### 公开空间\n\n对于公开空间，其访问的链接主要是将空间绑定的域名（可以是存储空间的默认域名或者是绑定的自定义域名）拼接上空间里面的文件名即可访问，标准情况下需要在拼接链接之前，将文件名进行`urlencode`以兼容不同的字符。\n\n \n \n string domain = \"http://if-pbl.qiniudn.com\";\n string key = \"hello/world/七牛/test.png\";\n string publicUrl = DownloadManager.CreatePublishUrl(domain, key);\n Console.WriteLine(publicUrl);\n \n\n### 私有空间\n\n对于私有空间，首先需要按照公开空间的文件访问方式构建对应的公开空间访问链接，然后再对这个链接进行私有授权签名。\n\n \n \n Mac mac = new Mac(AccessKey, SecretKey);\n string domain = \"http://if-pri.qiniudn.com\";\n string key = \"hello/world/七牛/test.png\";\n string privateUrl = DownloadManager.CreatePrivateUrl(mac, domain, key, 3600);\n Console.WriteLine(privateUrl);\n \n\n# 资源管理\n\n资源管理包括的主要功能有：\n\n * 获取文件信息\n * 修改文件MimeType\n * 修改文件存储类型\n * 移动或重命名文件\n * 复制文件副本\n * 删除空间中的文件\n * 设置或更新文件生存时间\n * 获取指定前缀文件列表\n * 抓取网络资源到空间\n * 更新镜像存储空间中文件内容\n * 资源管理批量操作\n * 批量获取文件信息\n * 批量修改文件类型\n * 批量删除文件\n * 批量复制文件\n * 批量移动或重命名文件\n * 批量更新文件的有效期\n * 批量更新文件存储类型\n\n资源管理相关的操作首先要构建`BucketManager`对象：\n\n \n \n // 设置存储区域\n Config config = new Config();\n config.Zone = Zone.ZONE_CN_East;\n \n Mac mac = new Mac(AccessKey, SecretKey);\n BucketManager bucketManager = new BucketManager(mac, config);\n \n\n## 获取文件信息\n\n \n \n // 存储空间名\n string Bucket = \"7qiniu\";\n // \t待查询文件名\n string key = \"02.mp4\";\n \n StatResult statRet = bucketManager.Stat(Bucket, key);\n if (statRet.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(\"stat error: \" + statRet.ToString());\n }\n \n Console.WriteLine(statRet.Result.Hash);\n Console.WriteLine(statRet.Result.MimeType);\n Console.WriteLine(statRet.Result.Fsize);\n Console.WriteLine(statRet.Result.MimeType);\n Console.WriteLine(statRet.Result.FileType);\n \n\n## 修改文件MimeType\n\n \n \n string Bucket = \"7qiniu\";\n string key = \"7qiniu.mp4\";\n \n HttpResult ret = bucketManager.ChangeMime(Bucket, key, \"application / mpegurl\");\n if (ret.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(\"change mime error: \" + ret.ToString());\n Console.ReadKey();\n }\n Console.WriteLine(ret.ToString());\n \n\n## 修改文件存储类型\n\n \n \n // 存储空间\n string Bucket = \"7qiniu\";\n // 文件名\n string key = \"7qiniu.mp4\";\n // newType 为 0 表示普通存储，newType 为 1 表示低频存储，newType 为 2 表示归档存储，newType 为 3 表示深度归档存储，newType 为 4 表示归档直读存储\n int newType = 1;\n HttpResult ret = bucketManager.ChangeType(Bucket, key, newType);\n if (ret.Code != (int)HttpCode.OK && !ret.Text.Contains(\"already in line stat\"))\n {\n Console.WriteLine(\"change type error: \" + ret.ToString());\n }\n Console.WriteLine(ret.ToString());\n \n\n## 移动或重命名文件\n\n移动操作本身支持移动文件到相同，不同空间中，在移动的同时也可以支持文件重命名。唯一的限制条件是，移动的源空间和目标空间必须在同一个机房。\n\n源空间 | 目标空间 | 源文件名 | 目标文件名 | 描述 \n---|---|---|---|--- \nBucketA | BucketA | KeyA | KeyB | 相当于同空间文件重命名 \nBucketA | BucketB | KeyA | KeyA | 移动文件到BucketB，文件名一致 \nBucketA | BucketB | KeyA | KeyB | 移动文件到BucketB，文件名变成KeyB \n \n`move`操作支持强制覆盖选项，即如果目标文件已存在，可以设置强制覆盖选项`force`来覆盖那个文件的内容。\n\n \n \n // 原始空间\n string Bucket = \"7qiniu\";\n // 原始文件名\n string Key = \"0_01.png\";\n // 目标空间\n string newBucket = \"07qiniu\";\n // 目标文件名\n string newKey = \"move0_01.png\";\n // 是否设置强制覆盖\n Boolean force = true;\n HttpResult copyRet = bucketManager.move(Bucket, Key, newBucket, newKey, force);\n if (copyRet.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(\"move error: \" + moveRet.ToString());\n }\n Console.WriteLine(moveRet.ToString());\n \n\n## 复制文件副本\n\n文件的复制和文件移动其实操作一样，主要的区别是移动后源文件不存在了，而复制的结果是源文件还存在，只是多了一个新的文件副本。\n\n \n \n // 原始空间\n string Bucket = \"7qiniu\";\n // 原始文件名\n string Key = \"0_01.png\";\n // 目标空间\n string newBucket = \"07qiniu\";\n // 目标文件名\n string newKey = \"copy0_01.png\";\n // 是否设置强制覆盖\n Boolean force = true;\n HttpResult copyRet = bucketManager.copy(Bucket, Key, newBucket, newKey, force);\n if (copyRet.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(\"copy error: \" + copyRet.ToString());\n }\n Console.WriteLine(copyRet.ToString());\n \n\n## 删除空间中的文件\n\n \n \n // 空间名\n string Bucket = \"7qiniu\";\n // 文件名\n string Key = \"10138_7e706ac5317f2993176725cbdf50d0e10f079c05.ppt\";\n \n HttpResult deleteRet = bucketManager.Delete(Bucket, Key);\n Console.WriteLine(\"delete error: \" + deleteRet.ToString());\n \n if (deleteRet.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(\"delete error: \" + deleteRet.ToString());\n }\n \n\n## 设置或更新文件的生存时间\n\n可以给已经存在于空间中的文件设置文件生存时间，或者更新已设置了生存时间但尚未被删除的文件的新的生存时间。\n\n \n \n // 存储空间名\n string Bucket = \"7qiniu\";\n // 文件名\n string key = \"0_01.png\";\n \n HttpResult expireRet = bucketManager.DeleteAfterDays(Bucket, key, 7);\n \n if (expireRet.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(\"deleteAfterDays error: \" + expireRet.ToString());\n }\n Console.WriteLine(expireRet.ToString());\n \n\n## 获取指定前缀的文件列表\n\n \n \n // 空间名\n string Bucket = \"7qiniu\";\n // 指定前缀，只有资源名匹配该前缀的资源会被列出\n string prefix = \"qiniu\";\n // 指定目录分隔符，列出所有公共前缀（模拟列出目录效果）\n string delimiter = \"\";\n // 本次列举的条目数，范围为1-1000\n int limit = 100;\n // 上一次列举返回的位置标记，作为本次列举的起点信息\n string marker = \"\";\n \n \n ListResult listRet = bucketManager.ListFiles(Bucket, prefix, marker, limit, delimiter);\n if (listRet.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(\"list files error: \" + listRet.ToString());\n }\n Console.WriteLine(listRet.ToString());\n \n\n## 抓取网络资源到空间\n\n \n \n // 公网可访问的文件链接\n string resUrl = \"http://devtools.qiniu.com/qiniu.png\";\n // 存储空间名\n string Bucket = \"7qiniu\";\n // 文件名\n string Key = \"qiniu.jpg\";\n FetchResult ret = bucketManager.Fetch(resUrl, Bucket, Key);\n \n if (ret.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(\"fetch error: \" + ret.ToString());\n }\n Console.WriteLine(ret.ToString());\n \n\n## 更新镜像空间中存储的文件内容\n\n \n \n // 设置存储空间\n string Bucket = \"7qiniu\";\n // 文件名\n string key = \"333\";\n HttpResult ret = bucketManager.Prefetch(Bucket, \"qiniu.png\");\n if (ret.Code != (int)HttpCode.OK && !ret.Text.Contains(\"bucket source not set\"))\n {\n Console.WriteLine(\"prefetch error: \" + ret.ToString());\n }\n Console.WriteLine(ret.ToString());\n \n\n## 资源管理批量操作\n\n### 批量获取文件信息\n\n \n \n // 每个operations的数量不可以超过1000个，如果总数量超过1000，需要分批发送\n string[] keys = {\n \"00007.mp4\",\n \"0072102104.png\"\n };\n // 空间名\n string Bucket = \"7qiniu\";\n List<string> ops = new List<string>();\n foreach (string key in keys)\n {\n string op = bucketManager.StatOp(Bucket, key);\n ops.Add(op);\n }\n BatchResult ret = bucketManager.Batch(ops);\n if (ret.Code / 100 != 2)\n {\n Console.WriteLine(\"batch error: \" + ret.ToString());\n \n }\n foreach (BatchInfo info in ret.Result)\n {\n if (info.Code == (int)HttpCode.OK)\n {\n Console.WriteLine(\"{0}, {1}, {2}, {3}, {4}\", info.Data.MimeType,\n info.Data.PutTime, info.Data.Hash, info.Data.Fsize, info.Data.FileType);\n \n }\n else\n {\n Console.WriteLine(info.Data.Error);\n \n }\n \n }\n \n\n### 批量修改文件类型\n\n \n \n //每个operations的数量不可以超过1000个，如果总数量超过1000，需要分批发送\n // 空间名\n string Bucket = \"7qiniu\";\n // 文件名\n string[] keys = {\n \"354\",\n \"3.json\"\n };\n \n List<string> ops = new List<string>();\n foreach (string key in keys)\n {\n string op = bucketManager.ChangeTypeOp(Bucket, key, 1);\n ops.Add(op);\n }\n \n BatchResult ret = bucketManager.Batch(ops);\n if (ret.Code / 100 != 2)\n {\n Console.WriteLine(\"batch error: \" + ret.ToString());\n }\n foreach (BatchInfo info in ret.Result)\n {\n if (info.Code == (int)HttpCode.OK)\n {\n Console.WriteLine(\"chtype success\");\n }\n else\n {\n Console.WriteLine(info.Data.Error);\n }\n }\n \n\n### 批量删除文件\n\n \n \n //每个operations的数量不可以超过1000个，如果总数量超过1000，需要分批发送\n // 设置空间\n string Bucket = \"7qiniu\";\n string[] keys = {\n \"00_wo_ts_a.mp4\",\n \"0327-02.png\",\n \"0715589972949ea3a.mp4\"\n };\n \n List<string> ops = new List<string>();\n foreach (string key in keys)\n {\n string op = bucketManager.DeleteOp(Bucket, key);\n ops.Add(op);\n }\n \n BatchResult ret = bucketManager.Batch(ops);\n if (ret.Code / 100 != 2)\n {\n Console.WriteLine(\"batch error: \" + ret.ToString());\n }\n foreach (BatchInfo info in ret.Result)\n {\n if (info.Code == (int)HttpCode.OK)\n {\n Console.WriteLine(\"delete success\");\n }\n else\n {\n Console.WriteLine(info.Data.Error);\n }\n }\n \n\n### 批量复制文件\n\n \n \n //每个operations的数量不可以超过1000个，如果总数量超过1000，需要分批发送\n \n // 原空间 \n string srcBucket = \"7qiniu\";\n // 目标空间\n string dstBucket = \"07qiniu\";\n \n string[] keys = {\n \"007210021.png\",\n \"0072102104.png\",\n \"0327-02.png\"\n };\n \n List<string> ops = new List<string>();\n foreach (string key in keys)\n {\n string op = bucketManager.CopyOp(srcBucket, key, dstBucket, key, true);\n ops.Add(op);\n }\n \n BatchResult ret = bucketManager.Batch(ops);\n if (ret.Code / 100 != 2)\n {\n Console.WriteLine(\"batch error: \" + ret.ToString());\n }\n foreach (BatchInfo info in ret.Result)\n {\n if (info.Code == (int)HttpCode.OK)\n {\n Console.WriteLine(\"copy success\");\n }\n else\n {\n Console.WriteLine(info.Data.Error);\n }\n }\n \n\n### 批量移动或重命名文件\n\n \n \n //每个operations的数量不可以超过1000个，如果总数量超过1000，需要分批发送\n // 原空间 \n string srcBucket = \"7qiniu\";\n // 目标空间\n string dstBucket = \"01test\";\n string[] keys = {\n \"007210021.png\",\n \"0072102104.png\"\n };\n \n List<string> ops = new List<string>();\n foreach (string key in keys)\n {\n string op = bucketManager.MoveOp(srcBucket, key, dstBucket, key + \"-batch-move\", true);\n ops.Add(op);\n }\n \n BatchResult ret = bucketManager.Batch(ops);\n if (ret.Code / 100 != 2)\n {\n Console.WriteLine(\"batch error: \" + ret.ToString());\n }\n foreach (BatchInfo info in ret.Result)\n {\n if (info.Code == (int)HttpCode.OK)\n {\n Console.WriteLine(\"move success\");\n }\n else\n {\n Console.WriteLine(info.Data.Error);\n }\n }\n \n\n### 批量更新文件的有效期\n\n \n \n //每个operations的数量不可以超过1000个，如果总数量超过1000，需要分批发送\n string[] keys = {\n \"4389.png\",\n \"4.gif\"\n };\n // 空间名\n string Bucket = \"7qiniu\";\n List<string> ops = new List<string>();\n foreach (string key in keys)\n {\n string op = bucketManager.DeleteAfterDaysOp(Bucket, key, 7);\n ops.Add(op);\n }\n \n BatchResult ret = bucketManager.Batch(ops);\n if (ret.Code / 100 != 2)\n {\n Console.WriteLine(\"batch error: \" + ret.ToString());\n }\n foreach (BatchInfo info in ret.Result)\n {\n if (info.Code == (int)HttpCode.OK)\n {\n Console.WriteLine(\"deleteAfterDays success\");\n }\n else\n {\n Console.WriteLine(info.Data.Error + \"2\");\n }\n }\n \n\n### 批量更新文件存储类型\n\n \n \n //每个operations的数量不可以超过1000个，如果总数量超过1000，需要分批发送\n //type=0为普通存储，type=1为低频存储\n string[] keys = {\n \"qiniu-0.png\",\n \"qiniu-1.png\",\n \"qiniu-2.png\"\n };\n \n List<string> ops = new List<string>();\n int type = 0;\n foreach (string key in keys)\n {\n string op = bucketManager.ChangeTypeOp(Bucket, key, type);\n ops.Add(op);\n }\n \n BatchResult ret = bucketManager.Batch(ops);\n if (ret.Code / 100 != 2)\n {\n Console.WriteLine(\"batch error: \" + ret.ToString());\n }\n foreach (BatchInfo info in ret.Result)\n {\n if (info.Code == (int)HttpCode.OK)\n {\n Console.WriteLine(\"chtype success\");\n }\n else\n {\n Console.WriteLine(info.Data.Error);\n }\n }\n }\n \n\n# 持久化数据处理\n\n## 发送数据处理请求\n\n对于已经保存到七牛空间的文件，可以通过发送持久化的数据处理指令来进行处理，这些指令支持七牛官方提供的指令，也包括客户自己开发的自定义数据处理的指令。数据处理的结果还可以通过七牛主动通知的方式告知业务服务器。\n\n \n \n Mac mac = new Mac(AccessKey, SecretKey);\n Config config = new Config();\n OperationManager manager = new OperationManager(mac, config);\n \n //处理指令集合\n string saveMp4Entry = Base64.UrlSafeBase64Encode(Bucket + \":avthumb_test_target.mp4\");\n string saveJpgEntry = Base64.UrlSafeBase64Encode(Bucket + \":avthumb_test_target.jpg\");\n \n string avthumbMp4Fop = \"avthumb/mp4|saveas/\" + saveMp4Entry;\n string vframeJpgFop = \"vframe/jpg/offset/1|saveas/\" + saveJpgEntry;\n \n string fops = string.Join(\";\", new string[] { avthumbMp4Fop, vframeJpgFop });\n \n // 私有隊列名\n string pipeline = \"da\";\n string notifyUrl = \"http://api.example.com/qiniu/pfop/notify\";\n \n // 存储空间名\n string Bucket = \"7qiniu\";\n // 文件名\n string key = \"00007.mp4\";\n // 当服务端发现 fops 指定的数据处理结果已经存在，那就认为已经处理成功，避免重复处理浪费资源。加上本字段并设为 1，则可强制执行数据处理并覆盖原结果。\n bool force = true;\n PfopResult pfopRet = manager.Pfop(Bucket, key, fops, pipeline, notifyUrl, force);\n if (pfopRet.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(\"pfop error: \" + pfopRet.ToString());\n }\n //持久化数据处理返回的是任务的persistentId，可以根据这个id查询处理状态\n Console.WriteLine(pfopRet.PersistentId);\n \n\n## 查询数据处理请求状态\n\n由于数据处理是异步处理，可以根据发送处理请求时返回的 `persistentId`\n去查询任务的处理进度，如果在设置了`persistentNotifyUrl`\n的情况下，直接业务服务器等待处理结果通知即可，如果需要主动查询，可以采用如下代码中的：\n\n \n \n //持久化数据处理返回的是任务的persistentId\n string persistentId = \"z0.59abf1eb45a2650c9954087d\";\n Mac mac = new Mac(AccessKey, SecretKey);\n Config config = new Config();\n OperationManager manager = new OperationManager(mac, config);\n PrefopResult ret = manager.Prefop(persistentId);\n if (ret.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(\"prefop error: \" + ret.ToString());\n }\n Console.WriteLine(ret.ToString());\n \n\n# CDN相关功能\n\n * 文件刷新\n * 目录刷新\n * 文件预取操作\n * 获取域名流量\n * 获取域名带宽\n * 获取日志下载链接\n * 构建时间戳防盗链访问链接\n\n在使用CDN相关功能之前，需要构建`CdnManager`对象：\n\n \n \n Mac mac = new Mac(AccessKey, SecretKey);\n CdnManager manager = new CdnManager(mac);\n \n\n## 文件刷新\n\n \n \n //URL 列表\n string Domain = \"sq.qiniuts.com\";\n string[] urls = {\n string.Format(\"http://{0}/images/1.png\",Domain),\n string.Format(\"http://{0}/images/2.png\",Domain)\n };\n \n RefreshResult ret = manager.RefreshUrls(urls);\n if (ret.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(ret.ToString());\n }\n Console.WriteLine(ret.Result.Code);\n Console.WriteLine(ret.Result.Error);\n Console.WriteLine(ret.Result.UrlQuotaDay);\n Console.WriteLine(ret.Result.UrlSurplusDay);\n Console.WriteLine(ret.Result.RequestId);\n if (ret.Result.InvalidUrls != null)\n {\n foreach (string url in ret.Result.InvalidUrls)\n {\n Console.WriteLine(url);\n }\n }\n \n\n## 目录刷新\n\n \n \n string Domain = \"sq.qiniuts.com\";\n //DIR 列表\n string[] dirs = {\n string.Format(\"http://{0}/images1/\",Domain),\n string.Format(\"http://{0}/images2/\",Domain)\n };\n \n //刷新目录，刷新目录需要联系七牛技术支持开通权限\n //单次请求链接不可以超过10个，如果超过，请分批发送请求\n RefreshResult ret = manager.RefreshDirs(dirs);\n if (ret.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(ret.ToString());\n }\n Console.WriteLine(ret.Result.Code);\n Console.WriteLine(ret.Result.Error);\n Console.WriteLine(ret.Result.DirQuotaDay);\n Console.WriteLine(ret.Result.DirSurplusDay);\n Console.WriteLine(ret.Result.RequestId);\n if (ret.Result.InvalidDirs != null)\n {\n foreach (string dir in ret.Result.InvalidDirs)\n {\n Console.WriteLine(dir);\n }\n }\n \n\n## 文件预取\n\n \n \n //URL 列表\n string Domain = \"sq.qiniuts.com\";\n string[] urls = {\n string.Format(\"http://{0}/images/1.png\",Domain),\n string.Format(\"http://{0}/images/2.png\",Domain)\n };\n \n PrefetchResult ret = manager.PrefetchUrls(urls);\n if (ret.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(ret.ToString());\n }\n Console.WriteLine(ret.Result.Code);\n Console.WriteLine(ret.Result.Error);\n Console.WriteLine(ret.Result.QuotaDay);\n Console.WriteLine(ret.Result.SurplusDay);\n Console.WriteLine(ret.Result.RequestId);\n if (ret.Result.InvalidUrls != null)\n {\n foreach (string url in ret.Result.InvalidUrls)\n {\n Console.WriteLine(url);\n }\n }\n \n\n## 获取域名流量\n\n \n \n // 域名\n string Domain = \"sq.qiniuts.com\";\n string[] domains = new string[] { Domain };\n // 指定日期\n string start = \"2017-08-01\";\n string end = \"2017-08-10\";\n // 流量数据粒度\n string granu = \"day\";\n //获取域名流量\n FluxResult ret = manager.GetFluxData(domains, start, end, granu);\n if (ret.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(ret.ToString());\n }\n \n foreach (string domain in domains)\n {\n Console.WriteLine(\"flux data of domain: \" + domain);\n foreach (string t in ret.Result.Time)\n {\n Console.Write(t + \"\\t\");\n }\n Console.WriteLine();\n if (ret.Result.Data.ContainsKey(domain))\n {\n if (ret.Result.Data[domain].China != null)\n {\n Console.WriteLine(\"China:\");\n foreach (UInt64 v in ret.Result.Data[domain].China)\n {\n Console.Write(v + \"\\t\");\n }\n Console.WriteLine();\n }\n \n \n if (ret.Result.Data[domain].Oversea != null)\n {\n Console.WriteLine(\"Oversea:\");\n foreach (int v in ret.Result.Data[domain].Oversea)\n {\n Console.Write(v + \"\\t\");\n }\n Console.WriteLine();\n }\n }\n }\n \n\n## 获取域名带宽\n\n \n \n // 域名\n string Domain = \"sq.qiniuts.com\";\n string[] domains = new string[] { Domain };\n // 设置时间范围\n string start = \"2017-08-01\";\n string end = \"2017-08-10\";\n // 带宽数据粒度\n string granu = \"day\";\n \n //获取域名带宽\n BandwidthResult ret = manager.GetBandwidthData(domains, start, end, granu);\n if (ret.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(ret.ToString());\n }\n \n foreach (string domain in domains)\n {\n Console.WriteLine(\"bandwidth data of domain: \" + domain);\n foreach (string t in ret.Result.Time)\n {\n Console.Write(t + \"\\t\");\n }\n Console.WriteLine();\n if (ret.Result.Data.ContainsKey(domain))\n {\n if (ret.Result.Data[domain].China != null)\n {\n Console.WriteLine(\"China:\");\n foreach (int v in ret.Result.Data[domain].China)\n {\n Console.Write(v + \"\\t\");\n }\n Console.WriteLine();\n }\n \n \n if (ret.Result.Data[domain].Oversea != null)\n {\n Console.WriteLine(\"Oversea:\");\n foreach (UInt64 v in ret.Result.Data[domain].Oversea)\n {\n Console.Write(v + \"\\t\");\n }\n Console.WriteLine();\n }\n }\n }\n \n\n## 获取日志下载链接\n\n \n \n // 设置域名\n string Domain = \"sq.qiniuts.com\";\n // 设置时间\n string day = \"2017-08-10\";\n string[] domains = new string[] { Domain };\n LogListResult ret = manager.GetCdnLogList(domains, day);\n if (ret.Code != (int)HttpCode.OK)\n {\n Console.WriteLine(ret.ToString());\n }\n \n foreach (string domain in ret.Result.Data.Keys)\n {\n Console.WriteLine(\"log list for domain: \" + domain);\n foreach (LogData data in ret.Result.Data[domain])\n {\n Console.WriteLine(data.Name + \"\\t\" + data.Size + \"\\t\" + data.Mtime + \"\\t\" + data.Url);\n }\n }\n \n\n## 构建时间戳防盗链访问链接\n\n具体算法可以参考：[时间戳防盗链](https://developer.qiniu.com/fusion/kb/timestamp-hotlinking-\nprevention)\n\n \n \n string host = \"http://qnls.example.com\";\n string fileName = \"hello/6000694.ls\";\n string query = \"v=34\";\n int expireInSeconds = 3600;\n //加密密钥\n string encryptKey = \"xxx\";\n string finalUrl = CdnManager.CreateTimestampAntiLeechUrl(host, fileName, query, encryptKey, expireInSeconds);\n Console.WriteLine(finalUrl);\n \n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n * [融合CDN API 参考](https://developer.qiniu.com/fusion)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n\n# 常见问题\n\n * API 的使用，可以参考我们为大家精心准备的[使用实例 __](https://github.com/qiniu/csharp-sdk/tree/master/src/QiniuTests)。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](https://support.qiniu.com/tickets/new)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储C# SDK v7.2.15 文档"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [C#\nSDK](https://developer.qiniu.com/kodo/sdk/1237/csharp) > C# SDK v7.2.15 文档\n\n# C# SDK v7.2.15 文档\n\n最近更新时间: 2019-11-08 14:36:27\n\n\n\n此 C# SDK 适用于.NET Framework 2.0+ , .NET Core 以及UWP(Windows 10\n通用应用)，基于七牛云API参考手册构建。使用此 SDK\n构建您的网络应用程序，能让您以非常便捷地方式将数据安全地存储到七牛云存储上。无论您的网络应用是一个网站程序，还是包括从云端（服务端程序）到终端（手持设备应用）的架构的服务或应用，通过七牛云存储及其\nSDK，都能让您应用程序的终端用户高速上传和下载，同时也让您的服务端更加轻盈。\n\n# 安装\n\n * 直接添加DLL引用\n * 包管理器(NuGet)方式安装\n * 从源码编译\n\n \n**直接添加DLL引用**\n\n您可以在[这里](https://github.com/qiniu/csharp-\nsdk/releases)找到所有的Release，选择您需要的版本下载，解压后将*.dll文件添加至项目引用。需要注意的是，此SDK依赖[Json.NET](http://www.newtonsoft.com/json)，可以添加对应版本Newtonsoft.Json.dll引用或者使用NuGet来安装它：\n\n \n \n Install-Package Newtonsoft.Json\n \n\n \n**包管理器(NuGet)方式安装**\n\n或者从NuGet来安装，以Visual Studio 2013/2015为例(如果您的Visual\nStudio没有安装NuGet，请先[安装](http://docs.nuget.org/docs/start-here/installing-\nnuget))。打开NuGet程序包管理器搜索Qiniu.Shared或者在控制台中键入以下命令：\n\n \n \n Install-Package Qiniu.Shared\n \n\n \n**从源码编译**\n\n当然，您也可以直接从源码编译\n\n \n \n git clone https://github.com/qiniu/csharp-sdk\n \n\n# 鉴权\n\n * 获取密钥\n * 配置密钥\n * 生成凭证\n\n七牛C# SDK的上传、文件管理等功能需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的密钥：`Access Key`和`Secret Key`。\n\n \n**获取密钥**\n\n要接入七牛云存储，您需要拥有一对有效的 Access Key (以下简称AK) 和 Secret Key (以下简称SK)\n用来进行签名认证。您可以登录七牛开发者平台，查看 [AK 和\nSK](https://portal.qiniu.com/user/key)。如果没有账号，可以在[七牛开发者平台](https://portal.qiniu.com/signup)开通一个七牛开发者帐号。\n\n \n**配置密钥**\n\n使用各种七牛API服务(如upload等)之前请确保AK & SK均已赋值：\n\n \n \n // AK = \"<YOUR_ACCESS_KEY>\"\n // SK = \"<YOUR_SECRET_KEY>\"\n \n\n \n**生成凭证**\n\n使用AK &\nSK构建Mac对象，然后使用Mac对象生成鉴权类`Auth`，然后就可以生成上传凭证、管理凭证等（以下`CreateXXToken`中的XXToken是是`UploadToken`,`DownloadToken`,`ManageToken`之一）：\n\n \n \n using Qiniu.Util;\n Mac mac = new Mac(AK, SK);\n Auth auth = new Auth(mac);\n auth.CreateXXToken(...);\n \n\n或者使用Auth的静态方法：\n\n \n \n using Qiniu.Util;\n Mac mac = new Mac(AK, SK);\n Auth.CreateXXToken(mac,...);\n \n\n# SDK设置\n\n## Zone设置\n\n此步骤是必要的。\n\n不同的空间(bucket)可能位于不同的机房(区域/Zone)，因此文件管理/文件上传等操作需要正确配置Zone(位于`Qiniu.Common`命名空间)，默认配置为”华东机房”，用户可以有以下两种方法配置Zone:\n\n1.直接配置（ 如果确定机房所在Zone，可以使用此方法）\n\n \n \n // ZoneID zoneId = ZoneID.CN_East; \n // [CN_East:华东] [CN_South:华南] [CN_North:华北] [US_North:北美]\n // USE_HTTPS = (true|false) 是否使用HTTPS\n Qiniu.Common.Config.SetZone(zoneId,USE_HTTPS);\n \n\n2.使用AutoZone自动配置（推荐使用这个方法）\n\n \n \n // AK = ACCESS_KEY\n // USE_HTTPS = (true|false) 是否使用HTTPS\n // 使用前请确保AK和BUCKET正确，否则此函数会抛出异常(比如code612/631等错误)\n Qiniu.Common.Config.AutoZone(AK,BUCKET,USE_HTTPS);\n \n\n## JSON解析器设置\n\n这个步骤是可选的。\n\n此SDK选用[Newtonsoft.Json](http://www.newtonsoft.com/json)（也称作Json.NET）作为默认的JSON解析器，您也可以自行设置（分别设置`Qiniu.JSON.JsonHelper`的两个属性：`JsonSerializer`和`JsonDeserializer`），可以参考如下示例。\n\n首先定义您的JSON序列化(Serialize)、反序列化(Deserialize)方法（此例使用默认的Newtonsoft.Json来实现）：\n\n \n \n using Newtonsoft.Json;\n using Newtonsoft.Json.Serialization;\n using Qiniu.JSON;\n \n namespace CSharpSDKExamples\n {\n public class AnotherJsonSerializer : IJsonSerializer\n {\n // 实现此接口的JSON序列化方法\n public string Serialize<T>(T obj) where T : new()\n {\n var settings = new JsonSerializerSettings();\n settings.ContractResolver = new CamelCasePropertyNamesContractResolver();\n settings.NullValueHandling = NullValueHandling.Ignore;\n return JsonConvert.SerializeObject(obj, settings);\n }\n }\n \n public class AnotherJsonDeserializer : IJsonDeserializer\n {\n // 实现此接口的JSON反序列化方法\n public bool Deserialize<T>(string str, out T obj) where T : new()\n {\n obj = default(T);\n \n bool ok = true;\n \n try\n {\n obj = JsonConvert.DeserializeObject<T>(str);\n }\n catch (System.Exception)\n {\n ok = false;\n }\n \n return ok;\n }\n }\n }\n \n\n然后在使用此SDK的其他功能(函数)之前设置JSON解析器，只需设置一次即可：\n\n \n \n // 使用自定义的JSON序列化、反序列化方法\n Qiniu.JSON.JsonHelper.JsonSerializer = new AnotherJsonSerializer();\n Qiniu.JSON.JsonHelper.JsonDeserializer = new AnotherJsonDeserializer();\n \n\n如果您希望摆脱Json.NET依赖（比如您只想使用其他更轻量、更高效的JSON解析器或者自行实现），可在[此项目的github\nrelease](https://github.com/qiniu/csharp-sdk/releases)中找到ext-\njson版本，或者安装NuGet上的`Qiniu.Shared.ExtJson`版本，又或者参照此SDK源码的说明对`Qiniu.JSON`模块稍作修改然后编译。\n\n# 上传文件\n\n * 上传流程\n * 上传策略\n * 上传凭证\n * 上传方式选择\n * 简单上传\n * 字节数据上传\n * 数据流上传\n * 覆盖上传\n * 断点续上传\n * 上传&预转持久化\n\n## 上传流程\n\n为了尽可能地改善终端用户的上传体验，七牛云存储首创了客户端直传功能。更多信息请参阅[业务流程](https://developer.qiniu.com/kodo/manual/programming-\nmodel)。\n\n## 上传策略\n\n上传策略包含了上传文件的各种配置。在PuPolicy(上传策略)中可以进行丰富的参数设置，比如：文件类型限制、大小限制、回调设置等等，可以参考[上传策略](https://developer.qiniu.com/kodo/manual/put-\npolicy)，具体使用方法可参考下面的上传示例。\n\n## 上传凭证\n\n关于上传凭证的详细介绍，请参见[上传凭证](http://developer.qiniu.com/article/developer/security/upload-\ntoken.html)。可以使用`Auth.CreateUploadToken`来生成上传凭证，请参考上述的“鉴权”部分或者后面的“上传文件”示例代码。\n\n## 上传方式选择\n\n此SDK提供了两种上传模式：[表单上传](https://developer.qiniu.com/kodo/manual/form-\nupload)和[分片上传](https://developer.qiniu.com/kodo/manual/chunked-upload)。\n\n**表单上传** ：一般适用于文件体积较小的情形，请使用`FormUploader`\n\n**分片上传** ：适用于大文件或者需要支持断点续上传的情形，请使用`ResumableUploader`\n\n**自动选择** ：自动选择以上两种方式之一（但需要预先知道待上传文件或者数据(流)的大小），请使用`UploadManager`\n\n需要注意的是，如果您需要上传“一种特殊的数据流（此流不支持查找）”时（例如NetworkStream，请参阅后面的“上传数据流”示例），请使用FormUploader或者ResumableUploader的UploadStream方法，因为这两个方法不需要预先知道流的长度。\n\n## 简单上传\n\n使用FormUploader,ResumableUploader或者UploadManager，以下代码示意了如何使用UploadManager来上传一个本地文件\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.IO;\n using Qiniu.IO.Model;\n using Qiniu.Http;\n \n namespace CSharpSDKExamples\n {\n public class UploadDemo\n {\n /// <summary>\n /// 简单上传-上传小文件\n /// </summary>\n public void UploadFile()\n {\n // 生成(上传)凭证时需要使用此Mac\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n string bucket = \"test\";\n string saveKey = \"1.png\";\n string localFile = \"D:\\\\QFL\\\\1.png\";\n \n // 上传策略，参见 \n // https://developer.qiniu.com/kodo/manual/put-policy\n PutPolicy putPolicy = new PutPolicy();\n \n // 如果需要设置为\"覆盖\"上传(如果云端已有同名文件则覆盖)，请使用 SCOPE = \"BUCKET:KEY\"\n // putPolicy.Scope = bucket + \":\" + saveKey;\n putPolicy.Scope = bucket;\n \n // 上传策略有效期(对应于生成的凭证的有效期) \n putPolicy.SetExpires(3600);\n \n // 上传到云端多少天后自动删除该文件，如果不设置（即保持默认默认）则不删除\n putPolicy.DeleteAfterDays = 1;\n \n // 生成上传凭证，参见\n // https://developer.qiniu.com/kodo/manual/upload-token \n \n string jstr = putPolicy.ToJsonString();\n string token = Auth.CreateUploadToken(mac, jstr);\n \n UploadManager um = new UploadManager();\n \n HttpResult result = um.UploadFile(localFile, saveKey, token);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n## 字节数据上传\n\n使用FormUploader,ResumableUploader或者UploadManager，以下代码示意了如何使用FormUploader来上传字节数据\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.IO;\n using Qiniu.IO.Model;\n using Qiniu.Http;\n \n namespace CSharpSDKExamples\n {\n public class UploadDemo\n {\n /// <summary>\n /// 简单上传-上传字节数据\n /// </summary>\n public void UploadData()\n {\n // 生成(上传)凭证时需要使用此Mac\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n string bucket = \"test\";\n string saveKey = \"myfile\";\n byte[] data = System.IO.File.ReadAllBytes(\"D:/QFL/1.mp3\");\n //byte[] data = System.Text.Encoding.UTF8.GetBytes(\"Hello World!\");\n \n // 上传策略，参见 \n // https://developer.qiniu.com/kodo/manual/put-policy\n PutPolicy putPolicy = new PutPolicy();\n \n // 如果需要设置为\"覆盖\"上传(如果云端已有同名文件则覆盖)，请使用 SCOPE = \"BUCKET:KEY\"\n // putPolicy.Scope = bucket + \":\" + saveKey;\n putPolicy.Scope = bucket;\n \n // 上传策略有效期(对应于生成的凭证的有效期) \n putPolicy.SetExpires(3600);\n \n // 上传到云端多少天后自动删除该文件，如果不设置（即保持默认默认）则不删除\n putPolicy.DeleteAfterDays = 1;\n \n // 生成上传凭证，参见\n // https://developer.qiniu.com/kodo/manual/upload-token \n \n string jstr = putPolicy.ToJsonString();\n string token = Auth.CreateUploadToken(mac, jstr);\n \n FormUploader fu = new FormUploader();\n \n HttpResult result = fu.UploadData(data, saveKey, token);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n## 数据流上传\n\n使用FormUploader,ResumableUploader或者UploadManager，如果预先不知道上传的流的长度，请使用FormUploader或者ResumableUploader，以下代码示意了如何使用FormUploader来上传一个网络流（“此流不支持查找操作”）：\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.IO;\n using Qiniu.IO.Model;\n using Qiniu.Http;\n \n namespace CSharpSDKExamples\n {\n public class UploadDemo\n {\n /// <summary>\n /// 上传（来自网络回复的）数据流\n /// </summary>\n public void UploadStream()\n {\n // 生成(上传)凭证时需要使用此Mac\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n string bucket = \"test\";\n string saveKey = \"1.jpg\";\n \n // 上传策略，参见 \n // https://developer.qiniu.com/kodo/manual/put-policy\n PutPolicy putPolicy = new PutPolicy();\n \n // 如果需要设置为\"覆盖\"上传(如果云端已有同名文件则覆盖)，请使用 SCOPE = \"BUCKET:KEY\"\n // putPolicy.Scope = bucket + \":\" + saveKey;\n putPolicy.Scope = bucket;\n \n // 上传策略有效期(对应于生成的凭证的有效期) \n putPolicy.SetExpires(3600);\n \n // 上传到云端多少天后自动删除该文件，如果不设置（即保持默认默认）则不删除\n putPolicy.DeleteAfterDays = 1;\n \n // 生成上传凭证，参见\n // https://developer.qiniu.com/kodo/manual/upload-token \n \n string jstr = putPolicy.ToJsonString();\n string token = Auth.CreateUploadToken(mac, jstr);\n \n try\n {\n string url = \"http://img.ivsky.com/img/tupian/pre/201610/09/beifang_shanlin_xuejing-001.jpg\";\n var wReq = System.Net.WebRequest.Create(url) as System.Net.HttpWebRequest;\n var resp = wReq.GetResponse() as System.Net.HttpWebResponse;\n using (var stream = resp.GetResponseStream())\n {\n // 请不要使用UploadManager的UploadStream方法，因为此流不支持查找(无法获取Stream.Length)\n // 请使用FormUploader或者ResumableUploader的UploadStream方法\n FormUploader fu = new FormUploader();\n var result = fu.UploadStream(stream, \"xuejing-001.jpg\", token);\n Console.WriteLine(result);\n }\n }\n catch (Exception ex)\n {\n Console.WriteLine(ex);\n }\n }\n }\n }\n \n\n## 覆盖上传\n\n在上传策略中设置`SCOPE = \"BUCKET:KEY\"`:\n\n \n \n PutPolicy putPolicy = new PutPolicy();\n putPolicy.Scope = bucket + \":\" + saveKey;\n \n\n其余部分代码类似。\n\n## 断点续上传\n\n对于大尺寸文件的上传，可能需要进行分片上传或者需要从中断后的位置继续上传，这时请使用ResumeUploader。\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.IO;\n using Qiniu.IO.Model;\n using Qiniu.Http;\n \n namespace CSharpSDKExamples\n {\n public class UploadDemo\n {\n /// <summary>\n /// 上传大文件，可以从上次的断点位置继续上传\n /// </summary>\n public void UploadBigFile()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n string bucket = \"test\";\n string saveKey = \"1.mp4\";\n string localFile = \"D:\\\\QFL\\\\1.mp4\";\n \n // 断点记录文件，可以不用设置，让SDK自动生成，如果出现续上传的情况，SDK会尝试从该文件载入断点记录\n // 对于不同的上传任务，请使用不同的recordFile\n string recordFile = \"D:\\\\QFL\\\\resume.12345\";\n \n PutPolicy putPolicy = new PutPolicy();\n putPolicy.Scope = bucket;\n putPolicy.SetExpires(3600);\n \n string token = Auth.CreateUploadToken(mac, putPolicy.ToJsonString());\n \n // 包含两个参数，并且都有默认值\n // 参数1(bool): uploadFromCDN是否从CDN加速上传，默认否\n // 参数2(enum): chunkUnit上传分片大小，可选值128KB,256KB,512KB,1024KB,2048KB,4096KB\n ResumableUploader ru = new ResumableUploader(false, ChunkUnit.U1024K);\n \n // ResumableUploader.UploadFile有多种形式，您可以根据需要来选择\n //\n // 最简模式，使用默认recordFile和默认uploadProgressHandler\n // UploadFile(localFile,saveKey,token)\n // \n // 基本模式，使用默认uploadProgressHandler\n // UploadFile(localFile,saveKey,token,recordFile)\n //\n // 一般模式，使用自定义进度处理(可以监视上传进度)\n // UploadFile(localFile,saveKey,token,recordFile,uploadProgressHandler)\n //\n // 高级模式，包含上传控制(可控制暂停/继续 或者强制终止)\n // UploadFile(localFile,saveKey,token,recordFile,uploadProgressHandler,uploadController)\n // \n \n // 支持自定义参数\n //var extra = new System.Collections.Generic.Dictionary<string, string>();\n //extra.Add(\"FileType\", \"UploadFromLocal\");\n //extra.Add(\"YourKey\", \"YourValue\");\n //uploadFile(...,extra,...)\n \n //最大尝试次数(有效值1~20)，在上传过程中(如mkblk或者bput操作)如果发生错误，它将自动重试，如果没有错误则无需重试\n int maxTry = 10;\n \n // 使用默认进度处理，使用自定义上传控制 \n UploadProgressHandler upph = new UploadProgressHandler(ResumableUploader.DefaultUploadProgressHandler);\n UploadController upctl = new UploadController(uploadControl);\n HttpResult result = ru.UploadFile(localFile, saveKey, token, recordFile, maxTry, upph, upctl);\n \n Console.WriteLine(result);\n }\n \n // 内部变量，仅作演示\n private static bool paused = false;\n \n /// <summary>\n /// 上传控制\n /// </summary>\n /// <returns></returns>\n private static UPTS uploadControl()\n {\n // 这个函数只是作为一个演示，实际当中请根据需要来设置\n // 这个演示的实际效果是“走走停停”，也就是停一下又继续，如此重复直至上传结束\n paused = !paused;\n \n if (paused)\n {\n return UPTS.Suspended;\n }\n else\n {\n return UPTS.Activated;\n }\n }\n }\n }\n \n\n## 上传&预转持续化\n\n如果需要在在资源上传后自动触发[持久化处理](https://developer.qiniu.com/dora/manual/1291)，在PutPolicy（[上传策略](https://developer.qiniu.com/kodo/manual/put-\npolicy)）中设置persistentOps这一项即可。\n\n \n \n PutPolicy putPolicy = new PutPolicy();\n // ... (这里省略了putPolicy的一些设置)\n putPolicy.PersistentOps = \"PERSISTENT_OPS\";\n \n\n其中`PERSISTENT_OPS`可以参考[persistentOps详解](https://developer.qiniu.com/kodo/manual/put-\npolicy#put-policy-persistent-ops-explanation)\n\n# 下载文件\n\n * 下载可公开访问的文件\n * 下载私有空间中的文件\n\n## 下载可公开访问的文件\n\n可下载网络上或者公开空间中的小文件（如文本、图片等）。\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.IO;\n using Qiniu.IO.Model;\n using Qiniu.Http;\n \n namespace CSharpSDKExamples\n {\n public class DownloadDemo\n {\n /// <summary>\n /// 下载可公开访问的文件\n /// </summary>\n public void DownloadFile()\n {\n // 文件URL\n string rawUrl = \"http://img.ivsky.com/img/tupian/pre/201610/09/beifang_shanlin_xuejing-001.jpg\";\n // 要保存的文件名，如果已存在则默认覆盖\n string saveFile = \"D:\\\\QFL\\\\saved-snow.jpg\";\n \n // 可公开访问的url，直接下载\n HttpResult result = DownloadManager.Download(rawUrl, saveFile);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n## 下载私有空间中的文件\n\n私有空间中的文件访问链接需要经过授权，**生成授权下载链接** 的过程如下：\n\n \n \n ACC_URL = RAW_URL+Expire+Token\n \n\n比如原始链接`http://example.com/file/1.jpg`\n\n加上过期时间戳 `http://example.com/file/1.jpg?e=1476783956`\n\n（如果原始链接中已包含?打头的query字符串，则时间戳字符串改为`&e=...`）\n\n然后Auth生成token拼接上去 `http://example.com/file/1.jpg?e=1476783956&token=Token`\n\n可参考下面的方法下载私有空间中的小文件：\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.Util;\n using Qiniu.IO;\n using Qiniu.IO.Model;\n using Qiniu.Http;\n \n namespace CSharpSDKExamples\n {\n public class DownloadDemo\n {\n /// <summary>\n /// 下载私有空间中的文件\n /// </summary>\n public void DownloadPrivateFile()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n string rawUrl = \"http://your-bucket.bkt.clouddn.com/1.jpg\";\n string saveFile = \"D:\\\\QFL\\\\saved-1.jpg\";\n \n // 设置下载链接有效期3600秒\n int expireInSeconds = 3600;\n string accUrl = DownloadManager.CreateSignedUrl(mac, rawUrl, expireInSeconds);\n \n // 接下来可以使用accUrl来下载文件\n HttpResult result = DownloadManager.Download(accUrl, saveFile);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n# 空间文件管理\n\n * 支持的功能列表\n * 简单处理\n * 批量处理\n * 获取空间文件列表\n * 更新文件生命周期\n\n## 支持的功能\n\n下表列举了空间管理的一些基本功能（部分不常见的功能未在此列举）：\n\n功能 | 函数 | 说明 \n---|---|--- \n获取文件信息 | Stat(bucket,key) | 文件名、大小、Hash等信息 \n修改文件类型 | Chgm(bucket,key,mimeType) | 修改后的类型为`mimeType` \n移动或重命名文件 | Move(srcBucket,srcKey,dstBucket,dstKey,[force]) | 可选参数force \n复制文件 | Copy(srcBucket,srcKey,dstBucket,dstKey,[force]) | 可选参数force \n删除文件 | Delete(bucket,key) | \n设置或更新文件生存时间 | UpdateLifecycle(bucket,key,days) | 设置days=0表示取消 \n获取空间文件列表 | ListFiles(bucket) | 另请参阅后面的“获取文件列表”示例 \n抓取网络资源到空间 | Fetch(resURL,bucket,key) | \n更新镜像空间中的文件 | Prefetch(resURL,bucket,key) | 空间`bucket`设置了“镜像存储” \n资源管理批量操作 | Batch(opstr) | 另请参阅后面的“批量处理”示例 \n批量获取文件信息 | BatchStat(bucket,keys) | 参数keys是string数组 \n批量删除文件 | BatchDelete(bucket,keys) | 参数keys是string数组 \n \n## 简单处理\n\n支持stat、copy、move、delete等，其中move/copy支持force参数(强制覆盖选项，即如果目标文件已存在，可以设置强制覆盖参数force来覆盖那个文件的内容)。\n\n以下代码示意了如何获取空间中文件的信息(stat)：\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.RS;\n using Qiniu.RS.Model;\n using Qiniu.Http;\n \n namespace CSharpSDKExamples\n {\n public BucketDemo\n {\n /// <summary>\n /// 获取文件基本信息\n /// </summary>\n public void Stat()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n string bucket = \"test\";\n string key = \"1.avi\";\n \n BucketManager bm = new BucketManager(mac);\n \n StatResult result = bm.Stat(bucket, key);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n其他操作类似。\n\n## 批量处理\n\nbatch批处理请求的主体内容具有op=OP1&op=OP2&op=...这样的格式，其中op=OPS作为一个单位，用&符号相连，OPS是以上stat,copy,move,delete等操作字符串。\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.RS;\n using Qiniu.RS.Model;\n using Qiniu.Http;\n \n namespace CSharpSDKExamples\n {\n public class BucketDemo\n {\n /// <summary>\n /// 批量操作\n /// </summary>\n public void Batch()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n // 批量操作类似于\n // op=<op1>&op=<op2>&op=<op3>...\n string batchOps = \"op=OP1&op=OP2\";\n BucketManager bm = new BucketManager(mac);\n var result = bm.Batch(batchOps);\n // 或者\n //string[] batch_ops={\"<op1>\",\"<op2>\",\"<op3>\",...};\n //bm.Batch(batch_ops);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n## 获取空间文件列表\n\n在BucketManager类中提供了ListFiles方法`ListFiles(bucket, prefix, marker, limit,\ndelimiter)`.\n\n该方法返回值中，有以下3个字段需要关注：\n\n字段 | 含义 \n---|--- \nMarker | 请参阅下述的marker参数 \nItems | 返回的结果，其中包括文件名、hash、大小等信息 \nCommonPrefixes | 请参阅下述的delimiter和prefix参数 \n \n函数参数说明如下：\n\n参数 | 含义 \n---|--- \nbucket | 目标空间名称 \nprefix | 返回指定文件名前缀的文件列表(prefix可设为null) \nmarker | 考虑到设置limit后返回的文件列表可能不全(需要重复执行listFiles操作) 执行listFiles操作时使用marker标记来追加新的结果。**特别注意** 首次执行listFiles操作时marker为null \nlimit | 每次返回结果所包含的文件总数限制(limit最大值1000， _建议值100_) \ndelimiter | 分隔符，比如-或者/等等，可以模拟作为目录结构(参考下述示例)。假设指定空间中有2个文件 fakepath/1.txt fakepath/2.txt 现设置delimiter=/ 得到结果items =[]，commonPrefixes = [fakepath/] 调整prefix=fakepath/ delimiter=null 得到所需结果items=[1.txt,2.txt] 于是可以在本地先创建一个目录fakepath,然后在该目录下写入items中的文件 \n \n以下是一个获取文件列表的示例：\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.RS;\n using Qiniu.RS.Model;\n using Qiniu.Http;\n \n namespace CSharpSDKExamples\n {\n public class BucketDemo\n {\n /// <summary>\n /// 获取空间文件列表 \n /// </summary>\n public void ListFiles()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n string bucket = \"test\";\n string marker = \"\"; // 首次请求时marker必须为空\n string prefix = null; // 按文件名前缀保留搜索结果\n string delimiter = null; // 目录分割字符(比如\"/\")\n int limit = 100; // 单次列举数量限制(最大值为1000)\n \n BucketManager bm = new BucketManager(mac);\n //List<FileDesc> items = new List<FileDesc>();\n //List<string> commonPrefixes = new List<string>();\n \n do\n {\n ListResult result = bm.ListFiles(bucket, prefix, marker, limit, delimiter);\n \n Console.WriteLine(result);\n \n marker = result.Result.Marker;\n \n //if (result.Result.Items != null)\n //{\n // items.AddRange(result.Result.Items);\n //}\n \n //if (result.Result.CommonPrefixes != null)\n //{\n // commonPrefixes.AddRange(result.Result.CommonPrefixes);\n //}\n \n } while (!string.IsNullOrEmpty(marker));\n \n //foreach (string cp in commonPrefixes)\n //{\n // Console.WriteLine(cp);\n //}\n \n //foreach(var item in items)\n //{\n // Console.WriteLine(item.Key);\n //}\n }\n }\n }\n \n\n## 更新文件生命周期\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.RS;\n using Qiniu.RS.Model;\n using Qiniu.Http;\n \n namespace CSharpSDKExamples\n {\n public BucketDemo\n {\n /// <summary>\n /// 设置或更新文件生命周期\n /// </summary>\n public void UpdateLifecycle()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n string bucket = \"test\";\n string key = \"1.jpg\";\n \n BucketManager bm = new BucketManager(mac);\n \n // 新的deleteAfterDays，设置为0表示取消lifecycle\n int deleteAfterDays = 1;\n BucketManager bm = new BucketManager(mac);\n var result = bm.UpdateLifecycle(bucket, key, deleteAfterDays);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n# 持久化操作\n\n如果需要对已保存在空间中的资源进行云处理并将结果持久化，可以使用[持久化数据处理](https://developer.qiniu.com/dora/manual/1291), \n如果需要使用独立资源的处理队列，建议先创建一个队列(可将队列名赋给下述示例中的pipeline变量)，队列的创建可以参考[音视频转码界面化操作队列](https://developer.qiniu.com/dora/kb/3853/how-\nto-create-audio-and-video-processing-private-queues)\n\n \n \n using System;\n using Qiniu.Common;\n using Qiniu.RSF;\n using Qiniu.RSF.Model;\n using Qiniu.Util;\n \n namespace CSharpSDKExamples\n {\n public class ProcessingDemo\n {\n /// <summary>\n /// 持久化并保存处理结果\n /// </summary>\n public void PfopAndSave()\n {\n string bucket = \"test\";\n string key = \"1.avi\";\n // 队列名称，如果没有，请设置为null\n // 另请参阅https://qiniu.kf5.com/hc/kb/article/112978/\n string pipeline = \"MEDIAPROC_PIPELINE\";\n // 接收处理结果通知的URL，另请参阅\n // http://developer.qiniu.com/code/v6/api/dora-api/pfop/pfop.html#pfop-notification\n string notifyUrl = \"NOTIFY_URL\";\n bool force = false;\n \n // 要保存的目标空间\n string dstBucket = \"dest-bucket\";\n string dstKey = \"2.mp4\";\n string saveAsUri = StringHelper.urlSafeBase64Encode(dstBucket + \":\" + dstKey);\n // 需要执行的数据处理,例如视频转码\n string fopM = \"FILE_OPS\"; //示例: \"avthumb/mp4\";\n // 使用管道'|'命令，将处理结果saveas另存\n string fops = fopM + \"|saveas/\" + saveAsUri;\n \n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n OperationManager ox = new OperationManager(mac);\n PfopResult result = ox.Pfop(bucket, key, fops, pipeline, notifyUrl, force);\n \n // 稍后可以根据PersistentId查询处理进度/结果\n //string persistentId = result.PersistentId;\n //HttpResult pr = ox.Prefop(persistentId);\n //Console.WriteLine(pr);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n其中`FILE_OPS`就是要进行的操作，如：`vframe/jpg/offset/1/w/480/h/360/rotate/90`表示视频截图。\n\n# CDN加速\n\n融合CDN加速的功能有：[缓存刷新](https://developer.qiniu.com/fusion/api/cache-\nrefresh)（包括文件刷新和目录刷新）、[文件预取](https://developer.qiniu.com/fusion/api/file-\nprefetching)、获取[流量带宽](https://developer.qiniu.com/fusion/api/traffic-\nbandwidth)、获取[日志下载](https://developer.qiniu.com/fusion/api/download-the-\nlog)链接、生成[时间戳防盗链](https://developer.qiniu.com/fusion/kb/timestamp-hotlinking-\nprevention)，下面分别是对应的示例。\n\n * 文件刷新\n * 目录刷新\n * 文件预取操作\n * 获取域名流量\n * 获取域名带宽\n * 获取日志下载链接\n * 构建时间戳防盗链访问链接\n\n## 文件刷新\n\n \n \n using System;\n using Qiniu.Util;\n using Qiniu.CDN;\n using Qiniu.CDN.Model;\n \n namespace CSharpSDKExamples\n {\n public class FusionDemo\n {\n /// <summary>\n /// 缓存刷新\n /// </summary>\n public void CdnRefresh()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n CdnManager cdnMgr = new CdnManager(mac);\n \n string[] urls = new string[] { \"http://yourdomain.bkt.clouddn.com/somefile.php\" };\n \n var result = cdnManager.RefreshUrls(urls);\n \n // 或者使用下面的方法\n //RefreshRequest request = new RefreshRequest();\n //request.AddUrls(urls);\n //var result = cdnMgr.RefreshUrlsAndDirs(request);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n## 目录刷新\n\n \n \n using System;\n using Qiniu.Util;\n using Qiniu.CDN;\n using Qiniu.CDN.Model;\n \n namespace CSharpSDKExamples\n {\n public class FusionDemo\n {\n /// <summary>\n /// 缓存刷新\n /// </summary>\n public void CdnRefresh()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n CdnManager cdnMgr = new CdnManager(mac);\n \n string[] dirs = new string[] { \"http://yourdomain.bkt.clouddn.com/\" };\n \n var result = cdnMgr.RefreshDirs(dirs);\n \n // 或者使用下面的方法\n //RefreshRequest request = new RefreshRequest();\n //request.AddDirs(dirs);\n //var result = cdnMgr.RefreshUrlsAndDirs(request);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n## 文件预取操作\n\n \n \n using System;\n using Qiniu.Util;\n using Qiniu.CDN;\n using Qiniu.CDN.Model;\n \n namespace CSharpSDKExamples\n {\n public class FusionDemo\n {\n /// <summary>\n /// 文件预取\n /// </summary>\n public void CdnPrefetch()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n CdnManager cdnMgr = new CdnManager(mac);\n \n string[] urls = new string[] { \"http://yourdomain.clouddn.com/somefile.php\" };\n \n var result = cdnMgr.PrefetchUrls(urls);\n \n // 或者使用下面的方法\n //PrefetchRequest request = new PrefetchRequest(urls);\n //var result = cdnMgr.PrefetchUrls(request);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n## 获取域名流量\n\n \n \n using System;\n using Qiniu.Util;\n using Qiniu.CDN;\n using Qiniu.CDN.Model;\n \n namespace CSharpSDKExamples\n {\n public class FusionDemo\n {\n /// <summary>\n /// 查询流量\n /// </summary>\n public void GetFluxData()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n CdnManager cdnMgr = new CdnManager(mac);\n \n FluxRequest request = new FluxRequest();\n request.StartDate = \"2016-09-01\";\n request.EndDate = \"2016-09-02\";\n request.Granularity = \"day\";\n request.Domains = \"DOMAIN1;DOMAIN2\";\n var result = cdnMgr.GetFluxData(request);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n## 获取域名带宽\n\n \n \n using System;\n using Qiniu.Util;\n using Qiniu.CDN;\n using Qiniu.CDN.Model;\n \n namespace CSharpSDKExamples\n {\n public class FusionDemo\n {\n /// <summary>\n /// 查询带宽\n /// </summary>\n public void GetBandwidthData()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n CdnManager cdnMgr = new CdnManager(mac);\n \n BandwidthRequest request = new BandwidthRequest();\n request.StartDate = \"2016-09-01\";\n request.EndDate = \"2016-09-20\";\n request.Granularity = \"day\";\n request.Domains = \"yourdomain.bkt.clouddn.com;yourdomain2;yourdomain3\";\n var result = cdnMgr.GetBandwidthData(request);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n## 获取日志列表\n\n可以获取一个或多个域名在某一天的日志列表（下载链接），参考如下示例：\n\n \n \n using System;\n using Qiniu.Util;\n using Qiniu.CDN;\n using Qiniu.CDN.Model;\n \n namespace CSharpSDKExamples\n {\n public class FusionDemo\n {\n /// <summary>\n /// 查询日志\n /// </summary>\n public void GetCdnLogList()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n CdnManager cdnMgr = new CdnManager(mac);\n \n LogListRequest request = new LogListRequest();\n request.Day = \"2016-09-01\"; // date:which-day\n request.Domains = \"DOMAIN1;DOMAIN2\"; // domains\n var result = cdnMgr.GetCdnLogList(request);\n \n Console.WriteLine(result);\n }\n }\n }\n \n\n## 构建时间戳防盗链访问链接\n\n \n \n using System;\n using Qiniu.Util;\n using Qiniu.CDN;\n using Qiniu.CDN.Model;\n \n namespace CSharpSDKExamples\n {\n public class FusionDemo\n {\n /// <summary>\n /// 生成时间戳防盗链接\n /// </summary>\n public void HotLink()\n {\n // 这个示例单独使用了一个Settings类，其中包含AccessKey和SecretKey\n // 实际应用中，请自行设置您的AccessKey和SecretKey\n Mac mac = new Mac(Settings.AccessKey, Settings.SecretKey);\n \n CdnManager cdnMgr = new CdnManager(mac);\n \n TimestampAntiLeechUrlRequest request = new TimestampAntiLeechUrlRequest();\n request.Host = \"http://your-host\";\n request.Path = \"/path/\";\n request.File = \"file-name\";\n request.Query = \"?version=1.1\";\n request.SetLinkExpire(600); // 设置有效期，单位:秒\n \n string prefLink = cdnMgr.CreateTimestampAntiLeechUrl(request);\n \n Console.WriteLine(prefLink);\n }\n }\n }\n \n\n# 使用案例\n\n在QSunSync和qiniulab这两个工具中，都用到了此SDK，研究它们的源代码也能帮助您更好地了解此SDK：\n\n[QSunSync](https://github.com/qiniu/QSunSync)，图形界面同步工具（Windows）\n\n[QiniuLab](https://github.com/qiniu/qiniulab)，图像界面实验工具，不用编写繁复的代码就可以测试七牛云的多项服务（Windows）\n\n# API参考手册\n\n * [对象存储API参考手册](https://developer.qiniu.com/kodo)\n\n * [数据处理API参考手册](https://developer.qiniu.com/dora)\n\n * [融合CDN加速API参考手册](https://developer.qiniu.com/fusion)\n\n# 常见问题\n\n更多使用方法。可以参考[QiniuTests](https://github.com/qiniu/csharp-\nsdk/blob/master/src/QiniuTests/Storage/BucketManagerTests.cs)下的示例。\n\n问题排查。在SDK的大多函数中(如果有)响应消息，可以反馈给我们进行问题排查。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎到我们的技术论坛参与讨论。\n\n * [技术论坛](http://segmentfault.com/qiniu) \\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n\n * [提交工单](http://support.qiniu.com/hc/request/guest/) \\- 如果您的问题不适合在论坛讨论或得不到回答，您也可以提交一个工单，技术支持人员会尽快回复您\n\n * [博客](http://blog.qiniu.com/) \\- 这里会持续发布市场活动和技术分享文章\n\n * [微博](http://weibo.com/qiniutek)\n\n * [常见问题](https://support.qiniu.com/)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am 'Added some feature'\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright (c) 2017 [qiniu.com](https://www.qiniu.com/)\n\n基于 MIT 协议发布:\n\n[www.opensource.org/licenses/MIT](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储C# SDK v7.0 文档"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [C#\nSDK](https://developer.qiniu.com/kodo/sdk/1237/csharp) > C# SDK v7.0 文档\n\n# C# SDK v7.0 文档\n\n最近更新时间: 2019-11-08 14:36:05\n\n\n\n此 C# SDK 适用于.NET Framework 2.0及以上版本，基于七牛云API参考手册构建。使用此 SDK\n构建您的网络应用程序，能让您以非常便捷地方式将数据安全地存储到七牛云存储上。无论您的网络应用是一个网站程序，还是包括从云端（服务端程序）到终端（手持设备应用）的架构的服务或应用，通过七牛云存储及其\nSDK，都能让您应用程序的终端用户高速上传和下载，同时也让您的服务端更加轻盈。\n\n# 安装\n\n## 源码下载\n\n \n \n https://github.com/qiniu/csharp-sdk\n \n\n## 添加引用\n\n获取编译好的qiniu.dll后，在项目中添加Qiniu.dll引用\n\n## NuGet安装\n\n直接从NuGet安装，搜索`qiniu`并选择7.3.x（如7.3.0）版本安装，或者在包管理器控制台键入以下命令：\n\n \n \n install-package qiniu -version=7.3.0\n \n\n## 附加依赖项\n\nC#\nSDK引用了第三方的开源项库[Json.NET](http://www.newtonsoft.com/json)因此，您需要在项目中引用它，或者使用NuGet安装\n\n \n \n Install-Package Newtonsoft.Json\n \n\n# 秘钥配置\n\n要接入七牛云存储，您需要拥有一对有效的 Access Key (以下简称AK) 和 Secret Key (以下简称SK) 用来进行签名认证。步骤如下：\n\n 1. 登录七牛开发者平台，查看 [AK 和 SK](https://portal.qiniu.com/user/key)，如果没有账号，可以开通一个[七牛开发者帐号](https://portal.qiniu.com/signup)\n\n 2. 在适当位置(比如程序中的settings模块)配置 AK & SK\n\n 3. 接下来就可以调用七牛API服务，如文件上传、数据处理等\n\n# SDK设置\n\n因为不同的空间(bucket)可能位于不同的机房(区域/Zone)，因此文件管理等操作需要正确配置Zone(位于Qiniu.Common命名空间)，默认配置为\"华东机房\"，用户可以有以下两种方法配置Zone:\n\n直接配置（ 如果确定机房所在Zone，可以使用此方法）:\n\n \n \n // XXX是其中之一: CN_East CN_South CN_North US_North\n Qiniu.Common.Config.ZONE = Qiniu.Common.Zone.ZONE_XXX();\n // 或者使用ZoneID (CN_East CN_South CN_North US_North)\n Qiniu.Common.Config.ConfigZone(zoneId);\n \n\n使用AutoZone自动配置（推荐使用这个方法）:\n\n \n \n // AK = ACCESS_KEY \n Qiniu.Common.Config.ConfigZoneAuto(AK,BUCKET);\n \n\n以下示例代码中没有特别指明有关Zone的设置，请特别注意。\n\n# 上传文件\n\n## 上传流程\n\n为了尽可能地改善终端用户的上传体验，七牛云存储首创了客户端直传功能。更多信息请参阅[业务流程](https://developer.qiniu.com/kodo/manual/programming-\nmodel)。\n\n## 普通上传\n\n推荐使用UploadManager，以下代码示意了如何使用UploadManager来上传一个本地文件（请注意Zone设置，下同）：\n\n \n \n using System;\n using Qiniu.Util;\n using Qiniu.Storage;\n using System.IO;\n \n namespace ConsoleDemo\n {\n class SimpleUploadDemo\n {\n public static void Main(string[] args)\n {\n string AK = \"ACCESS_KEY\";\n string SK = \"SECRET_KEY\";\n // 目标空间名\n string bucket = \"TARGET_BUCKET\";\n // 目标文件名\n string saveKey = \"SAVE_KEY\";\n // 本地文件\n string localFile = \"LOCAL_FILE\";\n \n // 上传策略\n PutPolicy putPolicy = new PutPolicy();\n // 设置要上传的目标空间\n putPolicy.Scope = bucket;\n // 上传策略的过期时间(单位:秒)\n putPolicy.SetExpires(3600);\n // 文件上传完毕后，在多少天后自动被删除\n putPolicy.DeleteAfterDays = 1;\n \n // 请注意这里的Zone设置(如果不设置，就默认为华东机房)\n // var zoneId = Qiniu.Common.AutoZone.Query(AK,BUCKET);\n // Qiniu.Common.Config.ConfigZone(zoneId);\n \n Mac mac = new Mac(AK,SK); // Use AK & SK here\n // 生成上传凭证\n string uploadToken = Auth.createUploadToken(putPolicy, mac);\n \n UploadOptions uploadOptions = null;\n \n // 上传完毕事件处理\n UpCompletionHandler uploadCompleted = new UpCompletionHandler(OnUploadCompleted);\n \n // 方式1：使用UploadManager\n //默认设置 Qiniu.Common.Config.PUT_THRESHOLD = 512*1024;\n //可以适当修改,UploadManager会根据这个阈值自动选择是否使用分片(Resumable)上传 \n UploadManager um = new UploadManager();\n um.uploadFile(localFile, saveKey, token, uploadOptions, uploadCompleted);\n \n // 方式2：使用FormManager\n //FormUploader fm = new FormUploader();\n //fm.uploadFile(localFile, saveKey, token, uploadOptions, uploadCompleted);\n \n Console.ReadKey();\n }\n \n private static void OnUploadCompleted(string key, ResponseInfo respInfo, string respJson)\n {\n // respInfo.StatusCode\n // respJson是返回的json消息，示例: { \"key\":\"FILE\",\"hash\":\"HASH\",\"fsize\":FILE_SIZE }\n }\n }\n }\n \n\n## 断点续上传\n\n实际上也是分片上传，使用ResumeUploader，参考如下示例：\n\n \n \n using System;\n using Qiniu.Util;\n using Qiniu.Storage;\n using System.IO;\n \n namespace ConsoleDemo\n {\n class ResumableUploadDemo\n {\n public static void Main(string[] args)\n {\n string AK = \"ACCESS_KEY\";\n string SK = \"SECRET_KEY\";\n string bucket = \"TARGET_BUCKET\";\n string saveKey = \"SAVE_KEY\";\n string localFile = \"LOCAL_FILE\";\n // 上传进度记录保存的目录\n string recordPath = \"RECORD_PATH\";\n // 上传进度保存为文件\n string recordFile = \"RECORD_FILE\";\n \n // 设置上传时的分片大小(单位为字节,已默认设置为2MB,不得大于4MB,一般保留默认即可)\n // Qiniu.Common.CHUNK_SIZE = N_CHUNK_SIZE;\n \n UploadOptions uploadOptions = new UploadOptions(\n null, // ExtraParams\n null, // MimeType\n false, // CheckCrc32\n new UpProgressHandler(OnUploadProgressChanged), // 上传进度\n null // CancelSignal\n );\n \n UpCompletionHandler uploadCompleted = new UpCompletionHandler(OnUploadCompleted); // 上传完毕\n \n // 上传时会将当前进度记录写到文件，下次可以“断点续传”\n ResumeRecorder rr = new ResumeRecorder(recordPath);\n // 开始上传\n ResumeUploader ru = new ResumeUploader(\n rr, // 续传记录\n recordFile, // 续传记录文件\n localFile, // 待上传的本地文件\n saveKey, // 要保存的文件名\n token, // 上传凭证\n uploadOptions, // 上传选项(其中包含进度处理)，可为null\n uploadCompleted // 上传完毕事件处理\n ); \n \n ru.uploadFile();\n Console.ReadKey();\n }\n \n private static void OnUploadProgressChanged(string key,double percent)\n {\n // percent = [0(开始)~1.0(完成)]\n }\n \n private static void OnUploadCompleted(string key,ResponseInfo respInfo,string respJson)\n {\n // respInfo.StatusCode\n // respJson是返回的json消息，示例: { \"key\":\"FILE\",\"hash\":\"HASH\",\"fsize\":FILE_SIZE }\n }\n }\n }\n \n\n**说明**\n\n可以使用UploadManager配合一个阈值(Qiniu.Common.PUT_THRESHOLD)让程序(SDK)自动选择使用简单上传(传适合于小文件)或者分片上传(传适合于大文件或者需要断点续上传)。分片上传/断点续上传使用ResumbaleUploader。\n\n使用此SDK上传文件需要注意：\n\n_上传域名_\n\n请设置`UploadFromCDN`参数(true/false)：\n\n \n \n // 不使用CDN\n Qiniu.Common.Config.UploadFromCDN = false; \n \n\n_关于UpCompletionHandler参数_\n\n1.上传方法(如uploadFile)中包含UploadOptions,UpCompletionHandler等参数，可以保持默认(设置null即可)，也可以自行设置\n\n2.UpCompletionHandler是**在上传完成后或者遇到错误(比如网络错误等)触发** ，其中会包含一些返回信息，可以在此进行处理\n\n_关于分片上传_\n\n1.分片上传时，片大小(Qiniu.Common.CHUNK_SIZE)可以在上传之前预先设置\n\n2.**CHUNK_SIZE必须为4MB或者4MB/n** ，默认已设置为2MB(可自行设置为512KB,1MB等)\n\n3.如果分片(chunk)较小，上传一个chunk的耗时更短，但整个文件需要被切分成更多的chunk\n\n4.如果chunk设置得太大，上传单个chunk可能会出现连接超时的问题\n\n5.使用ResumbaleUploader时，**上传不同的文件，请务必使用不同的recordPath/recordFile**\n，因为断点记录和上传文件是对应的\n\n# 文件下载\n\n## 公开空间文件下载\n\n直接访问外链即可下载。\n\n## 私有空间文件下载\n\n私有空间中的文件下载时，需要先**生成已授权的下载链接** ：\n\n生成授权下载链接 `ACC_URL = RAW_URL+Expire+Token`\n\n比如原始链接 `RAW_URL = http://example.com/file/1.jpg`\n\n加上过期时间戳(Expire)后 `http://example.com/file/1.jpg?e=1476783956`\n\n然后Auth生成Token拼接上去 `http://example.com/file/1.jpg?e=1476783956&token=<TOKEN>`\n\n如果原始链接中已包含·?·字符（如`http://xxx/1.jpg?query_what`），后面就不应该再次出现该字符，因此时间戳后缀应该是类似`&e=1476783956`这样的形式，最后的链接可能会是这样子`http://xxx/1.jpg?query_what&e=1476783956&token=<TOKEN>`\n\n示例代码\n\n \n \n using Qiniu.Util;\n // AK = \"ACCESS_KEY\"\n // SK = \"SECRET_KEY\"\n // 加上过期参数，使用 ?e=<UnixTimestamp>\n // 如果rawUrl中已包含?，则改用&e=<UnixTimestamp>\n // rawURL = \"RAW_URL\" + \"?e=1482207600\"; \n Mac mac = new Mac(AK,SK);\n string token = Auth.createDownloadToken(rawUrl, mac);\n string signedURL = rawURL + \"&token=\" + token;\n \n\n# 空间资源管理\n\n## 简单处理\n\n支持stat、copy、move、delete,listFiles等，具体使用方法可参阅[BucketFileManagemt.cs](https://github.com/qiniu/csharp-\nsdk/blob/master/src/QiniuTests/Storage/BucketManagerTests.cs)代码。\n\n## 获取空间文件列表\n\n在BucketManager类中提供了listFiles方法`listFiles(bucket, prefix, marker, limit,\ndelimiter)`.\n\n该方法返回值中，有以下3个字段需要关注：\n\n字段 | 含义 \n---|--- \nMarker | 请参阅下述的`marker`参数 \nItems | 返回的结果，其中包括文件名、hash、大小等信息 \nCommonPrefixes | 请参阅下述的`delimiter`和`prefix`参数 \n \n函数参数说明如下：\n\n参数 | 含义 \n---|--- \nbucket | 目标空间名称 \nprefix | 返回指定文件名前缀的文件列表(prefix可设为null) \nmarker | 考虑到设置limit后返回的文件列表可能不全(需要重复执行listFiles操作) 执行listFiles操作时使用marker标记来追加新的结果。**特别注意** 首次执行listFiles操作时marker为null \nlimit | 每次返回结果所包含的文件总数限制(limit<=1000， _建议值100_) \ndelimiter | 分隔符，比如-或者/等等，可以模拟作为目录结构(参考下述示例)。假设指定空间中有2个文件 fakepath/1.txt fakepath/2.txt 现设置delimiter=/ 得到结果items =[]，commonPrefixes = [fakepath/] 调整prefix=fakepath/ delimiter=null 得到所需结果items=[1.txt,2.txt] 于是可以在本地先创建一个目录fakepath,然后在该目录下写入items中的文件 \n \n以下是一个简单的示例：\n\n \n \n // AK = \"ACCESS_KEY\"\n // SK = \"SECRET_KEY\"\n Mac mac = new Mac(AK, SK);\n BucketManager bm = new BucketManager(mac);\n \n string bucket = \"BUCKET\"; // 目标空间\n string marker = \"\"; // 首次请求时marker必须为空\n string prefix = null; // 按文件名前缀保留搜索结果\n string delimiter = null; // 目录分割字符(比如\"/\")\n int limit = 100; // 最大值1000\n \n // 返回结果存储在items中\n List<FileDesc> items = new List<FileDesc>();\n \n // 由于limit限制，可能需要执行多次操作\n // 返回值中Marker字段若非空，则表示文件数超过了limit\n do\n {\n var result = bm.listFiles(bucket, prefix, marker, limit, delimiter);\n marker = result.Marker;\n if (result.Items != null)\n {\n items.AddRange(result.Items);\n }\n } while (!string.IsNullOrEmpty(marker));\n \n // 在这里处理文件列表items\n \n\n完整示例及其它更多代码可以参考SDK-v7.0的[examples目录](https://github.com/qiniu/csharp-\nsdk/tree/v7.0/examples)\n\n## 批量处理\n\nbatch批处理如下示例：\n\n \n \n // AK = ACCESS_KEY\n // SK = SECRET_KEY\n Mac mac = new Mac(AK, SK);\n // 批量操作类似于\n // op=<op1>&op=<op2>&op=<op3>...\n string batchOps = \"BATCH_OPS\";\n BucketManager bm = new BucketManager(mac);\n HttpResult result = bm.batch(batchOps);\n // 或者\n //string[] batch_ops={\"<op1>\",\"<op2>\",\"<op3>\",...};\n //bm.batch(batch_ops);\n //返回结果在这里result.Response\n \n\n可参考[examples/BucketManagement](https://github.com/qiniu/csharp-\nsdk/blob/master/src/QiniuTests/Storage/BucketManagerTests.cs)中的batch示例。\n\n# 持久化操作\n\n如`fops = vframe/jpg/offset/1/w/480/h/360/rotate/90` 表示视频截图。\n\n详细内容请参阅[持久化数据处理](https://developer.qiniu.com/dora/api/persistent-data-\nprocessing-pfop)文档。\n\n# API参考手册\n\n * [对象存储API参考手册](https://developer.qiniu.com/kodo)\n\n * [数据处理API参考手册](https://developer.qiniu.com/dora)\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎到我们的技术论坛参与讨论。\n\n * [技术论坛](http://segmentfault.com/qiniu) \\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n\n * [提交工单](http://support.qiniu.com/hc/request/guest/) \\- 如果您的问题不适合在论坛讨论或得不到回答，您也可以提交一个工单，技术支持人员会尽快回复您\n\n * [博客](http://blog.qiniu.com/) \\- 这里会持续发布市场活动和技术分享文章\n\n * [微博](http://weibo.com/qiniutek)\n\n * [常见问题](https://support.qiniu.com/)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am 'Added some feature'\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright (c) 2017 [qiniu.com](https://www.qiniu.com/)\n\n基于 MIT 协议发布:\n\n[www.opensource.org/licenses/MIT](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储C# SDK v6 文档"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [C#\nSDK](https://developer.qiniu.com/kodo/sdk/1237/csharp) > C# SDK v6 文档\n\n# C# SDK v6 文档\n\n最近更新时间: 2017-08-01 12:19:21\n\n\n\n此 C# SDK 适用于.net framework>2.0版本，基于 七牛云存储官方API 构建。使用此 SDK\n构建您的网络应用程序，能让您以非常便捷地方式将数据安全地存储到七牛云存储上。无论您的网络应用是一个网站程序，还是包括从云端（服务端程序）到终端（手持设备应用）的架构的服务或应用，通过七牛云存储及其\nSDK，都能让您应用程序的终端用户高速上传和下载，同时也让您的服务端更加轻盈。\n\n * 安装\n * 配置密钥\n * 资源管理\n * 获取单个文件属性信息\n * 复制单个文件\n * 移动单个文件\n * 删除单个文件\n * 批量操作\n * 批量获取文件属性信息\n * 批量复制文件\n * 批量移动文件\n * 批量删除文件\n * 获取空间文件列表\n * 文件上传\n * 上传策略\n * 普通上传\n * 断点续上传\n * 文件下载\n * 公有资源下载\n * 私有资源下载\n * 数据处理\n * 图像处理\n * 查看图像属性\n * 查看图片EXIF信息\n * 生成图片预览\n * 图片高级处理(缩略、裁剪、旋转、转化)\n * 图片水印\n * API参考手册\n * 贡献代码\n * 许可证\n\n# 安装\n\n## NuGet安装方式：\n\n如果您的Visual Studio没有安装NuGet，请先[安装](http://docs.nuget.org/docs/start-\nhere/installing-\nnuget)它,然后在项目中添加引用，使用NuGet管理程序包，在其中搜索qiniu并选择v6.x.x（版本代号，例如6.2.1.2）版本，或者在包管理器控制台输入：\n\n \n \n install-package qiniu -version=6.x.x\n \n\n## 源码下载:\n\n \n \n git clone https://github.com/qiniu/csharp-sdk/tree/v6\n \n\n## DLL引用方式:\n\n下载DLL文件，右键<项目>-<引用>文件夹，在弹出的菜单中点击\"添加引用\"选项后弹出\"添加引用\"对话框，选择”浏览\"Qiniu.DLL文件,点击确定\n\n## 项目引用方式：\n\n下载项目文件，右键解决方案，在弹出的菜单中点击\"添加\"->\"现有项目\"，然后在弹出的对话框中选择\nQiniu.csproj\"文件，点击确定。接下来与DLL引用方式类似，在\"添加引用”对话框选择\"项目\"选项卡后选中Qiniu项目即可。\n\n## 依赖项:\n\n此版本SDK引用了第三方的开源库[Json.NET](https://github.com/JamesNK/Newtonsoft.Json),因此，您需要在项目中引用它(如果使用NuGet管理dll，刚不需要手工加载Json.NET)\n\n# 配置密钥\n\n服务端使用。\n\n要接入七牛云存储，您需要拥有一对有效的 Access Key 和 Secret Key 用来进行签名认证。可以通过如下步骤获得：\n\n 1. [开通七牛开发者帐号](https://portal.qiniu.com/signup)\n 2. 登录[七牛开发者自助平台](https://portal.qiniu.com/setting/key)，查看 Access Key 和 Secret Key 。\n\n在获取到 Access Key 和 Secret Key 之后，您可以在您的程序中调用如下两行代码进行初始化对接, 要确保`ACCESS_KEY` 和\n`SECRET_KEY` 在调用所有七牛API服务之前均已赋值：\n\n \n \n using Qiniu.Conf;\n qiniu.conf.ACCESS_KEY = \"<YOUR_APP_ACCESS_KEY>\"\n qiniu.conf.SECRET_KEY = \"<YOUR_APP_SECRET_KEY>\"\n \n\n或者，编译配置文件app.conf或者web.conf等文件，添加以下配置项：\n\n \n \n <appSettings>\n <add key=\"USER_AGENT\" value=\"\" />\n <add key=\"ACCESS_KEY\" value=\"\" />\n <add key=\"SECRET_KEY\" value=\"\" />\n <add key=\"RS_HOST\" value=\"\" />\n <add key=\"UP_HOST\" value=\"\" />\n <add key=\"RSF_HOST\" value=\"\" />\n <add key=\"PREFETCH_HOST\" value=\"\" />\n </appSettings>\n \n\n添加完成后，在程序启动的时候调用`Qiniu.Conf.Config.Init()`进行初始化。\n\n# 资源管理\n\n服务端使用。\n\n基本的数据结构定义：\n\n \n \n // 摘要:\n // 对bucket、key进行封装\n public class EntryPath\n {\n public EntryPath(string bucket, string key);\n \n public string Base64EncodedURI { get; }\n //\n // 摘要:\n // 七牛云存储空间名\n public string Bucket { get; }\n //\n // 摘要:\n // 文件key\n public string Key { get; }\n //\n // 摘要:\n // bucket+ \":\"+ key\n public string URI { get; }\n }\n // 摘要:\n // 二元操作路径\n public class EntryPathPair\n {\n // 摘要:\n // 二元操作路径构造函数\n // 参数:\n // bucket:\n // 源空间名称，目标空间名称\n // keySrc:\n // 源文件key\n // keyDest:\n // 目标文件key\n public EntryPathPair(string bucket, string keySrc, string keyDest);\n //\n // 摘要:\n // 二元操作路径构造函数\n // 参数:\n // bucketSrc:\n // 源空间名称\n // keySrc:\n // 源文件key\n // bucketDest:\n // 目标空间名称\n // keyDest:\n // 目标文件key\n public EntryPathPair(string bucketSrc, string keySrc, string bucketDest, string keyDest);\n \n // 摘要:\n // bucketDest+\":\"+keyDest\n public string URIDest { get; }\n //\n // 摘要:\n // bucketSrc+\":\"+keySrc\n public string URISrc { get; }\n }\n \n\n## 获取单个文件属性信息\n\n \n \n using Qiniu.RS\n \n /// <summary>\n /// 查看单个文件属性信息\n /// </summary>\n /// <param name=\"bucket\">七牛云存储空间名</param>\n /// <param name=\"key\">文件key</param>\n public static void Stat(string bucket, string key)\n {\n RSClient client = new RSClient();\n Entry entry = client.Stat(new EntryPath(bucket, key));\n if (entry.OK)\n {\n Console.WriteLine(\"Hash: \" + entry.Hash);\n Console.WriteLine(\"Fsize: \" + entry.Fsize);\n Console.WriteLine(\"PutTime: \" + entry.PutTime);\n Console.WriteLine(\"MimeType: \" + entry.MimeType);\n Console.WriteLine(\"Customer: \" + entry.Customer);\n }\n else\n {\n Console.WriteLine(\"Failed to Stat\");\n }\n }\n \n\n## 复制单个文件\n\n \n \n /// <summary>\n /// 复制单个文件\n /// </summary>\n /// <param name=\"bucketSrc\">需要复制的文件所在的空间名</param>\n /// <param name=\"keySrc\">需要复制的文件key</param>\n /// <param name=\"bucketDest\">目标文件所在的空间名</param>\n /// <param name=\"keyDest\">标文件key</param>\n public static void Copy(string bucketSrc, string keySrc, string bucketDest, string keyDest)\n {\n RSClient client = new RSClient();\n CallRet ret = client.Copy(new EntryPathPair(bucketSrc, keySrc, bucketDest, keyDest));\n if (ret.OK)\n {\n Console.WriteLine(\"Copy OK\");\n }\n else\n {\n Console.WriteLine(\"Failed to Copy\");\n }\n }\n \n\n## 移动单个文件\n\n \n \n /// <summary>\n /// 移动单个文件\n /// </summary>\n /// <param name=\"bucketSrc\">需要移动的文件所在的空间名</param>\n /// <param name=\"keySrc\">需要移动的文件</param>\n /// <param name=\"bucketDest\">目标文件所在的空间名</param>\n /// <param name=\"keyDest\">目标文件key</param>\n public static void Move(string bucketSrc, string keySrc, string bucketDest, string keyDest)\n {\n Console.WriteLine(\"\\n===> Move {0}:{1} To {2}:{3}\", \n bucketSrc, keySrc, bucketDest, keyDest);\n RSClient client = new RSClient();\n new EntryPathPair(bucketSrc, keySrc, bucketDest, keyDest);\n CallRet ret = client.Move(new EntryPathPair(bucketSrc, keySrc, bucketDest, keyDest));\n if (ret.OK)\n {\n Console.WriteLine(\"Move OK\");\n }\n else\n {\n Console.WriteLine(\"Failed to Move\");\n }\n }\n \n\n## 删除单个文件\n\n \n \n /// <summary>\n /// 删除单个文件\n /// </summary>\n /// <param name=\"bucket\">文件所在的空间名</param>\n /// <param name=\"key\">文件key</param>\n public static void Delete(string bucket, string key)\n {\n Console.WriteLine(\"\\n===> Delete {0}:{1}\", bucket, key);\n RSClient client = new RSClient();\n CallRet ret = client.Delete(new EntryPath(bucket, key));\n if (ret.OK)\n {\n Console.WriteLine(\"Delete OK\");\n }\n else\n {\n Console.WriteLine(\"Failed to delete\");\n }\n }\n \n\n## 批量操作\n\n当您需要一次性进行多个操作时, 可以使用批量操作.\n\n批量获取文件属性信息:\n\n \n \n public static void BatchStat(string bucket, string[] keys)\n {\n RSClient client = new RSClient();\n List<EntryPath> EntryPaths= new List<EntryPath>();\n foreach(string key in keys)\n {\n Console.WriteLine(\"\\n===> Stat {0}:{1}\", bucket, key);\n EntryPaths.Add(new EntryPath(bucket,key));\n }\n client.BatchStat(EntryPaths.ToArray()); \n }\n \n\n批量复制文件:\n\n \n \n public static void BatchCopy(string bucket, string[] keys)\n {\n List<EntryPathPair> pairs = new List<EntryPathPair>();\n foreach (string key in keys)\n {\n EntryPathPair entry = new EntryPathPair(bucket, key, Guid.NewGuid().ToString());\n pairs.Add(entry);\n }\n RSClient client = new RSClient();\n client.BatchCopy(pairs.ToArray());\n }\n \n\n批量移动文件:\n\n \n \n public static void BatchMove(string bucket, string[] keys)\n {\n List<EntryPathPair> pairs = new List<EntryPathPair>();\n foreach (string key in keys)\n {\n EntryPathPair entry = new EntryPathPair(bucket, key, Guid.NewGuid().ToString());\n pairs.Add(entry);\n }\n RSClient client = new RSClient();\n client.BatchMove(pairs.ToArray());\n }\n \n\n批量删除文件\n\n \n \n public static void BatchDelete(string bucket, string[] keys)\n {\n RSClient client = new RSClient();\n List<EntryPath> EntryPaths = new List<EntryPath>();\n foreach (string key in keys)\n {\n Console.WriteLine(\"\\n===> Stat {0}:{1}\", bucket, key);\n EntryPaths.Add(new EntryPath(bucket, key));\n }\n client.BatchDelete(EntryPaths.ToArray());\n }\n \n\n## 获取文件列表\n\n服务端使用。\n\n资源列表接口允许用户列出空间下的所有文件信息。使用资源列表接口如果引入Qiniu.RSF命名空间。\n\n \n \n using Qiniu.RSF;\n RSFClient client = new RSFClient();\n client.listPrifix(\"<bucketName>\", \"<prefix>\", \"<marker>\", 500);\n \n\n或者,\n\n \n \n public static void List (string bucket)\n {\n RSF.RSFClient rsf = new Qiniu.RSF.RSFClient(bucket);\n rsf.Prefix = \"test\";\n rsf.Limit = 100;\n List<DumpItem> items;\n while ((items=rsf.Next())!=null)\n {\n //todo\n }\n }\n \n\n# 文件上传\n\n服务端或客户端使用。\n\n## 上传策略\n\nPutPolicy类用于定制上传策略，关于上传策略完整的说明，请参考[上传策略（PutPolicy）](https://developer.qiniu.com/kodo/manual/put-\npolicy)。\n\nuptoken 实际上是用 AccessKey/SecretKey对上传策略进行数字签名的字符串,用于上传接口。\n\n \n \n string bucketName = \"test\";\n PutPolicy put = new PutPolicy(bucketName);\n string uptoken = put.Token();\n \n\n文件上传有两种方式，一种是以普通方式直传文件，简称普通上传，另一种方式是断点续上传，断点续上传在网络条件很一般的情况下也能有出色的上传速度，而且对大文件的传输非常友好。\n\n## 普通上传\n\n普通上传的接口在 `qiniu.io` 里，如下：\n\n上传本地文件\n\n \n \n /// <summary>\n /// 上传文件测试\n /// </summary>\n /// <param name=\"bucket\"></param>\n /// <param name=\"key\"></param>\n /// <param name=\"fname\"></param>\n public static void PutFile(string bucket, string key, string fname)\n {\n var policy = new PutPolicy(bucket, 3600);\n string upToken = policy.Token();\n PutExtra extra = new PutExtra ();\n IOClient client = new IOClient();\n client.PutFile(upToken, key, fname, extra);\n }\n \n\n**注意： key必须采用utf8编码，如使用非utf8编码访问七牛云存储将反馈错误**\n\n## 断点续上传\n\n上传本地文件,示例如下:\n\n \n \n public static void ResumablePutFile(string bucket, string key, string fname)\n {\n Console.WriteLine(\"\\n===> ResumablePutFile {0}:{1} fname:{2}\", bucket, key, fname);\n PutPolicy policy = new PutPolicy(bucket, 3600);\n string upToken = policy.Token();\n Settings setting = new Settings();\n ResumablePutExtra extra = new ResumablePutExtra();\n ResumablePut client = new ResumablePut(setting, extra);\n client.PutFile(upToken, fname, Guid.NewGuid().ToString());\n }\n \n\nResumablePut采用分快上传，各快之间采用并行上传,可以通过注册ResumablePutExtra以下两个事件监听当前上传进度以及成功情况：\n\n \n \n public event EventHandler<PutNotifyEvent> Notify;\n public event EventHandler<PutNotifyErrorEvent> NotifyErr;\n \n\n# 文件下载\n\n七牛云存储上的资源下载分为 公有资源下载 和 私有资源下载 。\n\n私有（private）是 Bucket（空间）的一个属性，一个私有 Bucket 中的资源为私有资源，私有资源不可匿名下载。\n\n新创建的空间（Bucket）缺省为私有，也可以将某个 Bucket 设为公有，公有 Bucket 中的资源为公有资源，公有资源可以匿名下载。\n\n## 公有资源下载\n\n如果在给bucket绑定了域名的话，可以通过以下地址访问。\n\n \n \n [GET] http://<domain>/<key>\n \n\n其中是bucket所对应的域名。七牛云存储为每一个bucket提供一个默认域名。默认域名可以到[七牛云存储开发者平台](https://portal.qiniu.com/)中，空间设置的域名设置一节查询。用户也可以将自有的域名绑定到bucket上，用户可以通过自有域名访问七牛云存储。\n\n**注意： key必须采用utf8编码，如使用非utf8编码访问七牛云存储将返回错误**\n\n## 私有资源下载\n\n私有资源必须通过临时下载授权凭证(downloadToken)下载，如下：\n\n \n \n [GET] http://<domain>/<key>?e=<deadline>&token=<downloadToken>\n \n\n注意，尖括号不是必需，代表替换项.\n\n私有下载链接可以使用 SDK 提供的如下方法生成：\n\n \n \n using Qiniu.RS;\n public static void MakeGetToken(string domain, string key)\n {\n string baseUrl = GetPolicy.MakeBaseUrl(domain, key);\n string private_url = GetPolicy.MakeRequest(baseUrl);\n }\n \n\n# 数据处理\n\n服务端或客户端使用。\n\n七牛支持在云端对图像, 视频, 音频等富媒体进行个性化处理。使用数据处理接口需要引入Qiniu.FileOp命名空间。\n\n \n \n using Qiniu.FileOp;\n \n\n## 图像处理\n\n查看图像属性\n\n \n \n string domain = \"domain\";\n string key = key;\n Console.WriteLine(\"\\n===> FileOp.ImageInfo\");\n //生成base_url\n string url = Qiniu.RS.GetPolicy.MakeBaseUrl(domian, key);\n //生成fop_url\n string imageInfoURL = ImageInfo.MakeRequest(url);\n //对其签名，生成private_url。如果是公有bucket此步可以省略\n imageInfoURL = GetPolicy.MakeRequest(imageInfoURL);\n ImageInfoRet infoRet = ImageInfo.Call(imageInfoURL);\n if (infoRet.OK)\n {\n Console.WriteLine(\"Format: \" + infoRet.Format);\n Console.WriteLine(\"Width: \" + infoRet.Width);\n Console.WriteLine(\"Heigth: \" + infoRet.Height);\n Console.WriteLine(\"ColorModel: \" + infoRet.ColorModel);\n }\n else\n {\n Console.WriteLine(\"Failed to ImageInfo\");\n }\n \n\n查看图片EXIF信息\n\n \n \n string exifURL = Exif.MakeRequest(url);\n ExifRet exifRet = Exif.Call(exifURL);\n if (exifRet.OK)\n {\n Console.WriteLine(\"ApertureValue.val: \" + exifRet[\"ApertureValue\"].val);\n Console.WriteLine(\"ApertureValue.type: \" + exifRet[\"ApertureValue\"].type.ToString());\n Console.WriteLine(\"ExifInfo: \" + exifRet.ToString());\n }\n else\n {\n Console.WriteLine(\"Failed to ImageExif\");\n }\n \n\n生成图片预览\n\n \n \n ImageView imageView = new ImageView { Mode = 0, Width = 200, Height = 200, Quality = 90, Format = \"gif\" };\n string viewUrl = imageView.MakeRequest(url);\n viewUrl = GetPolicy.MakeRequest(viewUrl);\n Console.WriteLine(\"ImageViewURL:\" + viewUrl);\n \n\n图片高级处理(缩略、裁剪、旋转、转化)\n\n \n \n ImageMogrify imageMogr = new ImageMogrify\n {\n Thumbnail = \"!50x50r\",\n Gravity = \"center\",\n Rotate = 90,\n Crop = \"!50x50\",\n Quality = 80,\n AutoOrient = true\n };\n string mogrUrl = imageMogr.MakeRequest(url);\n mogrUrl = GetPolicy.MakeRequest(mogrUrl);\n Console.WriteLine(\"ImageMogrifyURL:\" + mogrUrl);\n \n\n图片水印\n\n \n \n //文字水印\n WaterMarker marker = new TextWaterMarker(\"hello,qiniu cloud!\",\"\",\"red\");\n string MarkerUrl = marker.MakeRequest(url);\n //图片水印\n marker = new ImageWaterMarker(\"http://www.b1.qiniudn.com/images/logo-2.png\");\n MarkerUrl = marker.MakeRequest(url);\n \n\n# API参考手册\n\n * [对象存储API参考手册](https://developer.qiniu.com/kodo)\n\n * [数据处理API参考手册](https://developer.qiniu.com/dora)\n\n * [融合CDN加速API参考手册](https://developer.qiniu.com/fusion)\n\n# 贡献代码\n\n 1. Fork\n 2. 创建您的特性分支 (`git checkout -b my-new-feature`)\n 3. 提交您的改动 (`git commit -am 'Added some feature'`)\n 4. 将您的修改记录提交到远程 `git` 仓库 (`git push origin my-new-feature`)\n 5. 然后到 github 网站的该 `git` 远程仓库的 `my-new-feature` 分支下发起 Pull Request\n\n# 许可证\n\nCopyright (c) 2017 [qiniu.com](https://www.qiniu.com/)\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Flutter SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > Flutter SDK\n\n# Flutter SDK\n\n最近更新时间: 2022-06-22 16:03:06\n\nFlutter SDK 只包含了最终用户使用场景中的必要功能。相比服务端 SDK 而言，客户端 SDK 不会包含对云存储服务的管理和配置功能。\n\n * [Flutter SDK 源码地址 __](https://github.com/qiniu/dart-sdk/blob/master/flutter/README.md)\n * [Flutter SDK 下载地址 __](https://github.com/qiniu/dart-sdk/releases)\n\n# 安全机制\n\n该 SDK 未包含凭证生成相关的功能。开发者对安全性的控制应遵循\n[安全机制](https://developer.qiniu.com/kodo/manual/1644/security)\n中建议的做法，即客户端应向业务服务器每隔一段时间请求\n[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token) ，而不是直接在客户端使用\nAccessKey / SecretKey 生成对应的凭证。在客户端使用 SecretKey 会导致严重的安全隐患。\n\n开发者可以在生成上传凭证前通过配置 [上传策略](https://developer.qiniu.com/kodo/manual/1206/put-\npolicy) 来控制上传的后续动作，例如在上传完成后通过回调机制通知业务服务器。该工作在业务服务器端进行，因此非本 SDK 的功能范畴。\n\n存储的服务端 SDK 提供了上传凭证的生成功能，请参考各个服务端语言的 SDK 文档。\n\n# 安装\n\n编辑你的 pubspec.yaml 文件，在 dependencies 添加 qiniu-flutter-sdk，如下：\n\n \n \n dependencies:\n ...\n qiniu_flutter_sdk: // 这里输入你需要的版本\n \n\n推荐使用最新版：v0.1.0\n\n# 上传文件\n\nSDK 内置两种上传方式：表单上传和分片上传，并根据具体情况，内部做了自动切换。表单上传使用一个 HTTP POST\n请求完成文件的上传，因此比较适合较小的文件和较好的网络环境。相比而言，分片上传更能适应不稳定的网络环境，也比较适合上传比较大的文件（例如数百 MB\n或更大）。\n\n若需深入了解上传方式之间的区别，请参阅上传类型中\n[表单上传](https://developer.qiniu.com/kodo/manual/1272/form-upload) 和 [分片上传\nV2](https://developer.qiniu.com/kodo/api/6364/multipartupload-interfaced)\n接口说明。\n\n \n \n import 'package:qiniu_flutter_sdk/qiniu_flutter_sdk.dart';\n // 创建 storage 对象\n storage = Storage();\n \n // 创建 Controller 对象\n putController = PutController();\n \n // 添加任务进度监听\n putController.onProgress((double percent) {\n print('任务进度变化：已发送：$percent');\n });\n \n // 添加文件发送进度监听\n putController.onSendProgress((double percent) {\n print('已上传进度变化：已发送：$percent');\n });\n \n // 添加任务状态监听\n putController.addStatusListener((StorageStatus status) {\n print('状态变化: 当前任务状态：$status');\n });\n \n // 指定上传对象key\n key = '指定object名称';\n \n // 使用 storage 的 putFile 对象进行文件上传\n storage.putFile(File('./file.txt'), 'TOKEN', PutOptions(\n controller: putController,\n key: key,\n ))\n // 取消当前任务\n putController.cancel()\n \n\n**storage** \n使用前必须创建一个 Storage 实例。同时，在构造 Storage 时可以传入一个 Config 控制内部的一些行为，如下\n\n \n \n // 创建 storage 对象\n storage = Storage(Config(\n // 通过自己的 hostProvider 来使用自己的 host 进行上传\n hostProvider: HostProvider,\n // 可以通过实现 cacheProvider 来自己实现缓存系统支持分片断点续传\n cacheProvider: CacheProvider,\n // 如果你需要对网络请求进行更基础的一些操作，你可以实现自己的 HttpClientAdapter 处理相关行为\n httpClientAdapter: HttpClientAdapter,\n // 设定网络请求重试次数\n retryLimit: 3,\n ));\n \n\n**PutController** \n这里是一个重要的内容，对于整个上传任务的一些交互被封装到了这里， PutController 用于对上传任务添加进度、状态的监听，同时可以通过\nPutController.cancel() 对正在上传的任务进行取消，使用姿势参考上面代码示例。 \n**putFile** \n该接口内部封装了分片上传和表单上传两种实现，会根据文件的尺寸和上传配置信息自动选择使用分片还是直传的方式来上传对象。File指定上传对象本地路径，Token为上传凭证。 \n**PutOptions** \nSDK默认在对象大小超过4MB使用分片上传，默认分片之间采用并发上传，并发大小为5，可以通过PutOptions中的参数控制，参数如下：\n\n \n \n class PutOptions {\n /// 资源名，如果不传则后端自动生成\n final String key;\n \n /// 强制使用直传，不使用分片\n final bool forceBySingle;\n \n /// 使用分片上传时的分片大小，默认值 4，单位为 MB\n final int partSize;\n \n /// 并发上传的队列长度，默认值为 5\n final int maxPartsRequestNumber;\n \n /// 控制器\n final PutController controller;\n }\n \n\n**其他** \n_**HostProvider**_ \nSDK 会根据 TOKEN 自动获取上传域名，不需要客户关系上传域名，除非你使用的是七牛的专有云服务，则可以通过实现自己的 HostProvider\n来向自己的服务进行上传。 \n_**CacheProvider**_ \nSDK 支持分片断点续传功能，断点续传的信息通过 CacheProvider\n提供的能力进行存储，如果你需要更好的体验，可以自己实现这个接口来对信息进行持久化的存储。 \n_**HttpClientAdapter**_ \n如果你需要对网络请求进行进一步的自定义处理时，你可以通过实现一个 HttpClientAdapter 来接管 SDK 的所有请求。\n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n\n# 贡献代码\n\n 1. 登录 https://github.com\n 2. Fork [email protected]:qiniu/dart-sdk.git\n 3. 创建您的特性分支 (git checkout -b new-feature)\n 4. 提交您的改动 (git commit -am ‘Added some features or fixed a bug’)\n 5. 将您的改动记录提交到远程 git 仓库 (git push origin new-feature)\n 6. 然后到 github 网站的该 git 远程仓库的 new-feature 分支下发起 Pull Request\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Go SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > Go SDK\n\n# Go SDK\n\n最近更新时间: 2024-01-10 17:43:00\n\n# 简介\n\n此 SDK 适用于 Go 1.10.0 及以上版本。使用此 SDK\n构建您的网络应用程序，能让您以非常便捷的方式将数据安全地存储到七牛云上。无论您的网络应用是一个网站程序，还是包括从云端（服务端程序）到终端（手持设备应用）的架构服务和应用，通过七牛云及其\nSDK，都能让您应用程序的终端用户高速上传和下载，同时也让您的服务端更加轻盈。\n\nGo SDK 属于七牛服务端SDK之一，主要有如下功能：\n\n 1. 提供生成客户端上传所需的上传凭证的功能\n 2. 提供文件从服务端直接上传七牛的功能\n 3. 提供对七牛空间中文件进行管理的功能\n 4. 提供对七牛空间中文件进行处理的功能\n 5. 提供七牛CDN相关的刷新，预取，日志功能\n 6. 提供七牛视频监控QVS的功能\n\n# 开源\n\n * [Go SDK 项目地址 __](https://github.com/qiniu/go-sdk)\n * [Go SDK 发布地址 __](https://github.com/qiniu/go-sdk/releases)\n * [Go SDK 历史文档](https://developer.qiniu.com/kodo/sdk/go-v6)\n\n# 安装\n\n推荐使用 go mod , `github.com/qiniu/go-sdk/v7` ，如 `require github.com/qiniu/go-\nsdk/v7 v7.19.0` ；\n\n# 鉴权\n\nGo SDK 的所有的功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的`Access Key`和`Secret\nKey`，这对密钥可以通过如下步骤获得：\n\n 1. 点击[注册🔗 __](https://portal.qiniu.com/signup)开通 七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里🔗 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n# 文件上传\n\n * 上传流程\n * 客户端上传凭证\n * 简单上传凭证\n * 覆盖上传凭证\n * 自定义上传回复凭证\n * 带回调业务服务器的凭证\n * 带数据处理的凭证\n * 带自定义参数的凭证\n * 综合上传凭证\n * 服务器直传\n * 构建配置类\n * 文件上传（表单方式）\n * 字节数组上传（表单方式）\n * 数据流上传（表单方式）\n * 文件分片上传（断点续传）\n * 解析自定义回复内容\n * 业务服务器验证存储服务回调\n\n## 上传流程\n\n文件上传分为客户端上传（主要是指网页端和移动端等面向终端用户的场景）和服务端上传两种场景，具体可以参考文档[业务流程](https://developer.qiniu.com/kodo/manual/1205/programming-\nmodel)。\n\n服务端SDK在上传方面主要提供两种功能，一种是生成客户端上传所需要的上传凭证，另外一种是直接上传文件到云端。\n\n## 客户端上传凭证\n\n客户端（移动端或者Web端）上传文件的时候，需要从客户自己的业务服务器获取上传凭证，而这些上传凭证是通过服务端的SDK来生成的，然后通过客户自己的业务API分发给客户端使用。根据上传的业务需求不同，七牛云\nGo SDK支持丰富的上传凭证生成方式。\n\n \n \n // 存储相关功能的引入包只有这两个，后面不再赘述\n import (\n \t\"github.com/qiniu/go-sdk/v7/auth\"\n \"github.com/qiniu/go-sdk/v7/storage\"\n )\n \n accessKey := \"your access key\"\n secretKey := \"your secret key\"\n mac := auth.New(accessKey, secretKey)\n \n\n## 简单上传的凭证\n\n最简单的上传凭证只需要`AccessKey`，`SecretKey`和`Bucket`就可以。\n\n \n \n bucket:=\"your bucket name\"\n putPolicy := storage.PutPolicy{\n \t\tScope: bucket,\n }\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n\n默认情况下，在不指定上传凭证的有效时间情况下，默认有效期为1个小时。也可以自行指定上传凭证的有效期，例如：\n\n \n \n //自定义凭证有效期（示例2小时，Expires 单位为秒，为上传凭证的有效时间）\n bucket := \"your bucket name\"\n \n putPolicy := storage.PutPolicy{\n \tScope: bucket,\n }\n putPolicy.Expires = 7200 //示例2小时有效期\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n\n## 覆盖上传的凭证\n\n覆盖上传除了需要`简单上传`所需要的信息之外，还需要想进行覆盖的文件名称，这个文件名称同时可是客户端上传代码中指定的文件名，两者必须一致。\n\n \n \n bucket := \"your bucket name\"\n \n // 需要覆盖的文件名\n keyToOverwrite := \"qiniu.mp4\"\n putPolicy := storage.PutPolicy{\n \tScope: fmt.Sprintf(\"%s:%s\", bucket, keyToOverwrite),\n }\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n\n## 自定义上传回复的凭证\n\n默认情况下，文件上传到七牛之后，在没有设置`returnBody`或者`回调`相关的参数情况下，七牛返回给上传端的回复格式为`hash`和`key`，例如：\n\n \n \n {\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"key\":\"qiniu.jpg\"}\n \n\n有时候我们希望能自定义这个返回的JSON格式的内容，可以通过设置`returnBody`参数来实现，在`returnBody`中，我们可以使用七牛支持的[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)和[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)。\n\n \n \n bucket := \"your bucket name\"\n \n putPolicy := storage.PutPolicy{\n \tScope: bucket,\n \tReturnBody: `{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\"}`,\n }\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n\n则文件上传到七牛之后，收到的回复内容格式如下：\n\n \n \n {\"key\":\"github-x.png\",\"hash\":\"FqKXVdTvIx_mPjOYdjDyUSy_H1jr\",\"fsize\":6091,\"bucket\":\"if-pbl\",\"name\":\"github logo\"}\n \n\n对于上面的自定义返回值，我们需要自定义结构体来解析这个回复，例如下面提供了一个解析结果的方法：\n\n \n \n // 自定义返回值结构体\n type MyPutRet struct {\n \tKey string\n \tHash string\n \tFsize int\n \tBucket string\n \tName string\n }\n \n localFile := \"your local file path\"\n bucket := \"your bucket name\"\n key := \"your file save key\"\n \n // 使用 returnBody 自定义回复格式\n putPolicy := storage.PutPolicy{\n \tScope: bucket,\n \tReturnBody: `{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\"}`,\n }\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n cfg := storage.Config{}\n formUploader := storage.NewFormUploader(&cfg)\n ret := MyPutRet{}\n putExtra := storage.PutExtra{\n \tParams: map[string]string{\n \t\t\"x:name\": \"github logo\",\n \t},\n }\n err := formUploader.PutFile(context.Background(), &ret, upToken, key, localFile, &putExtra)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Println(ret.Bucket, ret.Key, ret.Fsize, ret.Hash, ret.Name)\n \n\n## 带回调业务服务器的凭证\n\n上面生成的`自定义上传回复`的上传凭证适用于上传端（无论是客户端还是服务端）和七牛服务器之间进行直接交互的情况下。在客户端上传的场景之下，有时候客户端需要在文件上传到七牛之后，从业务服务器获取相关的信息，这个时候就要用到七牛的上传回调及相关回调参数的设置。\n\n \n \n putPolicy := storage.PutPolicy{\n \tScope: bucket,\n \tCallbackURL: \"http://api.example.com/qiniu/upload/callback\",\n \tCallbackBody: `{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\"}`,\n \tCallbackBodyType: \"application/json\",\n }\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n\n在使用了上传回调的情况下，客户端收到的回复就是业务服务器响应七牛的JSON格式内容，业务服务器收到回调之后必须响应JSON格式的回复給七牛，这个回复会被七牛传递给客户端。 \n例如上面的 `CallbackBody` 的设置会在文件上传到七牛之后，触发七牛回调如下内容給业务服务器：\n\n \n \n {\"key\":\"github-x.png\",\"hash\":\"FqKXVdTvIx_mPjOYdjDyUSy_H1jr\",\"fsize\":6091,\"bucket\":\"if-pbl\",\"name\":\"github logo\"}\n \n\n通常情况下，我们建议使用`application/json`格式来设置`callbackBody`，保持数据格式的统一性。实际情况下，`callbackBody`也支持`application/x-www-\nform-urlencoded`格式来组织内容，这个主要看业务服务器在接收到`callbackBody`的内容时如何解析。例如：\n\n \n \n putPolicy := storage.PutPolicy{\n \tScope: bucket,\n \tCallbackURL: \"http://api.example.com/qiniu/upload/callback\",\n \tCallbackBody: \"key=$(key)&hash=$(etag)&bucket=$(bucket)&fsize=$(fsize)&name=$(x:name)\",\n }\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n\n## 带数据处理的凭证\n\n七牛支持在文件上传到七牛之后，立即对其进行多种指令的数据处理，这个只需要在生成的上传凭证中指定相关的处理参数即可。\n\n \n \n saveMp4Entry := base64.URLEncoding.EncodeToString([]byte(bucket + \":avthumb_test_target.mp4\"))\n saveJpgEntry := base64.URLEncoding.EncodeToString([]byte(bucket + \":vframe_test_target.jpg\"))\n //数据处理指令，支持多个指令\n avthumbMp4Fop := \"avthumb/mp4|saveas/\" + saveMp4Entry\n vframeJpgFop := \"vframe/jpg/offset/1|saveas/\" + saveJpgEntry\n \n //连接多个操作指令\n persistentOps := strings.Join([]string{avthumbMp4Fop, vframeJpgFop}, \";\")\n pipeline := \"test\"\n \n putPolicy := storage.PutPolicy{\n \tScope: bucket,\n \tPersistentOps: persistentOps,\n \tPersistentPipeline: pipeline,\n \tPersistentNotifyURL: \"http://api.example.com/qiniu/pfop/notify\",\n }\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n\n队列 pipeline 请参阅[创建私有队列 __](https://portal.qiniu.com/dora/media-\ngate/pipeline)；转码操作具体参数请参阅[音视频转码](https://developer.qiniu.com/dora/api/audio-\nand-video-transcoding-avthumb)；saveas\n请参阅[处理结果另存](https://developer.qiniu.com/dora/api/processing-results-save-\nsaveas)。\n\n## 带自定义参数的凭证\n\n存储支持客户端上传文件的时候定义一些自定义参数，这些参数可以在`returnBody`和`callbackBody`里面和七牛内置支持的魔法变量（即系统变量）通过相同的方式来引用。这些自定义的参数名称必须以`x:`开头。例如客户端上传的时候指定了自定义的参数`x:name`和`x:age`分别是`string`和`int`类型。那么可以通过下面的方式引用：\n\n \n \n putPolicy := storage.PutPolicy{\n \t//其他上传策略参数...\n \tReturnBody: `{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\",\"age\":$(x:age)}`,\n }\n \n\n或者\n\n \n \n putPolicy := storage.PutPolicy{\n \t//其他上传策略参数...\n \tCallbackBody: `{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\",\"age\":$(x:age)}`,\n }\n \n\n## 综合上传凭证\n\n上面的生成上传凭证的方法，都是通过设置[上传策略🔗](https://developer.qiniu.com/kodo/manual/1206/put-\npolicy)相关的参数来支持的，这些参数可以通过不同的组合方式来满足不同的业务需求，可以灵活地组织你所需要的上传凭证。\n\n## 服务端直传\n\n服务端直传是指客户利用七牛服务端SDK从服务端直接上传文件到七牛云，交互的双方一般都在机房里面，所以服务端可以自己生成上传凭证，然后利用SDK中的上传逻辑进行上传，最后从七牛云获取上传的结果，这个过程中由于双方都是业务服务器，所以很少利用到上传回调的功能，而是直接自定义`returnBody`来获取自定义的回复内容。\n\n## 构建配置类\n\n存储支持空间创建在不同的机房，在使用七牛的 Go SDK\n中的`FormUploader`和`ResumeUploaderV2`上传文件之前，必须要构建一个上传用的`Config`对象，在该对象中，可以指定空间对应的`Zone`(如不指定Zone则会使用自动判断区域)以及其他的一些影响上传的参数。\n\n \n \n cfg := storage.Config{}\n \n // 空间对应的机房\n cfg.Region = &storage.ZoneHuadong\n // 是否使用https域名\n cfg.UseHTTPS = true\n // 上传是否使用CDN上传加速\n cfg.UseCdnDomains = false\n \n\n其中关于`Region`对象和机房的关系如下：\n\n机房 | Region 对象 \n---|--- \n华东 | `storage.ZoneHuadong` \n华东浙江 2 区 | `storage.ZoneHuadongZheJiang2` \n华北 | `storage.ZoneHuabei` \n华南 | `storage.ZoneHuanan` \n北美 | `storage.ZoneBeimei` \n新加坡 | `storage.ZoneXinjiapo` \n亚太首尔 1 区 | `storage.ZoneShouEr1` \n \n## 文件上传（表单方式）\n\n最简单的就是上传本地文件，直接指定文件的完整路径即可上传。\n\n \n \n localFile := \"/Users/jemy/Documents/github.png\"\n bucket := \"if-pbl\"\n key := \"github-x.png\"\n \n putPolicy := storage.PutPolicy{\n \tScope: bucket,\n }\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n cfg := storage.Config{}\n // 空间对应的机房\n cfg.Region = &storage.ZoneHuadong\n // 是否使用https域名\n cfg.UseHTTPS = true\n // 上传是否使用CDN上传加速\n cfg.UseCdnDomains = false\n \n // 构建表单上传的对象\n formUploader := storage.NewFormUploader(&cfg)\n ret := storage.PutRet{}\n \n // 可选配置\n putExtra := storage.PutExtra{\n \tParams: map[string]string{\n \t\t\"x:name\": \"github logo\",\n \t},\n }\n err := formUploader.PutFile(context.Background(), &ret, upToken, key, localFile, &putExtra)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Println(ret.Key,ret.Hash)\n \n\n## 字节数组上传（表单方式）\n\n可以支持将内存中的字节数组上传到空间中。\n\n \n \n putPolicy := storage.PutPolicy{\n \t\tScope: bucket,\n }\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n cfg := storage.Config{}\n // 空间对应的机房\n cfg.Region = &storage.ZoneHuadong\n // 是否使用https域名\n cfg.UseHTTPS = true\n // 上传是否使用CDN上传加速\n cfg.UseCdnDomains = false\n \n formUploader := storage.NewFormUploader(&cfg)\n ret := storage.PutRet{}\n putExtra := storage.PutExtra{\n \tParams: map[string]string{\n \t\t\"x:name\": \"github logo\",\n \t},\n }\n \n data := []byte(\"hello, this is qiniu cloud\")\n dataLen := int64(len(data))\n err := formUploader.Put(context.Background(), &ret, upToken, key, bytes.NewReader(data), dataLen, &putExtra)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Println(ret.Key, ret.Hash)\n \n\n## 数据流上传（表单方式）\n\n`io.Reader`对象的上传也是采用`Put`方法或者`PutWithoutKey`方法，使用方式和上述的 `字节数组上传` 方式相同。\n\n## 文件分片上传\n\n对于大的文件，我们一般推荐使用分片上传的方式来上传文件，[分片上传\nv2](https://developer.qiniu.com/kodo/api/6364/multipartupload-\ninterface)通过将一个文件切割为块，然后通过上传块的方式来进行文件的上传。服务端SDK中默认块大小为4MB，支持根据条件设置块大小（要求除最后一块外，其他块大于等于1MB，小于等于1G），块与块之间可以并发上传，以提高上传效率。分片上传不等于断点续传，但是分片上传可以支持断点续传。\n\n断点续传实现逻辑是将每个块上传完毕的进度信息保存到本地的文件中持久化，如果本次上传被中断，下次可以从这个进度文件中读取每个块上传的状态，然后继续上传完毕没有完成的块，最后完成文件的拼接。需要注意，只有在块上传完毕之后，才向本地的进度文件写入进度内容。另外，每个上传任务初始化之后有效期最长是7天，过期会触发701的错误，可以检查进度信息中的时间参数来确认是否过期。\n\n \n \n putPolicy := storage.PutPolicy{\n \t\tScope: bucket,\n }\n mac := auth.New(accessKey, secretKey)\n upToken := putPolicy.UploadToken(mac)\n \n cfg := storage.Config{}\n // 空间对应的机房\n cfg.Region = &storage.ZoneHuadong\n // 是否使用https域名\n cfg.UseHTTPS = true\n // 上传是否使用CDN上传加速\n cfg.UseCdnDomains = false\n \n resumeUploader := storage.NewResumeUploaderV2(&cfg)\n ret := storage.PutRet{}\n putExtra := storage.RputV2Extra{\n \n }\n err := resumeUploader.PutFile(context.Background(), &ret, upToken, key, localFile, &putExtra)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Println(ret.Key, ret.Hash)\n \n\n## 文件断点续传\n\n断点续传是基于分片上传来实现的，基本原理就是用一个文本文件记录下上传的进度，如果上传中断，下次再从这个文件读取进度，继续上传未完成的分块。用户只需要传入Recorder参数即可实现断点续传，其他逻辑内部封装，实例如下：\n\n \n \n package main\n \n import (\n \t\"context\"\n \t\"fmt\"\n \t\"os\"\n \t\n \t\"github.com/qiniu/go-sdk/v7/auth\"\n \t\"github.com/qiniu/go-sdk/v7/storage\"\n )\n \n var (\n \taccessKey = \"your access key\"\n \tsecretKey = \"your secret key\"\n )\n \n func main() {\n \tlocalFile := \"your local file path\"\n \tbucket := \"your bucket name\"\n \tkey := \"your file save key\"\n \tputPolicy := storage.PutPolicy{\n \t\tScope: bucket,\n \t}\n \tmac := auth.New(accessKey, secretKey)\n \tupToken := putPolicy.UploadToken(mac)\n \tcfg := storage.Config{}\n \n \tresumeUploader := storage.NewResumeUploaderV2(&cfg)\n \tret := storage.PutRet{}\n \trecorder, err := storage.NewFileRecorder(os.TempDir())\n \tif err != nil {\n \t\tfmt.Println(err)\n \t\treturn\n \t}\n \n \tputExtra := storage.RputV2Extra{\n \t\tRecorder: recorder,\n \t}\n \terr = resumeUploader.PutFile(context.Background(), &ret, upToken, key, localFile, &putExtra)\n \tif err != nil {\n \t\tfmt.Println(err)\n \t\treturn\n \t}\n \tfmt.Println(ret.Key, ret.Hash)\n }\n \n \n\n## 解析自定义回复内容\n\n有些情况下，七牛返回给上传端的内容不是默认的`hash`和`key`形式，这种情况下，可能出现在自定义`returnBody`或者自定义了`callbackBody`的情况下，前者一般是服务端直传的场景，而后者则是接受上传回调的场景，这两种场景之下，都涉及到需要将自定义的回复进行内容解析，一般建议在交互过程中，都采用`JSON`的方式，这样处理起来方法比较一致，而且`JSON`的方法最通用。默认情况下SDK提供了`storage.PutRet`来作为标准回复的解析结构体，如果需要用到自定义回复，可以类似上面讲解`returnBody`的时候给的例子，自定义一个结构体用于回复的解析，例如：\n\n \n \n // 自定义返回值结构体\n type MyPutRet struct {\n \tKey string\n \tHash string\n \tFsize int\n \tBucket string\n \tName string\n }\n \n\n## 业务服务器验证存储服务回调\n\n在上传策略里面设置了上传回调相关参数的时候，七牛在文件上传到服务器之后，会主动地向`callbackUrl`发送POST请求的回调，回调的内容为`callbackBody`模版所定义的内容，如果这个模版里面引用了[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)或者[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)，那么这些变量会被自动填充对应的值，然后在发送给业务服务器。\n\n业务服务器在收到来自七牛的回调请求的时候，可以根据请求头部的`Authorization`字段来进行验证，查看该请求是否是来自七牛的未经篡改的请求。\n\nGo SDK 提供了一个方法 `qbox.VerifyCallback` 用于验证回调的请求：\n\n \n \n // VerifyCallback 验证上传回调请求是否来自存储服务\n func VerifyCallback(mac *Mac, req *http.Request) (bool, error) {\n \treturn mac.VerifyCallback(req)\n }\n \n\n# 下载文件\n\n * 生成文件的下载 URL\n * 生成公开空间文件的下载 URL\n * 生成私有空间文件的下载 URL\n * 通过接口下载文件\n\n文件下载分为公开空间的文件下载和私有空间的文件下载。\n\n## 生成文件的下载 URL\n\n文件下载的 URL 有两种：公开空间文件的下载 URL 和私有空间文件的下载 URL，公开空间文件的下载 URL 不需要签名，私有空间文件的下载 URL\n需要进行签名。\n\n### 生成公开空间文件的下载 URL\n\n对于公开空间，其访问的链接主要是将空间绑定的域名（可以是七牛空间的默认域名或者是绑定的自定义域名）拼接上空间里面的文件名即可访问，标准情况下需要在拼接链接之前，将文件名进行`urlencode`以兼容不同的字符。 \n当然也可以直接使用SDK里面的方法，传入域名和原始文件名即可得到公开访问外链。\n\n \n \n domain := \"https://image.example.com\"\n key := \"这是一个测试文件.jpg\"\n publicAccessURL := storage.MakePublicURL(domain, key)\n fmt.Println(publicAccessURL)\n \n\n### 生成私有空间文件下载的 URL\n\n对于私有空间，首先需要按照公开空间的文件访问方式构建对应的公开空间访问链接，然后再对这个链接进行私有授权签名。\n\n \n \n mac := auth.New(accessKey, secretKey)\n domain := \"https://image.example.com\"\n key := \"这是一个测试文件.jpg\"\n \n deadline := time.Now().Add(time.Second * 3600).Unix() //1小时有效期\n privateAccessURL := storage.MakePrivateURL(mac, domain, key, deadline)\n \n\n## 通过接口下载空间文件\n\n通过接口可以直接下载文件，需要注意：\n\n * 使用源站域名进行下载需要 URL 签名配置，不配置下载域名时默认会使用源站域名进行下载，此时 SDK 内部会对 URL 进行签名\n * 私有空间需要 URL 签名配置\n\n \n \n key := \"文件保存的 key.jpg\"\n bucket := \"对象所在的 bucket\"\n bm := NewBucketManager(mac, &Config{})\n \n // err 和 resp 可能同时有值，当 err 有值时，下载是失败的，此时如果 resp 也有值可以通过 resp 获取响应状态码等其他信息\n resp, err := bm.Get(bucket, key, &GetObjectInput{\n \tDownloadDomains: []string{\n \t\tbucket 绑定的域名, // 当前仅支持配置一个，不配置时，使用源站域名进行下载，会对下载的 URL 进行签名\n \t},\n \tPresignUrl: true, // 下载 URL 是否进行签名，源站域名或者私有空间需要配置为 true\n \tRange: \"bytes=2-5\", // 下载文件时 HTTP 请求的 Range 请求头\n })\n if err != nil || resp == nil {\n return\n }\n body, err := io.ReadAll(resp.Body)\n if err != nil {\n \treturn\n }\n \n\n# 资源管理\n\n资源管理包括的主要功能有：\n\n * 获取文件信息\n * 修改文件MimeType\n * 修改文件存储类型\n * 修改文件MetaData\n * 移动或重命名文件\n * 复制文件副本\n * 删除空间中的文件\n * 设置或更新文件生存时间\n * 获取指定前缀文件列表\n * 抓取网络资源到空间\n * 更新镜像存储空间中文件内容\n * 资源管理批量操作\n * 批量获取文件信息\n * 批量修改文件类型\n * 批量删除文件\n * 批量复制文件\n * 批量移动或重命名文件\n * 批量更新文件的有效期\n * 批量更新文件存储类型\n\n资源管理相关的操作首先要构建`BucketManager`对象：\n\n \n \n mac := auth.New(accessKey, secretKey)\n cfg := storage.Config{\n \t// 是否使用https域名进行资源管理\n \tUseHTTPS: true,\n }\n \n // 指定空间所在的区域，如果不指定将自动探测\n // 如果没有特殊需求，默认不需要指定\n //cfg.Region=&storage.ZoneHuabei\n \n bucketManager := storage.NewBucketManager(mac, &cfg)\n \n\n## 获取文件信息\n\n \n \n bucket := \"if-pbl\"\n key := \"github.png\"\n \n fileInfo, sErr := bucketManager.Stat(bucket, key)\n if sErr != nil {\n \tfmt.Println(sErr)\n \treturn\n }\n fmt.Println(fileInfo.String())\n //可以解析文件的PutTime\n fmt.Println(storage.ParsePutTime(fileInfo.PutTime))\n \n\n## 修改文件MimeType\n\n \n \n bucket := \"if-pbl\"\n key := \"github.png\"\n newMime := \"image/x-png\"\n \n err := bucketManager.ChangeMime(bucket, key, newMime)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n \n\n## 修改文件存储类型\n\n \n \n bucket := \"if-pbl\"\n key := \"github.png\"\n fileType := 1\n \n err := bucketManager.ChangeType(bucket, key, fileType)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n \n\n## 修改文件MetaData\n\n \n \n bucket := \"if-pbl\"\n key := \"github.png\"\n \n // map 中为需要修改的 metas，只包含需要更改的 metas，可增加；\n //\t\t\t\t 服务接口中 key 必须包含 x-qn-meta- 前缀，SDK 会对 metas 参数中的 key 进行检测;\n //\t\t\t\t - key 如果包含了 x-qn-meta- 前缀，则直接使用 key；\n //\t\t\t\t - key 如果不包含了 x-qn-meta- 前缀，则内部会为 key 拼接 x-qn-meta- 前缀。\n err = bucketManager.ChangeMeta(bucket, key, map[string]string{\n \t\"x-qn-meta-c\": \"x-qn-meta-cc-value\", // 如果 x-qn-meta-c 存在，则将值修改为 x-qn-meta-cc-value，如果不存在则增加 x-qn-meta-c 键值对\n })\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n \n\n## 移动或重命名文件\n\n移动操作本身支持移动文件到相同，不同空间中，在移动的同时也可以支持文件重命名。唯一的限制条件是，移动的源空间和目标空间必须在同一个机房。\n\n源空间 | 目标空间 | 源文件名 | 目标文件名 | 描述 \n---|---|---|---|--- \nBucketA | BucketA | KeyA | KeyB | 相当于同空间文件重命名 \nBucketA | BucketB | KeyA | KeyA | 移动文件到BucketB，文件名一致 \nBucketA | BucketB | KeyA | KeyB | 移动文件到BucketB，文件名变成KeyB \n \n`move`操作支持强制覆盖选项，即如果目标文件已存在，可以设置强制覆盖选项`force`来覆盖那个文件的内容。\n\n \n \n srcBucket := \"if-pbl\"\n srcKey := \"github.png\"\n \n //目标空间可以和源空间相同，但是不能为跨机房的空间\n destBucket := srcBucket\n //目标文件名可以和源文件名相同，也可以不同\n destKey := \"github-new.png\"\n \n //如果目标文件存在，是否强制覆盖，如果不覆盖，默认返回614 file exists\n force := false\n err := bucketManager.Move(srcBucket, srcKey, destBucket, destKey, force)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n \n\n## 复制文件副本\n\n文件的复制和文件移动其实操作一样，主要的区别是移动后源文件不存在了，而复制的结果是源文件还存在，只是多了一个新的文件副本。\n\n \n \n srcBucket := \"if-pbl\"\n srcKey := \"github.png\"\n \n //目标空间可以和源空间相同，但是不能为跨机房的空间\n destBucket := srcBucket\n //目标文件名可以和源文件名相同，也可以不同\n destKey := \"github-new.png\"\n \n //如果目标文件存在，是否强制覆盖，如果不覆盖，默认返回614 file exists\n force := false\n err := bucketManager.Copy(srcBucket, srcKey, destBucket, destKey, force)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n \n\n## 删除空间中的文件\n\n \n \n bucket := \"if-pbl\"\n key := \"github.png\"\n \n err := bucketManager.Delete(bucket, key)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n \n\n## 设置或更新文件的生存时间\n\n可以给已经存在于空间中的文件设置文件生存时间，或者更新已设置了生存时间但尚未被删除的文件的新的生存时间。\n\n \n \n bucket := \"if-pbl\"\n key := \"github.png\"\n days := 7\n \n err := bucketManager.DeleteAfterDays(bucket, key, days)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n \n\n## 获取指定前缀的文件列表\n\n获取指定文件前缀的列表用来从空间列举文件，每次最大的列举数量为1000，如果需要列举超过1000的文件数量，可以根据每次函数调用返回的`nextMarker`进行循环列举。\n\n \n \n bucket := \"if-bc\"\n limit := 1000\n prefix := \"qshell/\"\n delimiter := \"\"\n //初始列举marker为空\n marker := \"\"\n \n for {\n \tentries, _, nextMarker, hasNext, err := bucketManager.ListFiles(bucket, prefix, delimiter, marker, limit)\n \tif err != nil {\n \t\tfmt.Println(\"list error,\", err)\n \t\tbreak\n \t}\n \n \t//print entries\n \tfor _, entry := range entries {\n \t\tfmt.Println(entry.Key)\n \t}\n \n \tif hasNext {\n \t\tmarker = nextMarker\n \t} else {\n \t\t//list end\n \t\tbreak\n \t}\n \n }\n \n\n## 抓取网络资源到空间\n\n \n \n bucket := \"if-bc\"\n resURL := \"http://devtools.qiniu.com/qiniu.png\"\n \n // 指定保存的key\n fetchRet, err := bucketManager.Fetch(resURL, bucket, \"qiniu.png\")\n if err != nil {\n \tfmt.Println(\"fetch error,\", err)\n } else {\n \tfmt.Println(fetchRet.String())\n }\n \n // 不指定保存的key，默认用文件hash作为文件名\n fetchRet, err = bucketManager.FetchWithoutKey(resURL, bucket)\n if err != nil {\n \tfmt.Println(\"fetch error,\", err)\n } else {\n \tfmt.Println(fetchRet.String())\n }\n \n\n## 更新镜像空间中存储的文件内容\n\n \n \n bucket := \"if-bc\"\n key := \"qiniu.png\"\n \n err := bucketManager.Prefetch(bucket, key)\n if err != nil {\n \tfmt.Println(\"fetch error,\", err)\n }\n \n\n## 资源管理批量操作\n\n## 批量获取文件信息\n\n \n \n //每个batch的操作数量不可以超过1000个，如果总数量超过1000，需要分批发送\n bucket := \"if-pbl\"\n keys := []string{\n \t\"github1.png\",\n \t\"github2.png\",\n \t\"github3.png\",\n \t\"github4.png\",\n \t\"github5.png\",\n }\n statOps := make([]string, 0, len(keys))\n for _, key := range keys {\n \tstatOps = append(statOps, storage.URIStat(bucket, key))\n }\n \n rets, err := bucketManager.Batch(statOps)\n if len(rets) == 0 {\n // 处理错误\n if e, ok := err.(*storage.ErrorInfo); ok {\n fmt.Printf(\"batch error, code:%s\", e.Code)\n } else {\n fmt.Printf(\"batch error, %s\", err)\n }\n return\n }\n \n // 返回 rets，先判断 rets 是否\n for _, ret := range rets {\n // 200 为成功\n if ret.Code == 200 {\n fmt.Printf(\"%d\\n\", ret.Code)\n } else {\n fmt.Printf(\"%s\\n\", ret.Data.Error)\n }\n }\n \n\n## 批量修改文件类型\n\n \n \n //每个batch的操作数量不可以超过1000个，如果总数量超过1000，需要分批发送\n bucket := \"if-pbl\"\n chgmKeys := map[string]string{\n \t\"github1.png\": \"image/x-png\",\n \t\"github2.png\": \"image/x-png\",\n \t\"github3.png\": \"image/x-png\",\n \t\"github4.png\": \"image/x-png\",\n \t\"github5.png\": \"image/x-png\",\n }\n chgmOps := make([]string, 0, len(chgmKeys))\n for key, newMime := range chgmKeys {\n \tchgmOps = append(chgmOps, storage.URIChangeMime(bucket, key, newMime))\n }\n \n rets, err := bucketManager.Batch(chgmOps)\n if len(rets) == 0 {\n // 处理错误\n if e, ok := err.(*storage.ErrorInfo); ok {\n fmt.Printf(\"batch error, code:%s\", e.Code)\n } else {\n fmt.Printf(\"batch error, %s\", err)\n }\n return\n }\n \n // 返回 rets，先判断 rets 是否\n for _, ret := range rets {\n // 200 为成功\n if ret.Code == 200 {\n fmt.Printf(\"%d\\n\", ret.Code)\n } else {\n fmt.Printf(\"%s\\n\", ret.Data.Error)\n }\n }\n \n\n## 批量删除文件\n\n \n \n //每个batch的操作数量不可以超过1000个，如果总数量超过1000，需要分批发送\n bucket := \"if-pbl\"\n keys := []string{\n \t\"github1.png\",\n \t\"github2.png\",\n \t\"github3.png\",\n \t\"github4.png\",\n \t\"github5.png\",\n }\n deleteOps := make([]string, 0, len(keys))\n for _, key := range keys {\n \tdeleteOps = append(deleteOps, storage.URIDelete(bucket, key))\n }\n \n rets, err := bucketManager.Batch(deleteOps)\n if len(rets) == 0 {\n // 处理错误\n if e, ok := err.(*storage.ErrorInfo); ok {\n fmt.Printf(\"batch error, code:%s\", e.Code)\n } else {\n fmt.Printf(\"batch error, %s\", err)\n }\n return\n }\n \n // 返回 rets，先判断 rets 是否\n for _, ret := range rets {\n // 200 为成功\n if ret.Code == 200 {\n fmt.Printf(\"%d\\n\", ret.Code)\n } else {\n fmt.Printf(\"%s\\n\", ret.Data.Error)\n }\n }\n \n\n## 批量复制文件\n\n \n \n srcBucket := \"if-pbl\"\n destBucket := \"if-pbl\"\n force := true\n copyKeys := map[string]string{\n \t\"github1.png\": \"github1-copy.png\",\n \t\"github2.png\": \"github2-copy.png\",\n \t\"github3.png\": \"github3-copy.png\",\n \t\"github4.png\": \"github4-copy.png\",\n \t\"github5.png\": \"github5-copy.png\",\n }\n copyOps := make([]string, 0, len(copyKeys))\n for srcKey, destKey := range copyKeys {\n \tcopyOps = append(copyOps, storage.URICopy(srcBucket, srcKey, destBucket, destKey, force))\n }\n \n rets, err := bucketManager.Batch(copyOps)\n if len(rets) == 0 {\n // 处理错误\n if e, ok := err.(*storage.ErrorInfo); ok {\n fmt.Printf(\"batch error, code:%s\", e.Code)\n } else {\n fmt.Printf(\"batch error, %s\", err)\n }\n return\n }\n \n // 返回 rets，先判断 rets 是否\n for _, ret := range rets {\n // 200 为成功\n if ret.Code == 200 {\n fmt.Printf(\"%d\\n\", ret.Code)\n } else {\n fmt.Printf(\"%s\\n\", ret.Data.Error)\n }\n }\n \n\n## 批量移动或重命名文件\n\n \n \n srcBucket := \"if-pbl\"\n destBucket := \"if-pbl\"\n force := true\n moveKeys := map[string]string{\n \t\"github1.png\": \"github1-move.png\",\n \t\"github2.png\": \"github2-move.png\",\n \t\"github3.png\": \"github3-move.png\",\n \t\"github4.png\": \"github4-move.png\",\n \t\"github5.png\": \"github5-move.png\",\n }\n moveOps := make([]string, 0, len(moveKeys))\n for srcKey, destKey := range moveKeys {\n \tmoveOps = append(moveOps, storage.URIMove(srcBucket, srcKey, destBucket, destKey, force))\n }\n \n rets, err := bucketManager.Batch(moveOps)\n if len(rets) == 0 {\n // 处理错误\n if e, ok := err.(*storage.ErrorInfo); ok {\n fmt.Printf(\"batch error, code:%s\", e.Code)\n } else {\n fmt.Printf(\"batch error, %s\", err)\n }\n return\n }\n \n // 返回 rets，先判断 rets 是否\n for _, ret := range rets {\n // 200 为成功\n if ret.Code == 200 {\n fmt.Printf(\"%d\\n\", ret.Code)\n } else {\n fmt.Printf(\"%s\\n\", ret.Data.Error)\n }\n }\n \n\n## 批量更新文件的有效期\n\n \n \n //每个batch的操作数量不可以超过1000个，如果总数量超过1000，需要分批发送\n bucket := \"if-bc\"\n expireKeys := map[string]int{\n \t\"github1.png\": 7,\n \t\"github2.png\": 8,\n \t\"github3.png\": 9,\n \t\"github4.png\": 10,\n \t\"github5.png\": 11,\n }\n expireOps := make([]string, 0, len(expireKeys))\n for key, expire := range expireKeys {\n \texpireOps = append(expireOps, storage.URIDeleteAfterDays(bucket, key, expire))\n }\n \n rets, err := bucketManager.Batch(expireOps)\n if len(rets) == 0 {\n // 处理错误\n if e, ok := err.(*storage.ErrorInfo); ok {\n fmt.Printf(\"batch error, code:%s\", e.Code)\n } else {\n fmt.Printf(\"batch error, %s\", err)\n }\n return\n }\n \n // 返回 rets，先判断 rets 是否\n for _, ret := range rets {\n // 200 为成功\n if ret.Code == 200 {\n fmt.Printf(\"%d\\n\", ret.Code)\n } else {\n fmt.Printf(\"%s\\n\", ret.Data.Error)\n }\n }\n \n\n## 批量更新文件存储类型\n\n \n \n //每个batch的操作数量不可以超过1000个，如果总数量超过1000，需要分批发送\n bucket := \"if-pbl\"\n chtypeKeys := map[string]int{\n \t\"github1.png\": 1,\n \t\"github2.png\": 1,\n \t\"github3.png\": 1,\n \t\"github4.png\": 1,\n \t\"github5.png\": 1,\n }\n chtypeOps := make([]string, 0, len(chtypeKeys))\n for key, fileType := range chtypeKeys {\n \tchtypeOps = append(chtypeOps, storage.URIChangeType(bucket, key, fileType))\n }\n \n rets, err := bucketManager.Batch(chtypeOps)\n if len(rets) == 0 {\n // 处理错误\n if e, ok := err.(*storage.ErrorInfo); ok {\n fmt.Printf(\"batch error, code:%s\", e.Code)\n } else {\n fmt.Printf(\"batch error, %s\", err)\n }\n return\n }\n \n // 返回 rets，先判断 rets 是否\n for _, ret := range rets {\n // 200 为成功\n if ret.Code == 200 {\n fmt.Printf(\"%d\\n\", ret.Code)\n } else {\n fmt.Printf(\"%s\\n\", ret.Data.Error)\n }\n }\n \n\n# 持久化数据处理\n\n## 发送数据处理请求\n\n对于已经保存到七牛空间的文件，可以通过发送持久化的数据处理指令来进行处理，这些指令支持七牛官方提供的指令，也包括客户自己开发的自定义数据处理的指令。数据处理的结果还可以通过七牛主动通知的方式告知业务服务器。\n\n使用数据处理，首先需要构建一个`OperationManager`对象：\n\n \n \n mac := auth.New(accessKey, secretKey)\n cfg := storage.Config{\n \tUseHTTPS: true,\n }\n \n // 指定空间所在的区域，如果不指定将自动探测\n // 如果没有特殊需求，默认不需要指定\n //cfg.Region=&storage.ZoneHuabei\n operationManager := storage.NewOperationManager(mac, &cfg)\n \n\n进行视频的处理示例：\n\n \n \n bucket := \"if-pbl\"\n key := \"qiniu.mp4\"\n mac := auth.New(accessKey, secretKey)\n \n saveBucket := bucket\n \n // 处理指令集合\n fopAvthumb := fmt.Sprintf(\"avthumb/mp4/s/480x320/vb/500k|saveas/%s\",\n \tstorage.EncodedEntry(saveBucket, \"pfop_test_qiniu.mp4\"))\n fopVframe := fmt.Sprintf(\"vframe/jpg/offset/10|saveas/%s\",\n \tstorage.EncodedEntry(saveBucket, \"pfop_test_qiniu.jpg\"))\n fopVsample := fmt.Sprintf(\"vsample/jpg/interval/20/pattern/%s\",\n \tbase64.URLEncoding.EncodeToString([]byte(\"pfop_test_$(count).jpg\")))\n \n fopBatch := []string{fopAvthumb, fopVframe, fopVsample}\n fops := strings.Join(fopBatch, \";\")\n \n // 强制重新执行数据处理任务\n force := true\n // 数据处理指令全部完成之后，通知该地址\n notifyURL := \"http://api.example.com/pfop/callback\"\n // 数据处理的私有队列，必须指定以保障处理速度\n pipeline := \"jemy\"\n persistentId, err := operationManager.Pfop(bucket, key, fops, pipeline, notifyURL, force)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n \n fmt.Println(persistentId)\n \n\n## 查询数据处理请求状态\n\n由于数据处理是异步处理，可以根据发送处理请求时返回的 `persistentId`\n去查询任务的处理进度，如果在上传策略里面设置了`persistentNotifyUrl`或者发送处理请求时指定`notifyURL`的情况下，直接业务服务器等待处理结果通知即可，如果需要主动查询，可以采用如下代码中的：\n\n \n \n persistentId := \"z0.597f28b445a2650c994bb208\"\n ret, err := operationManager.Prefop(persistentId)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Println(ret.String())\n \n\n# CDN相关功能\n\n * 文件刷新\n * 目录刷新\n * 文件预取操作\n * 获取域名流量\n * 获取域名带宽\n * 获取日志下载链接\n * 构建时间戳防盗链访问链接\n\n在使用CDN相关功能之前，需要构建`CdnManager`对象：\n\n \n \n mac := auth.New(accessKey, secretKey)\n cdnManager := cdn.NewCdnManager(mac)\n \n\n## 文件刷新\n\n \n \n //刷新链接，单次请求链接不可以超过100个，如果超过，请分批发送请求\n urlsToRefresh := []string{\n \t\"http://if-pbl.qiniudn.com/qiniu.png\",\n \t\"http://if-pbl.qiniudn.com/github.png\",\n }\n \n ret, err := cdnManager.RefreshUrls(urlsToRefresh)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Println(ret.Code)\n fmt.Println(ret.RequestID)\n \n\n## 目录刷新\n\n \n \n // 刷新目录，刷新目录需要联系七牛技术支持开通权限\n // 单次请求链接不可以超过10个，如果超过，请分批发送请求\n dirsToRefresh := []string{\n \t\"http://if-pbl.qiniudn.com/images/\",\n \t\"http://if-pbl.qiniudn.com/static/\",\n }\n \n ret, err := cdnManager.RefreshDirs(dirsToRefresh)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Println(ret.Code)\n fmt.Println(ret.RequestID)\n fmt.Println(ret.Error)\n \n\n## 文件预取\n\n \n \n // 预取链接，单次请求链接不可以超过100个，如果超过，请分批发送请求\n urlsToPrefetch := []string{\n \t\"http://if-pbl.qiniudn.com/qiniu.png\",\n \t\"http://if-pbl.qiniudn.com/github.png\",\n }\n \n ret, err := cdnManager.PrefetchUrls(urlsToPrefetch)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Println(ret.Code)\n fmt.Println(ret.RequestID)\n \n\n## 获取域名流量\n\n \n \n domains := []string{\n \t\"if-pbl.qiniudn.com\",\n \t\"qdisk.qiniudn.com\",\n }\n startDate := \"2017-07-30\"\n endDate := \"2017-07-31\"\n granularity := \"day\"\n \n data, err := cdnManager.GetFluxData(startDate, endDate, granularity, domains)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Printf(\"%v\\n\", data)\n \n\n## 获取域名带宽\n\n \n \n domains := []string{\n \t\"if-pbl.qiniudn.com\",\n \t\"qdisk.qiniudn.com\",\n }\n startDate := \"2017-07-30\"\n endDate := \"2017-07-31\"\n granularity := \"day\"\n \n data, err := cdnManager.GetBandwidthData(startDate, endDate, granularity, domains)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Printf(\"%v\\n\", data)\n \n\n## 获取日志下载链接\n\n \n \n domains := []string{\n \t\"if-pbl.qiniudn.com\",\n \t\"qdisk.qiniudn.com\",\n }\n \n day := \"2017-07-30\"\n \n ret, err := cdnManager.GetCdnLogList(day, domains)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n \n domainLogs := ret.Data\n for domain, logs := range domainLogs {\n \tfmt.Println(domain)\n \tfor _, item := range logs {\n \t\tfmt.Println(item.Name, item.URL, item.Size, item.ModifiedTime)\n \t}\n }\n \n\n## 构建时间戳防盗链访问链接\n\n具体算法可以参考：[时间戳防盗链](https://developer.qiniu.com/fusion/kb/timestamp-hotlinking-\nprevention)\n\n \n \n urlStr := \"http://img.abc.com/test.jpg\"\n cryptKey := \"abc123\"\n deadline := time.Now().Add(time.Second * 3600).Unix()\n accessUrl, err := cdn.CreateTimestampAntileechURL(urlStr, cryptKey, deadline)\n if err != nil {\n \tfmt.Println(err)\n \treturn\n }\n fmt.Println(accessUrl)\n \n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n * [融合CDN API 参考](https://developer.qiniu.com/fusion)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n\n# 常见问题\n\n * Go SDK的 err 保留了请求的错误信息，回复信息和头部信息，遇到问题时，可以都打印出来提交给我们排查问题。\n\n \n \n if err != nil {\n \tif v, ok := err.(*rpc.ErrorInfo); ok {\n \t\tfmt.Println(v.Code, v.RequestID, v.Err)\n \t} else if v, ok := err.(*storage.ErrorInfo); ok {\n \t\tfmt.Println(v.Code, v.Reqid, v.Err)\n \t} else {\n \t\tfmt.Println(err)\n \t}\n }\n \n\n * API 的使用，可以参考我们为大家精心准备的[使用实例 __](https://github.com/qiniu/go-sdk/tree/master/examples)。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](https://support.qiniu.com/tickets/new)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2020 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Go SDK历史版本"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [Go\nSDK](https://developer.qiniu.com/kodo/sdk/1238/go) > Go SDK历史版本\n\n# Go SDK历史版本\n\n最近更新时间: 2019-12-16 17:22:39\n\n七牛云存储的 GO 语言版本 SDK（本文以下称 GO-SDK）是对七牛云存储API协议的一层封装，以提供一套对于 GO 开发者而言简单易用的原生 GO\n函数。GO 开发者在对接 GO-SDK 时无需理解七牛云存储 API 协议的细节，原则上也不需要对 HTTP 协议和原理做非常深入的了解，但如果拥有基础的\nHTTP 知识，对于出错场景的处理可以更加高效。\n\nGO-SDK 以开源方式提供。开发者可以随时从本文档提供的下载地址查看和下载 SDK 的源代码。\n\n由于 GO 语言的通用性，GO-SDK\n被设计为同时适合服务器端和客户端使用。服务端是指开发者自己的业务服务器，客户端是指开发者的客户终端。服务端因为有七牛颁发的\nAccessKey/SecretKey，可以做很多客户端做不了的事情，比如删除文件、移动/复制文件等操作。一般而言，客服端操作文件需要获得服务端的授权。客户端上传文件需要获得服务端颁发的[上传凭证](https://developer.qiniu.com/kodo/manual/upload-\ntoken)，客户端下载文件（包括下载处理过的文件，比如下载图片的缩略图）需要获得服务端颁发的[下载凭证](https://developer.qiniu.com/kodo/manual/download-\ntoken)。但开发者也可以将 bucket\n设置为公开，此时文件有永久有效的访问地址，不需要业务服务器的授权，这对网站的静态文件（如图片、js、css、html）托管非常方便。\n\n从 v5.0.0 版本开始，我们对 SDK 的内容进行了精简。所有管理操作，比如：创建/删除 bucket、为 bucket\n绑定域名（publish）、设置数据处理的样式分隔符、新增数据处理样式等都去除了，统一建议到[开发者平台](https://portal.qiniu.com/)来完成。另外，此前服务端还有自己独有的上传\nAPI，现在也推荐统一成基于客户端上传的工作方式。\n\n从内容上来说，GO-SDK 主要包含如下几方面的内容：\n\n * 公共库: api/conf\n * 客户端上传文件：api/io\n * 客户端断点续上传：api/resumable/io\n * 数据处理：api/fop\n * 服务端操作：api/auth/digest (授权)，api/rs(资源管理，uptoken/dntoken颁发)，api/rsf(批量获取文件列表)\n\n# 安装\n\n在命令行下执行\n\n \n \n go get -u github.com/qiniu/api.v7\n \n\n \n**初始化**\n\n要接入七牛云存储，您需要拥有一对有效的 Access Key 和 Secret Key 用来进行签名认证。可以通过如下步骤获得：\n\n 1. [开通七牛开发者帐号](https://portal.qiniu.com/signup)\n 2. 登录七牛开发者自助平台，查看 [Access Key 和 Secret Key](https://portal.qiniu.com/user/key)。\n\n在获取到 Access Key 和 Secret Key 之后，您可以在您的程序中调用如下两行代码进行初始化对接， 要确保`ACCESS_KEY` 和\n`SECRET_KEY` 在服务端调用 api/auth/digest，api/rs，api/rsf之前均已赋值：\n\n \n \n import .\"github.com/qiniu/api.v6/conf\"\n \n ACCESS_KEY = \"<YOUR_APP_ACCESS_KEY>\"\n SECRET_KEY = \"<YOUR_APP_SECRET_KEY>\"\n \n\n# 上传文件\n\n为了尽可能地改善终端用户的上传体验，七牛云存储首创了客户端直传功能。一般云存储的上传流程是：\n\n \n \n 客户端（终端用户） => 业务服务器 => 云存储服务\n \n\n这样多了一次上传的流程，和本地存储相比，会相对慢一些。但七牛引入了客户端直传，将整个上传过程调整为：\n\n \n \n 客户端（终端用户） => 七牛 => 业务服务器\n \n\n客户端（终端用户）直接上传到七牛的服务器，通过DNS智能解析，七牛会选择到离终端用户最近的ISP服务商节点，速度会比本地存储快很多。文件上传成功以后，七牛的服务器使用回调功能，只需要将非常少的数据（比如Key）传给应用服务器，应用服务器进行保存即可。\n\n**注意** ：如果您只是想要上传已存在您电脑本地或者是服务器上的文件到七牛云存储，可以直接使用七牛提供的\n[qshell](https://developer.qiniu.com/kodo/tools/qshell) 上传工具。 \n文件上传有两种方式，一种是以普通方式直传文件，简称普通上传，另一种方式是断点续上传，断点续上传在网络条件很一般的情况下也能有出色的上传速度，而且对大文件的传输非常友好。\n\n## 上传流程\n\n在七牛云存储中，整个上传流程大体分为这样几步：\n\n 1. 业务服务器颁发 [上传凭证](https://developer.qiniu.com/kodo/manual/upload-token)给客户端（终端用户）\n 2. 客户端凭借上传凭证上传文件到七牛\n 3. 在七牛获得完整数据后，发起一个 HTTP 请求回调到业务服务器\n 4. 业务服务器保存相关信息，并返回一些信息给七牛\n 5. 七牛原封不动地将这些信息转发给客户端（终端用户）\n\n需要注意的是，回调到业务服务器的过程是可选的，它取决于业务服务器颁发的\n[上传凭证](https://developer.qiniu.com/kodo/manual/upload-\ntoken)。如果没有回调，七牛会返回一些标准的信息（比如文件的 hash）给客户端。如果上传发生在业务服务器，以上流程可以自然简化为：\n\n 1. 业务服务器生成 uptoken（不设置回调，自己回调到自己这里没有意义）\n 2. 凭借 [上传凭证](https://developer.qiniu.com/kodo/manual/upload-token) 上传文件到七牛\n 3. 善后工作，比如保存相关的一些信息\n\n## 生成上传授权uptoken\n\nuptoken是一个字符串，业务服务器根据(`rs.PutPolicy`)的结构体的各个参数来生成[上传凭证](https://developer.qiniu.com/kodo/manual/upload-\ntoken)的代码如下（调用如下代码前，请确保Access Key 和 Secret Key已经被正确初始化）:\n\n \n \n func uptoken(bucketName string) string {\n putPolicy := rs.PutPolicy {\n Scope: bucketName,\n //CallbackUrl: callbackUrl, \n //CallbackBody:callbackBody, \n //ReturnUrl: returnUrl, \n //ReturnBody: returnBody, \n //AsyncOps: asyncOps, \n //EndUser: endUser, \n //Expires: expires, \n }\n return putPolicy.Token(nil)\n }\n \n\n参阅 `rs.PutPolicy`\n\n## 上传代码\n\n上传文件到七牛（通常是客户端完成，但也可以发生在业务服务器）。 \n由于七牛的服务器支持自动生成key，所以本SDK提供的上传函数有两种展现方式，一种是有key的，一种是无key，让服务端自动生成key。 \n普通上传的文件和二进制，最后一个参数都是PutExtra类型，是用来细化上传功能用的，PutExtra的成员及其意义如下：\n\n \n \n type PutExtra struct {\n Params map[string]string //可选，用户自定义参数，必须以 \"x:\" 开头\n //若不以x:开头，则忽略\n MimeType string //可选，当为 \"\" 时候，服务端自动判断 \n Crc32 uint32\n CheckCrc uint32\n // CheckCrc == 0: 表示不进行 crc32 校验\n // CheckCrc == 1: 对于 Put 等同于 CheckCrc = 2；对于 PutFile 会自动计算 crc32 值\n // CheckCrc == 2: 表示进行 crc32 校验，且 crc32 值就是上面的 Crc32 变量\n }\n \n\n直接上传内存中的数据，代码如下:\n\n \n \n var err error\n var ret io.PutRet\n var extra = &io.PutExtra {\n //Params: params,\n //MimeType: mieType,\n //Crc32: crc32,\n //CheckCrc: CheckCrc,\n }\n \n // ret 变量用于存取返回的信息，详情见 io.PutRet\n // uptoken 为业务服务器端生成的上传口令\n // key 为文件存储的标识\n // r 为io.Reader类型，用于从其读取数据\n // extra 为上传文件的额外信息,可为空， 详情见 io.PutExtra, 可选\n err = io.Put(nil, &ret, uptoken, key, r, extra)\n \n if err != nil {\n //上传产生错误\n log.Print(\"io.Put failed:\", err)\n return\n }\n \n //上传成功，处理返回值\n log.Print(ret.Hash, ret.Key)\n \n\n参阅: `io.Put`, `io.PutExtra`\n\n直接上传内存中的数据，且不提供key参数，此时key由七牛服务器自动生成，代码如下:\n\n \n \n var err error\n var ret io.PutRet\n var extra = &io.PutExtra {\n //Params: params,\n //MimeType: mieType,\n //Crc32: crc32,\n //CheckCrc: CheckCrc,\n }\n \n // ret 变量用于存取返回的信息，详情见 io.PutRet\n // uptoken 为业务服务器端生成的上传口令\n // r 为io.Reader类型，用于从其读取数据\n // extra 为上传文件的额外信息,可为空， 详情见 io.PutExtra, 可选\n err = io.PutWithoutKey(nil, &ret, uptoken, r, extra)\n \n if err != nil {\n //上传产生错误\n log.Print(\"io.Put failed:\", err)\n return\n }\n \n //上传成功，处理返回值\n log.Print(ret.Hash, ret.Key)\n \n\n参阅: `io.Put`, `io.PutExtra`\n\n上传本地文件，代码如下:\n\n \n \n var err error\n var ret io.PutRet\n var extra = &io.PutExtra {\n //Params: params,\n //MimeType: mieType,\n //Crc32: crc32,\n //CheckCrc: CheckCrc,\n }\n \n // ret 变量用于存取返回的信息，详情见 io.PutRet\n // uptoken 为业务服务器生成的上传口令\n // key 为文件存储的标识\n // localFile 为本地文件名\n // extra 为上传文件的额外信息，详情见 io.PutExtra，可选\n err = io.PutFile(nil, &ret, uptoken, key, localFile, extra)\n \n if err != nil {\n //上传产生错误\n log.Print(\"io.PutFile failed:\", err)\n return\n }\n \n //上传成功，处理返回值\n log.Print(ret.Hash, ret.Key)\n \n\n参阅: `io.PutFile`, `io.PutExtra`, `io.PutRet`\n\n上传本地文件，且不提供 key 参数，此时 key 由七牛服务器自动生成代码:\n\n \n \n var err error\n var ret io.PutRet\n var extra = &io.PutExtra {\n //Params: params,\n //MimeType: mieType,\n //Crc32: crc32,\n //CheckCrc: CheckCrc,\n }\n \n // ret 变量用于存取返回的信息，详情见 io.PutRet\n // uptoken 为业务服务器生成的上传口令\n // localFile 为本地文件名\n // extra 为上传文件的额外信息，详情见 io.PutExtra，可选\n err = io.PutFileWithoutKey(nil, &ret, uptoken, localFile, extra)\n \n if err != nil {\n //上传产生错误\n log.Print(\"io.PutFile failed:\", err)\n return\n }\n \n //上传成功，处理返回值\n log.Print(ret.Hash, ret.Key)\n \n\n参阅: `io.PutFile`, `io.PutExtra`, `io.PutRet`\n\n## 断点续上传、分块并行上传\n\n除了基本的上传外，七牛还支持你将文件切成若干块（除最后一块外，每个块固定为4M大小），每个块可独立上传，互不干扰；每个分块块内则能够做到断点上续传。\n\n断点续上传函数，最后一个选项是 resumable.io.PutExtra结构体，来细化上传用的，其成员及其含义如下：\n\n \n \n type PutExtra struct {\n CallbackParams string // 当 uptoken 指定了 CallbackUrl，则 CallbackParams 必须非空\n Bucket string\n CustomMeta string // 可选。用户自定义 Meta，不能超过 256 字节\n MimeType string // 可选。在 uptoken 没有指定 DetectMime 时，用户客户端可自己指定 MimeType\n ChunkSize int // 可选。每次上传的Chunk大小\n TryTimes int // 可选。尝试次数\n Progresses []BlkputRet // 可选。上传进度\n Notify func(blkIdx int, blkSize int, ret *BlkputRet) // 可选。进度提示（注意多个block是并行传输的）\n NotifyErr func(blkIdx int, blkSize int, err error)\n }\n \n\n我们先看支持的断点续上传、分块并行上传的基本样例：\n\n上传二进制流\n\n \n \n var err error\n var ret io.PutRet\n var extra = &rio.PutExtra {\n //CallbackParams: callbackParams,\n //Bucket: bucket,\n //CustomMeta: customMeta,\n //MimeType: mieType,\n //ChunkSize: chunkSize,\n //TryTimes: tryTimes, \n //Progresses: progresses,\n //Notify: notify, \n //NotifyErr: NotifyErr,\n }\n \n // ret 变量用于存取返回的信息，详情见 resumable.io.PutRet\n // uptoken 为业务服务器生成的上传口令\n // key 为文件存储的标识\n // r 为io.ReaderAt,用于读取数据\n // fsize 数据总字节数\n // extra 为上传文件的额外信息, 详情见 resumable.io.PutExtra\n err = rio.Put(nil, ret, uptoken, key, r, fsize, extra)\n \n if err != nil {\n //上传产生错误\n log.Print(\"resumable.io.Put failed:\", err)\n return\n }\n \n //上传成功，处理返回值\n log.Print(ret.Hash)\n \n\n参阅: `resumable.io.Put`, `resumable.io.PutExtra`, `rs.PutPolicy`\n\n上传本地文件\n\n \n \n var err error\n var ret rio.PutRet\n var extra = &rio.PutExtra {\n //CallbackParams: callbackParams,\n //Bucket: bucket,\n //CustomMeta: customMeta,\n //MimeType: mieType,\n //ChunkSize: chunkSize,\n //TryTimes: tryTimes, \n //Progresses: progresses,\n //Notify: notify, \n //NotifyErr: NotifyErr,\n }\n \n // ret 变量用于存取返回的信息，详情见 resumable.io.PutRet\n // uptoken 为业务服务器生成的上传口令\n // key 为文件存储的标识\n // localFile 为本地文件名\n // extra 为上传文件的额外信息,可为空， 详情见 resumable.io.PutExtra\n err = rio.PutFile(nil, ret, uptoken, key, localFile, extra)\n \n if err != nil {\n //上传产生错误\n log.Print(\"resumable.io.Put failed:\", err)\n return\n }\n \n //上传成功，处理返回值\n log.Print(ret.Hash)\n \n\n参阅: `resumable.io.PutFile`, `resumable.io.PutExtra`, `rs.PutPolicy`\n\n相比普通上传，断点上续传代码没有变复杂。基本上就只是将`io.PutExtra`改为`resumable.io.PutExtra`，`io.PutFile`改为`resumable.io.PutFile`。\n\n但实际上 `resumable.io.PutExtra` 多了不少配置项，其中最重要的是两个回调函数：`Notify` 与\n`NotifyErr`，它们用来通知使用者有更多的数据被传输成功，或者有些数据传输失败。在 `Notify`\n回调函数中，比较常见的做法是将传输的状态进行持久化，以便于在软件退出后下次再进来还可以继续进行断点续上传。但不传入 `Notify`\n回调函数并不表示不能断点续上传，只要程序没有退出，上传失败自动进行续传和重试操作。\n\n## 上传策略\n\n[上传凭证](https://developer.qiniu.com/kodo/manual/upload-token) 实际上是用\nAccessKey/SecretKey 进行数字签名的上传策略(`rs.PutPolicy`)，它控制着整个上传流程的行为。让我们快速过一遍你都能够决策啥：\n\n * `Expires` 指定上传凭证有效期（默认1小时）。一个上传凭证可以被用于多次上传（只要它还没有过期）。\n * `Scope` 限定客户端的权限。如果 `scope` 是 bucket，则客户端只能新增文件到指定的 bucket，不能修改文件。如果 `scope` 为 bucket:key，则客户端可以修改指定的文件。\n * `CallbackUrl` 设定业务服务器的回调地址，这样业务服务器才能感知到上传行为的发生。可选。\n * `AsyncOps` 可指定上传完成后，需要自动执行哪些数据处理。这是因为有些数据处理操作（比如音视频转码）比较慢，如果不进行预转可能第一次访问的时候效果不理想，预转可以很大程度改善这一点。\n * `ReturnBody` 可调整返回给客户端的数据包（默认情况下七牛返回文件内容的 `hash`，也就是下载该文件时的 `etag`）。这只在没有 `CallbackUrl` 时有效。\n * `Escape` 为真（非0）时，表示客户端传入的 `CallbackParams` 中含有转义符。通过这个特性，可以很方便地把上传文件的某些元信息如 `fsize`（文件大小）、`ImageInfo.width/height`（图片宽度/高度）、`exif`（图片EXIF信息）等传给业务服务器。\n * `DetectMime` 为真（非0）时，表示服务端忽略客户端传入的 `MimeType`，自己自行检测。\n\n关于上传策略更完整的说明，请参考 [上传凭证](https://developer.qiniu.com/kodo/manual/upload-token)。\n\n# 下载文件\n\n七牛云存储上的资源下载分为 公有资源下载 和 私有资源下载 。\n\n私有（private）是 Bucket（空间）的一个属性，一个私有 Bucket 中的资源为私有资源，私有资源不可匿名下载。\n\n新创建的空间（Bucket）缺省为私有，也可以将某个 Bucket 设为公有，公有 Bucket 中的资源为公有资源，公有资源可以匿名下载。\n\n## 公有资源下载\n\n如果在给bucket绑定了域名的话，可以通过以下地址访问：\n\n \n \n [GET] http://<domain>/<key>\n \n\n其中可以到[七牛开发者平台](https://portal.qiniu.com)绑定。步骤：**首先** 选择需要绑定的空间，**其次**\n在空间设置标签下，点击域名绑定项，即可申请绑定自定义域名。域名可以使用自己的一级域名或是由七牛提供的二级域名(`<bucket>.qiniudn.com`)。**注意：**\n尖括号不是必需，代表替换项。\n\n## 私有资源下载\n\n如果某个 bucket 是私有的，那么这个 bucket 中的所有文件只能通过一个的临时有效的 downloadUrl 访问：\n\n \n \n [GET] http://<domain>/<key>?token=<dnToken>\n \n\n**注意：** 尖括号不是必需，代表替换项。 \n其中 dntoken 是由业务服务器签发的一个临时[下载凭证][downloadTokenHref]，deadline 是 dntoken\n的有效期。dntoken不需要生成，GO-SDK 提供了生成完整 downloadUrl 的方法（包含了 dntoken），示例代码如下：\n\n \n \n func downloadUrl(domain, key string) string {\n baseUrl := rs.MakeBaseUrl(domain, key)\n policy := rs.GetPolicy{}\n return policy.MakeRequest(baseUrl, nil)\n }\n \n\n生成 downloadUrl 后，服务端下发 downloadUrl 给客户端。客户端收到 downloadUrl 后，和公有资源类似，直接用任意的\nHTTP 客户端就可以下载该资源了。唯一需要注意的是，在 downloadUrl 失效却还没有完成下载时，需要重新向服务器申请授权。\n\n无论公有资源还是私有资源，下载过程中客户端并不需要七牛 GO-SDK 参与其中。\n\n参阅: `rs.GetPolicy`, `rs.GetPolicy.MakeRequest`, `rs.MakeBaseUrl`\n\n## HTTPS支持\n\n几乎所有七牛云存储 API 都同时支持 HTTP 和 HTTPS，但 HTTPS 下载有些需要注意的点。如果你的资源希望支持 HTTPS 下载，有如下限制：\n\n 1. 不能用 xxx.qiniudn.com 这样的二级域名，只能用 dn-xxx.qbox.me 域名。样例：<https://dn-abc.qbox.me/1.txt>\n 2. 使用自定义域名是付费的。我们并不建议使用自定义域名，但如确有需要，请联系我们的销售人员。\n\n## 断点续下载\n\n无论是公有资源还是私有资源，获得的下载 url 支持标准的 HTTP 断点续传协议。考虑到多数语言都有相应的断点续下载支持的成熟方法，七牛 GO-SDK\n并不提供断点续下载相关代码。\n\n# 资源管理\n\n资源管理包括对存储在七牛云存储上的文件进行查看、复制、移动和删除处理。 \n该节调用的函数第一个参数都为 `logger`，用于记录log，如果无需求，可以设置为nil。具体接口可以查阅 `github.com/qiniu/rpc`\n\n## 获取文件信息\n\n函数`rs.Client.Stat`可获取文件信息。\n\n \n \n var ret rs.Entry\n ret, err = rsCli.Stat(nil, bucket, key)\n if err != nil {\n //产生错误\n log.Println(\"rs.Stat failed:\", err)\n return\n }\n //处理返回值\n log.Println(ret)\n \n\n若有错误发生，则返回的err包含错误信息。若没错误返回的`ret`变量包含文件信息。 \n`ret`是为`rs.Entry`类型的结构体，其成员如下：\n\n \n \n type Entry struct {\n Hash string `json:\"hash\"`\n Fsize int64 `json:\"fsize\"`\n PutTime int64 `json:\"putTime\"`\n MimeType string `json:\"mimeType\"`\n Customer string `json:\"customer\"`\n }\n \n\n参阅: `rs.Entry`, `rs.Client.Stat`\n\n## 删除文件\n\n函数`rs.Client.Delete`可删除指定的文件。\n\n \n \n err = rsCli.Delete(nil, bucket, key)\n if err != nil {\n //产生错误\n log.Println(\"rs.Copy failed:\", err)\n return\n }\n \n\n若无错误发生则返回的err为nil，否则err包含错误信息。 \n参阅: `rs.Client.Delete`\n\n## 复制文件\n\n函数`rs.Client.Copy`可用来复制文件。\n\n \n \n err = rsCli.Copy(nil, bucketSrc, keySrc, bucketDest, keyDest)\n if err != nil {\n //产生错误\n log.Println(\"rs.Copy failed:\", err)\n return\n }\n \n\n参阅: `rs.Client.Move` `rs.Client.Copy`\n\n## 移动文件\n\n函数`rs.Client.Move`可用来移动文件。\n\n \n \n err = rsCli.Move(nil, bucketSrc, keySrc, bucketDest, keyDest)\n if err != nil {\n //产生错误\n log.Println(\"rs.Copy failed:\", err)\n return\n }\n \n\n参阅: `rs.Client.Move`\n\n## 批量获取文件信息\n\n函数`rs.Client.BatchStat`可批量获取文件信息。\n\n \n \n entryPathes := []rs.EntryPath {\n rs.EntryPath {\n Bucket: bucket1,\n Key: key1,\n },\n rs.EntryPath {\n Bucket: bucket2,\n Key: key2,\n },\n }\n var batchStatRets []rs.BatchStatItemRet\n batchStatRets, err = rsCli.BatchStat(nil, entryPathes) // []rs.BatchStatItemRet, error\n if err != nil {\n //产生错误\n log.Println(\"rs.BatchStat failed:\", err)\n return\n }\n //处理返回值\n for _, item := range batchStatRets {\n log.Println(item)\n }\n \n\n其中 `entryPathes`为`rs.EntryPath`结构体的数组切片。结构体`rs.EntryPath`中填写每个文件对应的bucket和key：\n\n \n \n type EntryPath struct {\n Bucket string\n Key string\n }\n \n\n`rs.BatchStat`会将文件信息(及成功/失败信息)，返回给由结构体`rs.BatchStatItemRet`组成的数组切片`batchStatRets`变量中。\n\n \n \n type BatchStatItemRet struct {\n Data Entry `json:\"data\"`\n Error string `json:\"error\"`\n Code int `json:\"code\"`\n }\n \n\n参阅: `rs.EntryPath`, `rs.BatchStatItemRet`, `rs.Client.BatchStat`\n\n## 批量删除文件\n\n函数`rs.Client.BatchDelete`可进行批量删除文件。\n\n \n \n entryPathes := []rs.EntryPath {\n rs.EntryPath {\n Bucket: bucket1,\n Key: key1,\n },\n rs.EntryPath {\n Bucket: bucket2,\n Key: key2,\n },\n }\n var batchDeleteRets []rs.BatchItemRet\n batchDeleteRets, err = rsCli.BatchDelete(nil, entryPathes)\n if err != nil {\n //产生错误\n log.Println(\"rs.BatchMove failed:\", err)\n return\n }\n for _, item := range batchDeleteRets {\n //遍历每个操作的返回结果\n log.Println(item.Code, item.Error)\n }\n \n\n和批量查看一样，`entryPathes`为`rs.EntryPath`结构体的数组切片。`rs.BatchDelete`会将删除操作的成功/失败信息返回给由结构体`rs.BatchItemRet`组成的数组切片`batchDeleteRets`变量中。其中`rs.BatchItemRet`结构体信息如下：\n\n \n \n type BatchItemRet struct {\n Error string `json:\"error\"`\n Code int `json:\"code\"`\n }\n \n\n参阅: `rs.EntryPath`, `rs.Client.BatchDelete`, `rs.BatchItemRet`\n\n## 批量复制文件\n\n函数`rs.Client.BatchCopy`可进行批量复制文件。\n\n \n \n // 每个复制操作都含有源文件和目标文件\n entryPairs := []rs.EntryPathPair {\n rs.EntryPathPair {\n Src: rs.EntryPath {\n Bucket: bucket1,\n Key: key1,\n },\n Dest: rs.EntryPath {\n Bucket: bucket2,\n Key: key2,\n },\n }, rs.EntryPathPair {\n Src: rs.EntryPath {\n Bucket: bucket3,\n Key: key3,\n },\n Dest: rs.EntryPath {\n Bucket: bucket4,\n Key: key4,\n },\n },\n }\n var batchCopyRets []rs.BatchItemRet\n batchCopyRets, err = rsCli.BatchCopy(nil, entryPairs)\n if err != nil {\n //产生错误\n log.Println(\"rs.BatchCopy failed:\", err)\n return\n }\n for _, item := range batchCopyRets {\n //遍历每个操作的返回结果\n log.Println(item.Code, item.Error)\n }\n \n\n批量复制需要指明每个操作的源路径和目标路径，`entryPairs`是一个`rs.EntryPathPair`结构体的数组切片。结构体`rs.EntryPathPair`结构如下：\n\n \n \n type EntryPathPair struct {\n Src EntryPath\n Dest EntryPath\n }\n \n\n同样，`rs.BatchCopy`会将复制操作的成功/失败信息返回给由结构体`rs.BatchItemRet`组成的数组切片`batchCopyRets`变量中\n\n参阅: `rs.BatchItemRet`, `rs.EntryPathPair`, `rs.Client.BatchCopy`\n\n## 批量移动文件\n\n批量移动和批量很类似，唯一的区别就是调用`rs.Client.BatchMove`\n\n \n \n // 每个复制操作都含有源文件和目标文件\n entryPairs := []rs.EntryPathPair {\n rs.EntryPathPair {\n Src: rs.EntryPath {\n Bucket: bucket1,\n Key: key1,\n },\n Dest: rs.EntryPath {\n Bucket: bucket2,\n Key: key2,\n },\n }, rs.EntryPathPair {\n Src: rs.EntryPath {\n Bucket: bucket3,\n Key: key3,\n },\n Dest: rs.EntryPath {\n Bucket: bucket4,\n Key: key4,\n },\n },\n }\n var batchMoveRets []rs.BatchItemRet\n batchCopyRets, err = rsCli.BatchMove(nil, entryPairs)\n if err != nil {\n //产生错误\n log.Println(\"rs.BatchMove failed:\", err)\n return\n }\n for _, item := range batchMoveRets {\n //遍历每个操作的返回结果\n log.Println(item.Code, item.Error)\n }\n \n\n参阅: `rs.EntryPathPair`, `rs.Client.BatchMove`\n\n## 高级批量操作\n\n批量操作不仅仅支持同时进行多个相同类型的操作，同时也支持不同的操作。\n\n \n \n ops := []string {\n rs.URIStat(bucket, key1),\n rs.URICopy(bucket, key1, bucket, key2), // 复制key1到key2\n rs.URIDelete(bucket, key1), // 删除key1\n rs.URIMove(bucket, key2, bucket, key1), //将key2移动到key1\n }\n \n rets := new([]rs.BatchItemRet)\n err = rsCli.Batch(nil, rets, ops)\n if err != nil {\n //产生错误\n log.Println(\"rs.Batch failed:\", err)\n return\n }\n for _, ret := range *rets {\n log.Println(ret.Code, ret.Error)\n }\n \n\n参阅: `rs.URIStat`, `rs.URICopy`, `rs.URIMove`, `rs.URIDelete`,\n`rs.Client.Batch`\n\n# 数据处理\n\n七牛支持在云端对图像，视频，音频等富媒体进行个性化处理。\n\n## 查看图像属性\n\nGO-SDK支持生成查看图片信息的URL，示意如下：\n\n \n \n func makeImageInfoUrl(imageUrl string) string {\n ii := fop.ImageInfo{}\n return ii.MakeRequest(imageUrl)\n }\n \n\n还可以已另一种方式，在程序中处理返回的图片信息：\n\n \n \n infoRet, err = ii.Call(nil, imageUrl)\n if err != nil {\n //产生错误\n log.Println(\"fop getImageInfo failed:\", err)\n return\n }\n log.Println(infoRet.Height, infoRet.Width, infoRet.ColorModel,\n infoRet.Format)\n \n\n参阅: `fop.ImageInfoRet`, `fop.ImageInfo`\n\n## 查看图片EXIF信息\n\n同样，本SDK也支持直接生成查看exif的URL：\n\n \n \n func makeExifUrl(imageUrl string) string {\n e := fop.Exif{}\n return e.MakeRequest(imageUrl)\n }\n \n\n也可以在程序中处理exif的信息：\n\n \n \n exifRet, err = ie.Call(nil, imageUrl)\n if err != nil {\n //产生错误\n log.Println(\"fop getExif failed:\", err)\n return\n }\n \n //处理返回结果\n for _, item := range exifRet {\n log.Println(item.Type, item.Val)\n }\n \n\n参阅: `fop.Exif`, `fop.ExifRet`, `fop.ExifValType`\n\n## 生成图片预览\n\n可以根据给定的文件URL和缩略图规格来生成缩略图的URL，代码：\n\n \n \n func makeViewUrl(imageUrl string) string {\n var view = fop.ImageView {\n //Mode int // 缩略模式\n //Width int // Width = 0 表示不限定宽度\n //Height int // Height = 0 表示不限定高度\n //Quality int // 质量, 1-100\n //Format string // 输出格式，如jpg, gif, png, tif等等\n }\n return view.MakeRequest(imageUrl)\n }\n \n\n参阅: `fop.ImageView`\n\n# 高级资源管理(rsf)\n\n## 批量获取文件列表\n\n根据指定的前缀，获取对应前缀的文件列表，正常使用情景如下：\n\n \n \n func listAll(l rpc.Logger, rs *rsf.Client, bucketName string, prefix string) {\n \n var entries []rsf.ListItem\n var marker = \"\"\n var err error\n var limit = 1000\n \n for err == nil {\n entries, marker, err = rs.ListPrefix(l, bucketName,\n prefix, marker, limit)\n for _, item := range entries {\n //处理 item\n log.Print(\"item:\", item)\n }\n }\n if err != io.EOF {\n //非预期的错误\n log.Print(\"listAll failed:\", err)\n }\n }\n \n\n参阅: `rsf.ListPreFix`\n\n# API参考手册\n\n * [对象存储API参考手册](https://developer.qiniu.com/kodo/api/1731/api-overview)\n * [数据处理API参考手册](https://developer.qiniu.com/dora)\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎到我们的技术论坛参与讨论。\n\n * [技术论坛](http://segmentfault.com/qiniu) \\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单](https://support.qiniu.com/tickets/new) \\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客](http://blog.qiniu.com) \\- 这里会持续更新发布市场活动和技术分享文章\n * [微博](http://weibo.com/qiniutek)\n * [常见问题](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am 'Added some feature'\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright (c) 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Java SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > Java SDK\n\n# Java SDK\n\n最近更新时间: 2023-08-21 15:50:48\n\n# 简介\n\n此 SDK 适用于 Java 8 及以上版本。使用此 SDK\n构建您的网络应用程序，能让您以非常便捷地方式将数据安全地存储到七牛云上。无论您的网络应用是一个网站程序，还是包括从云端（服务端程序）到终端（手持设备应用）的架构服务或应用，通过七牛云及其\nSDK，都能让您应用程序的终端用户高速上传和下载，同时也让您的服务端更加轻盈。\n\nJava SDK 属于七牛服务端SDK之一，主要有如下功能：\n\n 1. 提供生成客户端上传所需的上传凭证的功能\n 2. 提供文件从服务端直接上传七牛的功能\n 3. 提供对七牛空间中文件进行管理的功能\n 4. 提供对七牛空间中文件进行处理的功能\n 5. 提供七牛融合CDN相关的刷新，预取，日志功能\n 6. 提供七牛视频监控QVS设备管理、流管理等功能\n\n# 开源\n\n * [Java SDK 项目地址 __](https://github.com/qiniu/java-sdk)\n * [Java SDK 发布地址 __](https://github.com/qiniu/java-sdk/releases)\n * [Java SDK 历史文档](https://developer.qiniu.com/kodo/sdk/java-sdk-6)\n\n# 安装\n\n * 使用Gradle\n * 使用Maven\n * 手动安装\n\n## 注意\n\n * 从 7.2.24 开始，okhttp3 升级到 3.14.2，其要求 java 1.8 及以上。\n * 若为 java 1.7 ，请手动指定 okhttp3 依赖 3.12，要求 3.12.3 及以上， `com.squareup.okhttp3:okhttp:3.12.3`\n\n \n \n compile ('com.qiniu:qiniu-java-sdk:7.13.1') {\n exclude group: 'com.squareup.okhttp3', module: 'okhttp'\n }\n compile 'com.squareup.okhttp3:okhttp:3.12.6'\n \n\n### Gradle\n\n \n \n compile 'com.qiniu:qiniu-java-sdk:7.13.+'\n \n\n### Maven\n\n \n \n <dependency>\n <groupId>com.qiniu</groupId>\n <artifactId>qiniu-java-sdk</artifactId>\n <version>[7.13.0, 7.13.99]</version>\n </dependency>\n \n\n这里的`version`指定了一个版本范围，每次更新`pom.xml`的时候会尝试去下载`7.7.x`版本中的最新版本，你可以手动指定一个固定的版本。\n\n### 手动下载\n\n请尽量使用包管理工具自动解决依赖问题。如果条件实在不满足，只能通过手动下载jar包的方式来解决。本项目自身jar及依赖的第三方库如下：\n\nJava SDK依赖的第三方库及其版本如下：\n\n \n \n <dependencies>\n <dependency>\n <groupId>com.squareup.okhttp3</groupId>\n <artifactId>okhttp</artifactId>\n <version>3.14.2</version>\n <scope>compile</scope>\n </dependency>\n <dependency>\n <groupId>com.google.code.gson</groupId>\n <artifactId>gson</artifactId>\n <version>2.8.5</version>\n <scope>compile</scope>\n </dependency>\n <dependency>\n <groupId>com.qiniu</groupId>\n <artifactId>happy-dns-java</artifactId>\n <version>0.1.6</version>\n <scope>test</scope>\n </dependency>\n <dependency>\n <groupId>junit</groupId>\n <artifactId>junit</artifactId>\n <version>4.12</version>\n <scope>test</scope>\n </dependency>\n </dependencies>\n \n\n库名称 | 库项目地址 | 库下载地址 \n---|---|--- \nqiniu-java-sdk | [链接🔗 __](https://github.com/qiniu/java-sdk)| [链接🔗 __](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22qiniu-java-sdk%22) \nhappy-dns-java | [链接🔗 __](https://github.com/qiniu/happy-dns-java)| [链接🔗 __](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22happy-dns-java%22) \nokhttp3 | [链接🔗 __](https://github.com/square/okhttp)| [链接🔗 __](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.okhttp3%22) \nokio | [链接🔗 __](https://github.com/square/okio)| [链接🔗 __](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.okio%22) \ngson | [链接🔗 __](https://github.com/google/gson)| [链接🔗 __](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.google.code.gson%22) \njunit | [链接🔗 __](http://junit.org/junit4/)| [链接🔗 __](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22junit%22) \n \n可以点击每个库的下载链接，然后选择对应的jar进行下载，然后引入到项目中。\n\n# 鉴权\n\nJava SDK的所有的功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的`Access Key`和`Secret\nKey`，这对密钥可以通过如下步骤获得：\n\n 1. 点击[注册🔗 __](https://portal.qiniu.com/signup)开通 七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里🔗 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n# 文件上传\n\n * 上传流程\n * 客户端上传凭证\n * 简单上传凭证\n * 覆盖上传凭证\n * 自定义上传回复凭证\n * 带回调业务服务器的凭证\n * 带数据处理的凭证\n * 带自定义参数的凭证\n * 综合上传凭证\n * 服务器直传\n * 构建配置类\n * 自定义上传域名\n * 设置请求协议为http\n * 文件上传\n * 字节数组上传\n * 数据流上传\n * 断点续传\n * 自定义参数上传\n * 解析自定义回复内容\n * 业务服务器验证存储服务回调\n\n## 上传流程\n\n文件上传分为客户端上传（主要是指网页端和移动端等面向终端用户的场景）和服务端上传两种场景，具体可以参考文档[业务流程](https://developer.qiniu.com/kodo/manual/1205/programming-\nmodel)。\n\n * 客户端上传：Java 编写的服务端仅提供上传需要的凭证，网页端和移动端等客户端从服务端获取此凭证后使用客户端相应的 SDK 进行上传操作\n * 服务端上传：文件在服务端或者服务端作为文件的中转站，使用此 Java SDK 上传文件至七牛云端\n\n服务端SDK在上传方面主要提供两种功能\n\n * 生成客户端上传所需要的上传凭证\n * 服务端上传文件到七牛云端\n\n## 客户端上传凭证\n\n客户端（移动端或者Web端）上传文件的时候，需要从客户自己的业务服务器获取上传凭证，而这些上传凭证是通过服务端的SDK来生成的，然后通过客户自己的业务API分发给客户端使用。根据上传的业务需求不同，七牛云Java\nSDK支持丰富的上传凭证生成方式。\n\n### 简单上传的凭证\n\n最简单的上传凭证只需要`AccessKey`，`SecretKey`和`Bucket`就可以。\n\n \n \n String accessKey = \"access key\";\n String secretKey = \"secret key\";\n String bucket = \"bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n String upToken = auth.uploadToken(bucket);\n System.out.println(upToken);\n \n\n### 覆盖上传的凭证\n\n覆盖上传除了需要`简单上传`所需要的信息之外，还需要想进行覆盖的文件名称，这个文件名称同时是客户端上传代码中指定的文件名，两者必须一致。\n\n \n \n String accessKey = \"access key\";\n String secretKey = \"secret key\";\n String bucket = \"bucket name\";\n String key = \"file key\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n String upToken = auth.uploadToken(bucket, key);\n System.out.println(upToken);\n \n\n### 自定义上传回复的凭证\n\n默认情况下，文件上传到七牛之后，在没有设置`returnBody`或者`回调`相关的参数情况下，七牛返回给上传端的回复格式为`hash`和`key`，例如：\n\n \n \n {\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"key\":\"qiniu.jpg\"}\n \n\n有时候我们希望能自定义这个返回的JSON格式的内容，可以通过设置`returnBody`参数来实现，在`returnBody`中，我们可以使用七牛支持的[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)和[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)。\n\n \n \n String accessKey = \"access key\";\n String secretKey = \"secret key\";\n String bucket = \"bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n StringMap putPolicy = new StringMap();\n putPolicy.put(\"returnBody\", \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"bucket\\\":\\\"$(bucket)\\\",\\\"fsize\\\":$(fsize)}\");\n long expireSeconds = 3600;\n String upToken = auth.uploadToken(bucket, null, expireSeconds, putPolicy);\n System.out.println(upToken);\n \n\n则文件上传到七牛之后，收到的回复内容如下：\n\n \n \n {\"key\":\"qiniu.jpg\",\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"bucket\":\"if-bc\",\"fsize\":39335}\n \n\n### 带回调业务服务器的凭证\n\n上面生成的`自定义上传回复`的上传凭证适用于上传端（无论是客户端还是服务端）和七牛服务器之间进行直接交互的情况下。在客户端上传的场景之下，有时候客户端需要在文件上传到七牛之后，从业务服务器获取相关的信息，这个时候就要用到七牛的上传回调及相关回调参数的设置。\n\n \n \n String accessKey = \"access key\";\n String secretKey = \"secret key\";\n String bucket = \"bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n StringMap putPolicy = new StringMap();\n putPolicy.put(\"callbackUrl\", \"http://api.example.com/qiniu/upload/callback\");\n putPolicy.put(\"callbackBody\", \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"bucket\\\":\\\"$(bucket)\\\",\\\"fsize\\\":$(fsize)}\");\n putPolicy.put(\"callbackBodyType\", \"application/json\");\n long expireSeconds = 3600;\n String upToken = auth.uploadToken(bucket, null, expireSeconds, putPolicy);\n System.out.println(upToken);\n \n\n在使用了上传回调的情况下，客户端收到的回复就是业务服务器响应七牛的JSON格式内容。 \n通常情况下，我们建议使用`application/json`格式来设置`callbackBody`，保持数据格式的统一性。实际情况下，`callbackBody`也支持`application/x-www-\nform-urlencoded`格式来组织内容，这个主要看业务服务器在接收到`callbackBody`的内容时如何解析。例如：\n\n \n \n String accessKey = \"access key\";\n String secretKey = \"secret key\";\n String bucket = \"bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n StringMap putPolicy = new StringMap();\n putPolicy.put(\"callbackUrl\", \"http://api.example.com/qiniu/upload/callback\");\n putPolicy.put(\"callbackBody\", \"key=$(key)&hash=$(etag)&bucket=$(bucket)&fsize=$(fsize)\");\n long expireSeconds = 3600;\n String upToken = auth.uploadToken(bucket, null, expireSeconds, putPolicy);\n System.out.println(upToken);\n \n\n### 带数据处理的凭证\n\n存储服务支持在文件上传到七牛之后，立即对其进行多种指令的数据处理，这个只需要在生成的上传凭证中指定相关的处理参数即可。\n\n \n \n String accessKey = \"access key\";\n String secretKey = \"secret key\";\n String bucket = \"bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n StringMap putPolicy = new StringMap();\n \n //数据处理指令，支持多个指令\n String saveMp4Entry = String.format(\"%s:avthumb_test_target.mp4\", bucket);\n String saveJpgEntry = String.format(\"%s:vframe_test_target.jpg\", bucket);\n String avthumbMp4Fop = String.format(\"avthumb/mp4|saveas/%s\", UrlSafeBase64.encodeToString(saveMp4Entry));\n String vframeJpgFop = String.format(\"vframe/jpg/offset/1|saveas/%s\", UrlSafeBase64.encodeToString(saveJpgEntry));\n \n //将多个数据处理指令拼接起来\n String persistentOpfs = StringUtils.join(new String[]{\n avthumbMp4Fop, vframeJpgFop\n }, \";\");\n putPolicy.put(\"persistentOps\", persistentOpfs);\n \n //数据处理队列名称，必填\n putPolicy.put(\"persistentPipeline\", \"mps-pipe1\");\n \n //数据处理完成结果通知地址\n putPolicy.put(\"persistentNotifyUrl\", \"http://api.example.com/qiniu/pfop/notify\");\n \n long expireSeconds = 3600;\n String upToken = auth.uploadToken(bucket, null, expireSeconds, putPolicy);\n System.out.println(upToken); \n \n\n队列 pipeline 请参阅[创建私有队列 __](https://portal.qiniu.com/dora/media-\ngate/pipeline)；转码操作具体参数请参阅[音视频转码](https://developer.qiniu.com/dora/api/audio-\nand-video-transcoding-avthumb)；saveas\n请参阅[处理结果另存](https://developer.qiniu.com/dora/api/processing-results-save-\nsaveas)。\n\n### 带自定义参数的凭证\n\n存储服务支持客户端上传文件的时候定义一些自定义参数，这些参数可以在`returnBody`和`callbackBody`里面和七牛内置支持的魔法变量（即系统变量）通过相同的方式来引用。这些自定义的参数名称必须以`x:`开头。例如客户端上传的时候指定了自定义的参数`x:user`和`x:age`分别是`String`和`int`类型。那么可以通过下面的方式引用：\n\n \n \n putPolicy.put(\"returnBody\", \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"bucket\\\":\\\"$(bucket)\\\",\\\"fsize\\\":$(fsize),\\\"user\\\":\\\"$(x:user)\\\",\\\"age\\\",$(x:age)}\");\n \n\n或者\n\n \n \n putPolicy.put(\"callbackBody\", \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"bucket\\\":\\\"$(bucket)\\\",\\\"fsize\\\":$(fsize),\\\"user\\\":\\\"$(x:user)\\\",\\\"age\\\",$(x:age)}\");\n \n\n### 综合上传凭证\n\n上面生成上传凭证的方法，都是通过设置[上传策略🔗](https://developer.qiniu.com/kodo/manual/1206/put-\npolicy)相关的参数来支持的，这些参数可以通过不同的组合方式来满足不同的业务需求，可以灵活地组织你所需要的上传凭证。\n\n### 上传凭证额外参数\n\n默认会拒绝不在预定义之中的参数。即：\n\n \n \n String upToken = auth.uploadToken(bucket, key, expireSeconds, putPolicy, true);\n \n\n若允许添加额外参数，可以将参数设置为`false`。\n\n \n \n String upToken = auth.uploadToken(bucket, key, expireSeconds, putPolicy, false);\n \n\n## 服务端直传\n\n服务端直传是指客户利用七牛服务端SDK从服务端直接上传文件到七牛云，交互的双方一般都在机房里面，所以服务端可以自己生成上传凭证，然后利用此SDK中的上传逻辑进行上传，最后从七牛云获取上传的结果，这个过程中由于双方都是业务服务器，所以很少利用到上传回调的功能，而是直接自定义`returnBody`来获取自定义的回复内容。\n\n### 构建配置类\n\n存储支持空间创建在不同的机房，在使用Java\nSDK中的`UploadManager`上传文件之前，必须要构建一个上传用的`Configuration`对象，在该对象中，可以指定空间对应的`Region`以及其他的一些影响上传的参数。\n\n \n \n //构造一个带指定Region对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n cfg.resumableUploadAPIVersion = Configuration.ResumableUploadAPIVersion.V2;// 指定分片上传版本\n //...其他参数参考类注释\n \n UploadManager uploadManager = new UploadManager(cfg);\n //...生成上传凭证，然后准备上传\n \n \n\n跨区域双活指定`RegionGroup`(内测功能，需要工单申请开通跨区域双活功能之后使用)\n\n \n \n Region region0 = Region.region0();\n Region region1 = Region.region1();\n RegionGroup regionGroup = new RegionGroup();\n regionGroup.addRegion(region0);\n regionGroup.addRegion(region1);\n Configuration config = new Configuration(regionGroup);\n config.resumableUploadAPIVersion = Configuration.ResumableUploadAPIVersion.V2;// 指定分片上传版本\n \n\n其中关于`Region`对象和机房的关系如下：\n\n机房 | Region \n---|--- \n华东 | `Region.region0()`, `Region.huadong()` \n华北 | `Region.region1()`, `Region.huabei()` \n华南 | `Region.region2()`, `Region.huanan()` \n北美 | `Region.regionNa0()`, `Region.beimei()` \n东南亚 | `Region.regionAs0()`, `Region.xinjiapo()` \n \n### 注意\n\n * 若不指定 `Region` 或 `Region.autoRegion()` ，则会使用 自动判断 区域，使用相应域名处理。\n * 如果可以明确 区域 的话，最好指定固定区域，这样可以少一步网络请求，少一步出错的可能。\n\n### 自定义区域域名\n\n \n \n Region region = new Region.Builder()\n .region(\"z0\")\n .accUpHost(\"up.qiniup.com\")\n .srcUpHost(\"upload.qiniup.com\")\n .iovipHost(\"iovip.qiniuio.com\")\n .rsHost(\"rs.qiniu.com\")\n .rsfHost(\"rsf.qiniu.com\")\n .apiHost(\"api.qiniu.com\")\n .build();\n Configuration cfg = new Configuration(region);\n cfg.resumableUploadAPIVersion = Configuration.ResumableUploadAPIVersion.V2;// 指定分片上传版本\n \n\n### 设置请求协议为http\n\n \n \n Configuration cfg = new Configuration(zone);\n cfg.resumableUploadAPIVersion = Configuration.ResumableUploadAPIVersion.V2;// 指定分片上传版本\n cfg.useHttpsDomains = false;\n UploadManager uploadManager = new UploadManager(cfg);\n \n\n### 文件上传\n\n最简单的就是上传本地文件，直接指定文件的完整路径即可上传。\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n cfg.resumableUploadAPIVersion = Configuration.ResumableUploadAPIVersion.V2;// 指定分片上传版本\n //...其他参数参考类注释\n \n UploadManager uploadManager = new UploadManager(cfg);\n //...生成上传凭证，然后准备上传\n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n String bucket = \"your bucket name\";\n //如果是Windows情况下，格式是 D:\\\\qiniu\\\\test.png\n String localFilePath = \"/home/qiniu/test.png\";\n //默认不指定key的情况下，以文件内容的hash值作为文件名\n String key = null;\n \n Auth auth = Auth.create(accessKey, secretKey);\n String upToken = auth.uploadToken(bucket);\n \n try {\n Response response = uploadManager.put(localFilePath, key, upToken);\n //解析上传成功的结果\n DefaultPutRet putRet = new Gson().fromJson(response.bodyString(), DefaultPutRet.class);\n System.out.println(putRet.key);\n System.out.println(putRet.hash);\n } catch (QiniuException ex) {\n ex.printStackTrace();\n if (ex.response != null) {\n System.err.println(ex.response);\n \n try {\n String body = ex.response.toString();\n System.err.println(body);\n } catch (Exception ignored) {\n }\n }\n }\n \n\n### 字节数组上传\n\n可以支持将内存中的字节数组上传到空间中。\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n cfg.resumableUploadAPIVersion = Configuration.ResumableUploadAPIVersion.V2;// 指定分片上传版本\n //...其他参数参考类注释\n \n UploadManager uploadManager = new UploadManager(cfg);\n //...生成上传凭证，然后准备上传\n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n String bucket = \"your bucket name\";\n \n //默认不指定key的情况下，以文件内容的hash值作为文件名\n String key = null;\n \n try {\n byte[] uploadBytes = \"hello qiniu cloud\".getBytes(\"utf-8\");\n Auth auth = Auth.create(accessKey, secretKey);\n String upToken = auth.uploadToken(bucket);\n \n try {\n Response response = uploadManager.put(uploadBytes, key, upToken);\n //解析上传成功的结果\n DefaultPutRet putRet = new Gson().fromJson(response.bodyString(), DefaultPutRet.class);\n System.out.println(putRet.key);\n System.out.println(putRet.hash);\n } catch (QiniuException ex) {\n ex.printStackTrace();\n if (ex.response != null) {\n System.err.println(ex.response);\n \n try {\n String body = ex.response.toString();\n System.err.println(body);\n } catch (Exception ignored) {\n }\n }\n }\n } catch (UnsupportedEncodingException ex) {\n //ignore\n }\n \n\n### 数据流上传\n\n这里演示的是`InputStream`对象的上传，适用于所有的`InputStream`子类。这里的`ByteInputStream`只用于演示目的，实际用法根据情况而定。\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n cfg.resumableUploadAPIVersion = Configuration.ResumableUploadAPIVersion.V2;// 指定分片上传版本\n //...其他参数参考类注释\n \n UploadManager uploadManager = new UploadManager(cfg);\n //...生成上传凭证，然后准备上传\n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n String bucket = \"your bucket name\";\n \n //默认不指定key的情况下，以文件内容的hash值作为文件名\n String key = null;\n \n try {\n byte[] uploadBytes = \"hello qiniu cloud\".getBytes(\"utf-8\");\n ByteArrayInputStream byteInputStream=new ByteArrayInputStream(uploadBytes);\n Auth auth = Auth.create(accessKey, secretKey);\n String upToken = auth.uploadToken(bucket);\n \n try {\n Response response = uploadManager.put(byteInputStream,key,upToken,null, null);\n //解析上传成功的结果\n DefaultPutRet putRet = new Gson().fromJson(response.bodyString(), DefaultPutRet.class);\n System.out.println(putRet.key);\n System.out.println(putRet.hash);\n } catch (QiniuException ex) {\n ex.printStackTrace();\n if (ex.response != null) {\n System.err.println(ex.response);\n \n try {\n String body = ex.response.toString();\n System.err.println(body);\n } catch (Exception ignored) {\n }\n }\n }\n } catch (UnsupportedEncodingException ex) {\n //ignore\n }\n \n\n### 断点续上传\n\n断点续传是在分片上传的基础上实现。SDK 内置两种上传方式：表单上传和分片上传。表单上传使用一个 HTTP POST\n请求完成文件的上传，因此比较适合较小的文件。相比而言，分片上传比较适合上传比较大的文件（例如数百 MB 或更大）。 \n若需深入了解上传方式之间的区别，请参阅上传类型中\n[表单上传](https://developer.qiniu.com/kodo/manual/1272/form-upload) 、[分片上传 v1\n版](https://developer.qiniu.com/kodo/manual/1650/chunked-upload) 和 [分片上传 v2\n版](https://developer.qiniu.com/kodo/6364/multipartupload-interface) 接口说明。 \n可以选择分片上传版本，推荐 Configuration.ResumableUploadAPIVersion.V2，表示 分片上传 v2 版，默认\nConfiguration.ResumableUploadAPIVersion.V1，表示 分片上传 v1 版。\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n cfg.resumableUploadAPIVersion = Configuration.ResumableUploadAPIVersion.V2;// 指定分片上传版本\n cfg.resumableUploadMaxConcurrentTaskCount = 2; // 设置分片上传并发，1：采用同步上传；大于1：采用并发上传\n //...其他参数参考类注释\n \n //...生成上传凭证，然后准备上传\n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n String bucket = \"your bucket name\";\n //如果是Windows情况下，格式是 D:\\\\qiniu\\\\test.png\n String localFilePath = \"/home/qiniu/test.mp4\";\n //默认不指定key的情况下，以文件内容的hash值作为文件名\n String key = null;\n \n Auth auth = Auth.create(accessKey, secretKey);\n String upToken = auth.uploadToken(bucket);\n \n String localTempDir = Paths.get(System.getenv(\"java.io.tmpdir\"), bucket).toString();\n try {\n //设置断点续传文件进度保存目录\n FileRecorder fileRecorder = new FileRecorder(localTempDir);\n UploadManager uploadManager = new UploadManager(cfg, fileRecorder);\n try {\n Response response = uploadManager.put(localFilePath, key, upToken);\n //解析上传成功的结果\n DefaultPutRet putRet = new Gson().fromJson(response.bodyString(), DefaultPutRet.class);\n System.out.println(putRet.key);\n System.out.println(putRet.hash);\n } catch (QiniuException ex) {\n ex.printStackTrace();\n if (ex.response != null) {\n System.err.println(ex.response);\n \n try {\n String body = ex.response.toString();\n System.err.println(body);\n } catch (Exception ignored) {\n }\n }\n }\n } catch (IOException ex) {\n ex.printStackTrace();\n }\n \n\n### 自定义参数上传\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n cfg.resumableUploadAPIVersion = Configuration.ResumableUploadAPIVersion.V2;// 指定分片上传版本\n //...其他参数参考类注释\n \n //...生成上传凭证，然后准备上传\n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n String bucket = \"your bucket name\";\n //如果是Windows情况下，格式是 D:\\\\qiniu\\\\test.png\n String localFilePath = \"/home/qiniu/test.mp4\";\n //默认不指定key的情况下，以文件内容的hash值作为文件名\n //设置上传后的文件名称\n String key = \"qiniu_test.jpg\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n \n //上传自定义参数，自定义参数名称需要以 x:开头\n StringMap params = new StringMap();\n params.put(\"x:fname\",\"123.jpg\");\n params.put(\"x:age\",20);\n \n //上传策略\n StringMap policy = new StringMap();\n //自定义上传后返回内容，返回自定义参数，需要设置 x:参数名称，注意下面\n policy.put(\"returnBody\", \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"fname\\\":\\\"$(x:fname)\\\",\\\"age\\\",$(x:age)}\");\n //生成上传token\n String upToken = auth.uploadToken(bucket, key, 3600, policy);\n try {\n Response response = uploadManager.put(localFilePath, key, upToken,params,null,false);\n System.out.println(response.bodyString());\n } catch (QiniuException ex) {\n ex.printStackTrace();\n if (ex.response != null) {\n System.err.println(ex.response);\n \n try {\n String body = ex.response.toString();\n System.err.println(body);\n } catch (Exception ignored) {\n }\n }\n }\n \n\n## 解析自定义回复内容\n\n有些情况下，七牛返回给上传端的内容不是默认的`hash`和`key`形式，这种情况下，可能出现在自定义`returnBody`或者自定义了`callbackBody`的情况下，前者一般是服务端直传的场景，而后者则是接受上传回调的场景，这两种场景之下，都涉及到需要将自定义的回复内容解析为`Java`的类对象，一般建议在交互过程中，都采用`JSON`的方式，这样处理起来方法比较一致，而且`JSON`的方法最通用。\n\n遇到诸如自定义`returnBody`的情况：\n\n \n \n putPolicy.put(\"returnBody\", \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"bucket\\\":\\\"$(bucket)\\\",\\\"fsize\\\":$(fsize)}\");\n \n\n或者是自定义了`callbackBody`的情况：\n\n \n \n putPolicy.put(\"callbackBody\", \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"bucket\\\":\\\"$(bucket)\\\",\\\"fsize\\\":$(fsize)}\");\n \n\n我们只需要自己定义了对应的类，例如：\n\n \n \n class MyPutRet {\n public String key; // 文件保存的 key\n public String hash; // 文件保存的 Etag\n public String bucket; // 文件保存的 bucket\n public long fsize; // 文件的大小，单位：B\n }\n \n\n然后在获取到上传回复的`Response`对象时，使用如下的方法就可以转为自定义回复的类对象了：\n\n \n \n MyPutRet myPutRet=response.jsonToObject(MyPutRet.class);\n \n\n## 业务服务器验证存储服务回调\n\n在上传策略里面设置了上传回调相关参数的时候，七牛在文件上传到服务器之后，会主动地向`callbackUrl`发送POST请求的回调，回调的内容为`callbackBody`模版所定义的内容，如果这个模版里面引用了[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)或者[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)，那么这些变量会被自动填充对应的值，然后在发送给业务服务器。\n\n业务服务器在收到来自七牛的回调请求的时候，可以根据请求头部的`Authorization`字段来进行验证，查看该请求是否是来自七牛的未经篡改的请求。具体可以参考七牛的[回调鉴权](https://developer.qiniu.com/kodo/kb/1409/seven-\ncattle-callback-and-callback-authentication)。\n\n注意：业务端服务器回调鉴权的Content-Type类型应该与上传策略中指定的callbackBodyType相同，默认为\napplication/x-www-form-urlencoded，当 Content-Type 为 application/x-www-form-\nurlencoded 时，签名内容必须包括请求内容。当 Content-Type 为 application/json 时，签名内容不包括请求内容。\n\n \n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n /*\n * 这两个参数就是在定义PutPolicy参数时指定的内容\n */\n \n //回调地址\n String callbackUrl = \"http://api.example.com/qiniu/callback\";\n //定义回调内容的组织格式，与上传策略中的callbackBodyType要保持一致\n //String callbackBodyType = \"application/x-www-form-urlencoded\"; //回调鉴权的签名包括请求内容callbackBody\n String callbackBodyType = \"application/json\";//回调鉴权的签名不包括请求内容\n \n /**\n * 这两个参数根据实际所使用的HTTP框架进行获取\n */\n //通过获取请求的HTTP头部Authorization字段获得\n String callbackAuthHeader = \"xxx\";\n //通过读取回调POST请求体获得，不要设置为null\n byte[] callbackBody = null;\n \n \n Auth auth = Auth.create(accessKey, secretKey);\n //检查是否为合法的回调请求\n boolean validCallback = auth.isValidCallback(callbackAuthHeader, callbackUrl, callbackBody, callbackBodyType);\n if (validCallback) {\n //继续处理其他业务逻辑\n } else {\n //这是哪里的请求，被劫持，篡改了吧？\n }\n \n \n\n# 下载文件\n\n * 公开空间\n * 私有空间\n\n文件下载分为公开空间的文件下载和私有空间的文件下载。\n\n## 公开空间\n\n### 手动拼接方式\n\n对于公开空间，其访问的链接主要是将空间绑定的域名拼接上空间里面的文件名即可访问，标准情况下需要在拼接链接之前，将文件名进行`urlencode`以兼容不同的字符。如果有其他访问处理需求，在文件名之后继续拼接即可。\n\n \n \n String fileName = \"a/b/qiniu.jpg\";\n // domainOfBucket 中的域名为用户 bucket 绑定的下载域名，下面域名仅为示例，不可使用\n String domainOfBucket = \"http://mock.qiniu.com\";\n String encodedFileName = URLEncoder.encode(fileName, \"utf-8\").replace(\"+\", \"%20\");\n String finalUrl = String.format(\"%s/%s\", domainOfBucket, encodedFileName);\n System.out.println(finalUrl);\n \n\n### sdk 自动生成方式\n\nsdk 封装了下载 URL 的生成，只需要输入下载所需参数即可。已支持多媒体处理命令等。\n\n \n \n // domain 用户 bucket 绑定的下载域名 eg: mock.qiniu.com【必须】\n // useHttps 是否使用 https【必须】\n // key 下载资源在七牛云存储的 key【必须】\n DownloadUrl url = new DownloadUrl(domain, useHttps, key);\n url.setAttname(attname) // 配置 attname\n .setFop(fop) // 配置 fop\n .setStyle(style, styleSeparator, styleParam) // 配置 style\n String urlString = url.buildURL();\n System.out.println(urlString);\n \n\n## 私有空间\n\n### 手动拼接方式\n\n对于私有空间，首先需要按照公开空间的文件访问方式构建对应的公开空间访问链接，然后再对这个链接进行私有授权签名。\n\n \n \n String fileName = \"公司/存储/qiniu.jpg\";\n String domainOfBucket = \"http://devtools.qiniu.com\";\n String encodedFileName = URLEncoder.encode(fileName, \"utf-8\").replace(\"+\", \"%20\");\n String publicUrl = String.format(\"%s/%s\", domainOfBucket, encodedFileName);\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n Auth auth = Auth.create(accessKey, secretKey);\n long expireInSeconds = 3600;//1小时，可以自定义链接过期时间\n String finalUrl = auth.privateDownloadUrl(publicUrl, expireInSeconds);\n System.out.println(finalUrl);\n \n\n#### sdk 自动生成方式\n\nsdk 封装了下载 URL 的生成，只需要输入下载所需参数即可。已支持多媒体处理命令，过期时间 e 和 签名 token 等。\n\n \n \n // domain 下载 domain, eg: qiniu.com【必须】\n // useHttps 是否使用 https【必须】\n // key 下载资源在七牛云存储的 key【必须】\n DownloadUrl url = new DownloadUrl(domain, useHttps, key);\n url.setAttname(attname) // 配置 attname\n .setFop(fop) // 配置 fop\n .setStyle(style, styleSeparator, styleParam) // 配置 style\n \n // 带有效期\n long expireInSeconds = 3600;//1小时，可以自定义链接过期时间\n long deadline = System.currentTimeMillis()/1000 + expireInSeconds;\n Auth auth = Auth.create(\"your access key\", \"your secret key\");\n String urlString = url.buildURL(auth, deadline);\n System.out.println(urlString);\n \n\n# 资源管理\n\n资源管理包括的主要功能有：\n\n * 获取文件信息\n * 修改文件类型\n * 移动或重命名文件\n * 复制文件副本\n * 删除空间中的文件\n * 设置或更新文件生存时间\n * 获取空间文件列表\n * 抓取网络资源到空间\n * 资源管理批量操作\n * 批量获取文件信息\n * 批量修改文件类型\n * 批量删除文件\n * 批量移动或重命名文件\n * 批量复制文件\n * 批量解冻归档存储类型文件\n * 批量混合指令操作\n * 更新镜像存储空间中的文件内容\n * 更新镜像存储空间中文件内容\n\n## 获取文件信息\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n String bucket = \"your bucket name\";\n String key = \"your file key\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n try {\n FileInfo fileInfo = bucketManager.stat(bucket, key);\n System.out.println(fileInfo.hash);\n System.out.println(fileInfo.fsize);\n System.out.println(fileInfo.mimeType);\n System.out.println(fileInfo.putTime);\n } catch (QiniuException ex) {\n System.err.println(ex.response.toString());\n }\n \n\n## 修改文件类型\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n String key = \"your file key\";\n String newMimeType = \"new mime type\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n \n //修改文件类型\n try {\n bucketManager.changeMime(bucket, key, newMimeType);\n } catch (QiniuException ex) {\n System.out.println(ex.response.toString());\n }\n \n\n## 移动或重命名文件\n\n移动操作本身支持移动文件到相同，不同空间中，在移动的同时也可以支持文件重命名。唯一的限制条件是，移动的源空间和目标空间必须在同一个机房。\n\n源空间 | 目标空间 | 源文件名 | 目标文件名 | 描述 \n---|---|---|---|--- \nBucketA | BucketA | KeyA | KeyB | 相当于同空间文件重命名 \nBucketA | BucketB | KeyA | KeyA | 移动文件到BucketB，文件名一致 \nBucketA | BucketB | KeyA | KeyB | 移动文件到BucketB，文件名变成KeyB \n \n`move`操作支持强制覆盖选项，即如果目标文件已存在，可以设置强制覆盖参数`force`来覆盖那个文件的内容。\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String fromBucket = \"from bucket name\";\n String fromKey = \"from key\";\n String toBucket = \"to bucket name\";\n String toKey = \"to key\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n try {\n bucketManager.move(fromBucket, fromKey, toBucket, toKey);\n } catch (QiniuException ex) {\n //如果遇到异常，说明移动失败\n System.err.println(ex.code());\n System.err.println(ex.response.toString());\n }\n \n\n## 复制文件副本\n\n文件的复制和文件移动其实操作一样，主要的区别是移动后源文件不存在了，而复制的结果是源文件还存在，只是多了一个新的文件副本。\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String fromBucket = \"from bucket name\";\n String fromKey = \"from key\";\n String toBucket = \"to bucket name\";\n String toKey = \"to key\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n try {\n bucketManager.copy(fromBucket, fromKey, toBucket, toKey);\n } catch (QiniuException ex) {\n //如果遇到异常，说明复制失败\n System.err.println(ex.code());\n System.err\n }\n \n\n## 删除空间中的文件\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n String key = \"your file key\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n try {\n bucketManager.delete(bucket, key);\n } catch (QiniuException ex) {\n //如果遇到异常，说明删除失败\n System.err.println(ex.code());\n System.err.println(ex.response.toString());\n }\n \n\n## 设置或更新文件的生存时间\n\n可以给已经存在于空间中的文件设置文件生存时间，或者更新已设置了生存时间但尚未被删除的文件的新的生存时间。\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"access key\";\n String secretKey = \"secret key\";\n String bucket = \"bucket name\";\n String key = \"file key\";\n //过期天数，该文件10天后删除\n int days = 10;\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n try {\n bucketManager.deleteAfterDays(bucket, key, days);\n } catch (QiniuException ex) {\n System.err.println(ex.response.toString());\n }\n \n\n## 获取空间文件列表\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n \n //文件名前缀\n String prefix = \"\";\n //每次迭代的长度限制，最大1000，推荐值 1000\n int limit = 1000;\n //指定目录分隔符，列出所有公共前缀（模拟列出目录效果）。缺省值为空字符串\n String delimiter = \"\";\n \n //列举空间文件列表\n BucketManager.FileListIterator fileListIterator = bucketManager.createFileListIterator(bucket, prefix, limit, delimiter);\n while (fileListIterator.hasNext()) {\n //处理获取的file list结果\n FileInfo[] items = fileListIterator.next();\n for (FileInfo item : items) {\n System.out.println(item.key);\n System.out.println(item.hash);\n System.out.println(item.fsize);\n System.out.println(item.mimeType);\n System.out.println(item.putTime);\n System.out.println(item.endUser);\n }\n }\n \n\n## 抓取网络资源到空间\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n String key = \"your file key\";\n String remoteSrcUrl = \"http://devtools.qiniu.com/qiniu.png\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n \n //抓取网络资源到空间\n try {\n FetchRet fetchRet = bucketManager.fetch(remoteSrcUrl, bucket, key);\n System.out.println(fetchRet.hash);\n System.out.println(fetchRet.key);\n System.out.println(fetchRet.mimeType);\n System.out.println(fetchRet.fsize);\n } catch (QiniuException ex) {\n System.err.println(ex.response.toString());\n }\n \n\n## 资源管理批量操作\n\n### 批量获取文件信息\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n \n try {\n //单次批量请求的文件数量不得超过1000\n String[] keyList = new String[]{\n \"qiniu.jpg\",\n \"qiniu.mp4\",\n \"qiniu.png\",\n };\n BucketManager.BatchOperations batchOperations = new BucketManager.BatchOperations();\n batchOperations.addStatOps(bucket, keyList);\n Response response = bucketManager.batch(batchOperations);\n BatchStatus[] batchStatusList = response.jsonToObject(BatchStatus[].class);\n \n for (int i = 0; i < keyList.length; i++) {\n BatchStatus status = batchStatusList[i];\n String key = keyList[i];\n System.out.print(key+\"\\t\");\n if (status.code == 200) {\n //文件存在\n System.out.println(status.data.hash);\n System.out.println(status.data.mimeType);\n System.out.println(status.data.fsize);\n System.out.println(status.data.putTime);\n } else {\n System.out.println(status.data.error);\n }\n }\n } catch (QiniuException ex) {\n System.err.println(ex.response.toString());\n }\n \n\n### 批量修改文件类型\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n \n try {\n //单次批量请求的文件数量不得超过1000\n HashMap<String, String> keyMimeMap = new HashMap<>();\n keyMimeMap.put(\"qiniu.jpg\", \"image/jpg\");\n keyMimeMap.put(\"qiniu.png\", \"image/png\");\n keyMimeMap.put(\"qiniu.mp4\", \"video/mp4\");\n BucketManager.BatchOperations batchOperations = new BucketManager.BatchOperations();\n \n //添加指令\n for (Map.Entry<String, String> entry : keyMimeMap.entrySet()) {\n String key = entry.getKey();\n String newMimeType = entry.getValue();\n batchOperations.addChgmOp(bucket, key, newMimeType);\n }\n \n Response response = bucketManager.batch(batchOperations);\n BatchStatus[] batchStatusList = response.jsonToObject(BatchStatus[].class);\n \n int index = 0;\n for (Map.Entry<String, String> entry : keyMimeMap.entrySet()) {\n String key = entry.getKey();\n System.out.print(key + \"\\t\");\n BatchStatus status = batchStatusList[index];\n if (status.code == 200) {\n System.out.println(\"change mime success\");\n } else {\n System.out.println(status.data.error);\n }\n index += 1;\n }\n } catch (QiniuException ex) {\n System.err.println(ex.response.toString());\n }\n \n\n### 批量删除文件\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n \n try {\n //单次批量请求的文件数量不得超过1000\n String[] keyList = new String[]{\n \"qiniu.jpg\",\n \"qiniu.mp4\",\n \"qiniu.png\",\n };\n BucketManager.BatchOperations batchOperations = new BucketManager.BatchOperations();\n batchOperations.addDeleteOp(bucket, keyList);\n Response response = bucketManager.batch(batchOperations);\n BatchStatus[] batchStatusList = response.jsonToObject(BatchStatus[].class);\n \n for (int i = 0; i < keyList.length; i++) {\n BatchStatus status = batchStatusList[i];\n String key = keyList[i];\n System.out.print(key + \"\\t\");\n if (status.code == 200) {\n System.out.println(\"delete success\");\n } else {\n System.out.println(status.data.error);\n }\n }\n } catch (QiniuException ex) {\n System.err.println(ex.response.toString());\n }\n \n\n### 批量移动或重命名文件\n\n \n \n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n \n try {\n //单次批量请求的文件数量不得超过1000\n String[] keyList = new String[]{\n \"qiniu.jpg\",\n \"qiniu.mp4\",\n \"qiniu.png\",\n };\n BucketManager.BatchOperations batchOperations = new BucketManager.BatchOperations();\n for (String key : keyList) {\n batchOperations.addMoveOp(bucket, key, bucket, key + \"_move\");\n }\n \n Response response = bucketManager.batch(batchOperations);\n BatchStatus[] batchStatusList = response.jsonToObject(BatchStatus[].class);\n \n for (int i = 0; i < keyList.length; i++) {\n BatchStatus status = batchStatusList[i];\n String key = keyList[i];\n System.out.print(key + \"\\t\");\n if (status.code == 200) {\n System.out.println(\"move success\");\n } else {\n System.out.println(status.data.error);\n }\n }\n } catch (QiniuException ex) {\n System.err.println(ex.response.toString());\n }\n \n\n### 批量复制文件\n\n \n \n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n \n try {\n //单次批量请求的文件数量不得超过1000\n String[] keyList = new String[]{\n \"qiniu.jpg\",\n \"qiniu.mp4\",\n \"qiniu.png\",\n };\n BucketManager.BatchOperations batchOperations = new BucketManager.BatchOperations();\n for (String key : keyList) {\n batchOperations.addCopyOp(bucket, key, bucket, key + \"_copy\");\n }\n \n Response response = bucketManager.batch(batchOperations);\n BatchStatus[] batchStatusList = response.jsonToObject(BatchStatus[].class);\n \n for (int i = 0; i < keyList.length; i++) {\n BatchStatus status = batchStatusList[i];\n String key = keyList[i];\n System.out.print(key + \"\\t\");\n if (status.code == 200) {\n System.out.println(\"copy success\");\n } else {\n System.out.println(status.data.error);\n }\n }\n } catch (QiniuException ex) {\n System.err.println(ex.response.toString());\n }\n \n\n### 批量解冻归档存储类型文件\n\n \n \n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n \n try {\n //单次批量请求的文件数量不得超过1000\n String[] keyList = new String[]{\n \"qiniu.jpg\",\n \"qiniu.mp4\",\n \"qiniu.png\",\n };\n int freezeAfterDays = 7 ;\n BucketManager.BatchOperations batchOperations = new BucketManager.BatchOperations();\n for (String key : keyList) {\n batchOperations.addRestoreArchiveOps(bucket, freezeAfterDays, key);\n }\n \n Response response = bucketManager.batch(batchOperations);\n BatchStatus[] batchStatusList = response.jsonToObject(BatchStatus[].class);\n \n for (int i = 0; i < keyList.length; i++) {\n BatchStatus status = batchStatusList[i];\n String key = keyList[i];\n System.out.print(key + \"\\t\");\n if (status.code == 200) {\n System.out.println(\"restoreAr success\");\n } else {\n System.out.println(status.data.error);\n }\n }\n } catch (QiniuException ex) {\n System.err.println(ex.response.toString());\n }\n \n\n### 批量混合指令操作\n\n其实`batch`接口支持混合指令的处理，不过为了方便解析请求的回复，一般不推荐这样做。\n\n \n \n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n \n try {\n //单次批量请求的文件数量不得超过1000\n BucketManager.BatchOperations batchOperations = new BucketManager.BatchOperations();\n \n //添加混合指令\n batchOperations.addStatOps(bucket, \"qiniu.png\", \"qiniu.jpg\");\n batchOperations.addCopyOp(bucket, \"qiniu.png\", bucket, \"qiniu_copy1.png\");\n batchOperations.addMoveOp(bucket, \"qiniu2.png\", bucket, \"qiniu3.png\");\n batchOperations.addDeleteOp(bucket, \"qiniu4.png\");\n batchOperations.addRestoreArchiveOps(bucket, 1, \"qiniu.png\");\n \n \n Response response = bucketManager.batch(batchOperations);\n BatchStatus[] batchStatusList = response.jsonToObject(BatchStatus[].class);\n \n for (BatchStatus status : batchStatusList) {\n if (status.code == 200) {\n System.out.println(\"operation success\");\n } else {\n System.out.println(status.data.error);\n }\n }\n } catch (QiniuException ex) {\n System.err.println(ex.response.toString());\n }\n \n\n## 更新镜像存储空间中文件内容\n\n对于配置了镜像存储的空间，如果镜像源站更新了文件内容，则默认情况下，七牛不会再主动从客户镜像源站同步新的副本，这个时候就需要利用这个`prefetch`接口来主动地将空间中的文件和更新后的源站副本进行同步。调用方式很简单，指定空间和文件名即可。\n\n \n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n \n String bucket = \"your bucket name\";\n String key = \"your file key\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n BucketManager bucketManager = new BucketManager(auth, cfg);\n try {\n bucketManager.prefetch(bucket, key);\n } catch (QiniuException ex) {\n //如果遇到异常，说明更新失败\n System.err.println(ex.code());\n System.err.println(ex.response.toString());\n }\n \n\n# 持久化数据处理\n\n## 发送数据处理请求\n\n对于已经保存到七牛空间的文件，可以通过发送持久化的数据处理指令来进行处理，这些指令支持七牛官方提供的指令，也包括客户自己开发的自定义数据处理的指令。数据处理的结果还可以通过七牛主动通知的方式告知业务服务器。\n\n \n \n String accessKey = \"access key\";\n String secretKey = \"secret key\";\n \n //待处理文件所在空间\n String bucket = \"bucket name\";\n //待处理文件名\n String key = \"file key\";\n \n Auth auth = Auth.create(accessKey, secretKey);\n \n //数据处理指令，支持多个指令\n String saveMp4Entry = String.format(\"%s:avthumb_test_target.mp4\", bucket);\n String saveJpgEntry = String.format(\"%s:vframe_test_target.jpg\", bucket);\n String avthumbMp4Fop = String.format(\"avthumb/mp4|saveas/%s\", UrlSafeBase64.encodeToString(saveMp4Entry));\n String vframeJpgFop = String.format(\"vframe/jpg/offset/1|saveas/%s\", UrlSafeBase64.encodeToString(saveJpgEntry));\n //将多个数据处理指令拼接起来\n String persistentOpfs = StringUtils.join(new String[]{\n avthumbMp4Fop, vframeJpgFop\n }, \";\");\n \n //数据处理队列名称，必须\n String persistentPipeline = \"mps-pipe1\";\n //数据处理完成结果通知地址\n String persistentNotifyUrl = \"http://api.example.com/qiniu/pfop/notify\";\n \n //构造一个带指定 Region 对象的配置类\n Configuration cfg = new Configuration(Region.region0());\n //...其他参数参考类注释\n \n //构建持久化数据处理对象\n OperationManager operationManager = new OperationManager(auth, cfg);\n try {\n \n String persistentId = operationManager.pfop(bucket, key, persistentOpfs, persistentPipeline, persistentNotifyUrl, true);\n //可以根据该 persistentId 查询任务处理进度\n System.out.println(persistentId);\n \n OperationStatus operationStatus = operationManager.prefop(persistentId);\n //解析 operationStatus 的结果\n } catch (QiniuException e) {\n System.err.println(e.response.toString());\n }\n \n\n## 查询数据处理请求状态\n\n由于数据处理是异步处理，可以根据发送处理请求时返回的 `persistentId`\n去查询任务的处理进度，如果在设置了`persistentNotifyUrl`\n的情况下，直接业务服务器等待处理结果通知即可，如果需要主动查询，可以采用如上代码中的：\n\n \n \n OperationStatus operationStatus = operationManager.prefop(persistentId);\n //解析 operationStatus 的结果\n \n\n# CDN相关功能\n\n * 文件刷新\n * 目录刷新\n * 刷新查询\n * 文件预取操作\n * 获取域名流量\n * 获取域名带宽\n * 获取日志下载链接\n * 构建时间戳防盗链访问链接\n\n## 文件刷新\n\n \n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n Auth auth = Auth.create(accessKey, secretKey);\n CdnManager c = new CdnManager(auth);\n \n //待刷新的链接列表\n String[] urls = new String[]{\n \"http://javasdk.qiniudn.com/gopher1.jpg\",\n \"http://javasdk.qiniudn.com/gopher2.jpg\",\n //....\n };\n try {\n //单次方法调用刷新的链接不可以超过100个\n CdnResult.RefreshResult result = c.refreshUrls(urls);\n System.out.println(result.code);\n //获取其他的回复内容\n } catch (QiniuException e) {\n System.err.println(e.response.toString());\n }\n \n\n## 目录刷新\n\n \n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n Auth auth = Auth.create(accessKey, secretKey);\n CdnManager c = new CdnManager(auth);\n \n //待刷新的目录列表，目录必须以 / 结尾\n String[] dirs = new String[]{\n \"http://javasdk.qiniudn.com/gopher1/\",\n \"http://javasdk.qiniudn.com/gopher2/\",\n //....\n };\n try {\n //单次方法调用刷新的目录不可以超过10个，另外刷新目录权限需要联系技术支持开通\n CdnResult.RefreshResult result = c.refreshDirs(dirs);\n System.out.println(result.code);\n //获取其他的回复内容\n } catch (QiniuException e) {\n System.err.println(e.response.toString());\n }\n \n\n## 刷新查询\n\n \n \n public static void getRefreshResult() {\n \tString accessKey = \"\";\n \tString secretKey = \"\";\n \tString url =\"http://fusion.qiniuapi.com/v2/tune/refresh/list\";\n \tString body = \"{\\\"urls\\\":[\\\"http://p9w3dsbag.bkt.clouddn.com/demo.html\\\"]}\";\n \tAuth auth = Auth.create(accessKey, secretKey);\n \tStringMap str = auth.authorization(url, body.getBytes(), Client.JsonMime);\n \tClient client = new Client();\n \ttry {\n \t\tResponse r = client.post(url, body.getBytes(), str);\n \t\tSystem.out.println(r.reqId);\n \t\tSystem.out.println(r.bodyString());\n \t} catch (QiniuException e) {\n \t\t// TODO Auto-generated catch block\n \t\te.printStackTrace();\n \t}\t\t\n }\n \n\n## 文件预取\n\n \n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n Auth auth = Auth.create(accessKey, secretKey);\n CdnManager c = new CdnManager(auth);\n \n //待预取的文件链接\n String[] urls = new String[]{\n \"http://javasdk.qiniudn.com/gopher1.jpg\",\n \"http://javasdk.qiniudn.com/gopher2.jpg\",\n //...\n };\n try {\n //单次调用方法预取的链接数量不得超过100个\n CdnResult.PrefetchResult result = c.prefetchUrls(urls);\n System.out.println(result.code);\n //获取其他的回复内容\n } catch (QiniuException e) {\n System.err.println(e.response.toString());\n }\n \n\n## 获取域名流量\n\n \n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n Auth auth = Auth.create(accessKey, secretKey);\n CdnManager c = new CdnManager(auth);\n \n //域名列表\n String[] domains = new String[]{\n \"img1.example.com\",\n \"img2.example.com\",\n };\n \n //开始和结束日期\n String fromDate = \"2017-01-02\";\n String toDate = \"2017-01-10\";\n //数据粒度，支持的取值为 5min ／ hour ／day\n String granularity = \"day\";\n \n try {\n CdnResult.FluxResult fluxResult = c.getFluxData(domains, fromDate, toDate, granularity);\n //处理得到的结果数据\n //...\n } catch (QiniuException e) {\n System.err.println(e.response.toString());\n }\n \n\n## 获取域名带宽\n\n \n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n Auth auth = Auth.create(accessKey, secretKey);\n CdnManager c = new CdnManager(auth);\n \n //域名列表\n String[] domains = new String[]{\n \"img1.example.com\",\n \"img2.example.com\",\n };\n \n //开始和结束日期\n String fromDate = \"2017-01-02\";\n String toDate = \"2017-01-10\";\n //数据粒度，支持的取值为 5min ／ hour ／day\n String granularity = \"day\";\n \n try {\n CdnResult.BandwidthResult bandwidthResult = c.getBandwidthData(domains, fromDate, toDate, granularity);\n //处理得到的结果数据\n //...\n } catch (QiniuException e) {\n System.err.println(e.response.toString());\n }\n \n\n## 获取日志下载链接\n\n \n \n String accessKey = \"your access key\";\n String secretKey = \"your secret key\";\n Auth auth = Auth.create(accessKey, secretKey);\n CdnManager c = new CdnManager(auth);\n \n //域名列表\n String[] domains = new String[]{\n \"img1.example.com\",\n \"img2.example.com\",\n };\n \n //具体日期\n String logDate = \"2017-01-02\";\n \n try {\n CdnResult.LogListResult logListResult = c.getCdnLogList(domains, logDate);\n //处理得到的结果数据\n //...\n } catch (QiniuException e) {\n System.err.println(e.response.toString());\n }\n \n\n## 构建时间戳防盗链访问链接\n\n具体算法可以参考：[时间戳防盗链](https://developer.qiniu.com/fusion/kb/timestamp-hotlinking-\nprevention)\n\n \n \n String host = \"http://video.example.com\";\n String fileName = \"基本概括.mp4\";\n \n //查询参数\n StringMap queryStringMap = new StringMap();\n queryStringMap.put(\"name\", \"七牛\");\n queryStringMap.put(\"year\", 2017);\n queryStringMap.put(\"年龄\", 28);\n \n //链接过期时间\n long deadline = System.currentTimeMillis() / 1000 + 3600;\n \n //签名密钥，从后台域名属性中获取\n String encryptKey = \"xxx\";\n String signedUrl;\n try {\n signedUrl = CdnManager.createTimestampAntiLeechUrl(host, fileName,\n queryStringMap, encryptKey, deadline);\n System.out.println(signedUrl);\n } catch (Exception ex) {\n ex.printStackTrace();\n }\n \n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n * [融合CDN API 参考](https://developer.qiniu.com/fusion)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n * [视频监控QVS API 参考](https://developer.qiniu.com/qvs)\n\n# 常见问题\n\n * QiniuExeption 保留了请求响应的信息，失败情况下会抛出此异常，可以提交给我们排查问题。\n * API 的使用，demo 可以参考[单元测试 __](https://github.com/qiniu/java-sdk/blob/master/src/test)。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](https://support.qiniu.com/tickets/new)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Java SDK 历史文档"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [Java\nSDK](https://developer.qiniu.com/kodo/sdk/1239/java) > Java SDK 历史文档\n\n# Java SDK 历史文档\n\n最近更新时间: 2017-01-23 10:21:38\n\n此SDK适用于Java 6及以上版本。\n\n * [SDK下载地址](https://github.com/qiniu/java-sdk/tags)\n * [jar文件下载](http://search.maven.org/#search%7Cga%7C1%7Cqiniu)\n\n# 安装\n\n安装 Maven 的插件：[The Maven Integration for Eclipse](http://www.eclipse.org/m2e/)\n\n添加依赖\n\n \n \n <dependency>\n \t<groupId>com.qiniu</groupId>\n \t<artifactId>qiniu-java-sdk</artifactId>\n \t<version>[6.1.7, 6.999]</version>\n </dependency>\n \n\n**配置密钥**\n\n要接入七牛云存储，您需要拥有一对有效的 Access Key 和 Secret Key 用来进行签名认证。可以通过如下步骤获得：\n\n 1. [开通七牛开发者帐号](https://portal.qiniu.com/signup)\n 2. 登录七牛开发者自助平台，查看 [Access Key 和 Secret Key](https://portal.qiniu.com/user/key)\n\n在获取到 Access Key 和 Secret Key 之后，您可以按照如下方式进行密钥配置：\n\n \n \n import com.qiniu.api.config.Config;\n \n public class Init {\n \n \tpublic static void main(String[] args) {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t}\n }\n \n\n# 上传\n\n为了尽可能地改善终端用户的上传体验，七牛云存储首创了客户端直传功能。\n\n一般云存储的上传流程是：\n\n \n \n 客户端（终端用户） => 业务服务器 => 云存储服务\n \n\n这样通过用户自己的业务服务器中转上传至云存储服务端。这种方式存在一些不足：\n\n 1. 多了一次中转的上传过程，同数据存放在用户的业务服务器中相比，会相对慢一些；\n 2. 增加了用户业务服务器的负载，消耗了带宽，占用了磁盘，降低了服务能力；\n 3. 增加了用户的流量消耗，来自终端用户的上传数据进入业务服务器，然后再次上传至云存储服务，净增一倍流量。\n\n因此，七牛云存储引入了客户端直传的模式，将整个上传过程调整为：\n\n \n \n 客户端（终端用户） => 七牛 => 业务服务器\n \n\n客户端（终端用户）直接上传到七牛的服务器。通过DNS智能解析，七牛会选择到离终端用户最近的ISP服务商节点，速度会相比数据存放在用户自己的业务服务器上的方式更快。而且，七牛云存储可以在用户文件上传成功以后，替用户的客户端向用户的业务服务器发送反馈信息，减少用户的客户端同业务服务器之间的交互。详情请参考[上传策略](https://developer.qiniu.com/kodo/manual/put-\npolicy)\n\n**注意** ：如果您只是想要将您电脑上，或者是服务器上的文件上传到七牛云存储，可以直接使用七牛提供的\n[qshell](https://developer.qiniu.com/kodo/tools/qshell)上传工具，而无需额外开发。\n\n文件上传有两种方式：普通方式，即一次性上传整个文件；断点续上传，即将文件分割成若干小块，分别上传，然后在七牛云存储服务端重新合并成一个文件。一般情况下，用户可以采用普通上传。如果文件较大，或者网络条件不佳，那么可以使用断点续上传，提高上传的速度和成功率。\n\n## 上传流程\n\n在七牛云存储中，整个上传流程大体分为这样几步：\n\n 1. 业务服务器颁发上传凭证给客户端（终端用户）\n 2. 客户端凭借上传凭证上传文件到七牛\n 3. 在七牛获得完整数据后，根据用户请求的设定执行以下操作：\n\n * 如果用户设定了 returnUrl ，七牛云存储将反馈一个指向returnUrl的HTTP 303，驱动客户端执行跳转。\n * 如果用户设定了 callbackUrl] ，七牛云存储将向callbackUrl指定的地址发起一个HTTP 请求回调业务服务器，同时向业务服务器发送数据。发送的数据内容由 callbackBody 指定。业务服务器完成回调的处理后，可以在HTTP Response中放入数据，七牛云存储会响应客户端，并将业务服务器反馈的数据发送给客户端。 \n * 如果两者都没有设置，七牛云存储根据 returnBody 的设定向客户端发送反馈信息。\n\n**注意：** 回调到业务服务器的过程是可选的，它取决于业务服务器颁发的上传凭证。\n\n如果没有回调，七牛会返回一些标准的信息（比如文件的 hash）给客户端。如果上传发生在业务服务器，以上流程可以自然简化为：\n\n 1. 业务服务器生成上传凭证 不设置回调，自己回调到自己这里没有意义）\n 2. 凭借上传凭证上传文件到七牛\n 3. 善后工作，比如保存相关的一些信息\n\n## 生成上传授权uptoken\n\nuptoken是一个字符串，作为http协议Header的一部分（Authorization字段）发送到我们七牛的服务端，表示这个http请求是经过用户授权的。\n\n \n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rs.PutPolicy;\n \n public class Uptoken {\n \n \tpublic static void main(String[] args) throws Exception {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\t// 请确保该bucket已经存在\n \t\tString bucketName = \"Your bucket name\";\n \t\tPutPolicy putPolicy = new PutPolicy(bucketName);\n \t\tString uptoken = putPolicy.token(mac);\n \t}\n }\n \n\n## 上传代码\n\n上传本地文件。如果用户从自己的计算机或服务器上传文件，可以直接使用七牛云存储提供的 qrsync 工具。用户也可以自行编写上传程序。\n\n上传程序大体步骤如下：\n\n 1. 设置AccessKey和SecretKey；\n 2. 创建Mac对象；\n 3. 创建PutPolicy对象；\n 4. 生成UploadToken；\n 5. 创建PutExtra对象；\n 6. 调用put或putFile方法上传文件；\n\n具体代码如下：\n\n \n \n import java.io.File;\n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.io.IoApi;\n import com.qiniu.api.io.PutExtra;\n import com.qiniu.api.io.PutRet;\n import com.qiniu.api.rs.PutPolicy;\n \n public class UploadFile {\n \t\n \tpublic static void main(String[] args) throws Exception {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\t// 请确保该bucket已经存在\n \t\tString bucketName = \"<Your bucket name>\";\n \t\tPutPolicy putPolicy = new PutPolicy(bucketName);\n \t\tString uptoken = putPolicy.token(mac);\n \t\tPutExtra extra = new PutExtra();\n \t\tString key = \"<key>\";\n \t\tString localFile = \"<local file path>\";\n \t\tPutRet ret = IoApi.putFile(uptoken, key, localFile, extra);\n \t}\n }\n \n\n## 断点续上传、分块并行上传\n\n与普通上传类似：\n\n \n \n private void uploadFile() throws AuthException, JSONException{\n \t\tPutPolicy p = new PutPolicy(bucketName);\n \t\tp.returnBody = \"{\\\"key\\\": $(key), \\\"hash\\\": $(etag),\\\"mimeType\\\": $(mimeType)}\";\n \t\tString upToken = p.token(mac);\n \t\tPutRet ret = ResumeableIoApi.put(file, upToken, key, mimeType);\n \t}\n \t\n \tprivate void uploadStream() throws AuthException, JSONException, FileNotFoundException{\n \t\tPutPolicy p = new PutPolicy(bucketName);\n \t\tString upToken = p.token(mac);\n \t\tFileInputStream fis = new FileInputStream(file);\n \t\tPutRet ret = ResumeableIoApi.put(fis, upToken, key, mimeType);\n \t}\n \n\nkey，mimeType 可为null。\n\n## 上传策略\n\nuptoken实际上是用 AccessKey/SecretKey\n进行数字签名的上传策略(`rs.PutPolicy`)，它控制则整个上传流程的行为。让我们快速过一遍你都能够决策啥：\n\n * `expires` 指定 uptoken 有效时长。单位：秒（s），默认1小时，3600秒。deadline = System.currentTimeMillis() / 1000 + this.expires，不直接指定deadline。一个 uptoken 可以被用于多次上传（只要它还没有过期）。\n\n关于上传策略更完整的说明，请参考 [uptoken](https://developer.qiniu.com/kodo/manual/upload-\ntoken)。\n\n# 文件下载\n\n七牛云存储上的资源下载分为 公有资源下载 和 私有资源下载 。\n\n私有（private）是 Bucket（空间）的一个属性，一个私有 Bucket 中的资源为私有资源，私有资源不可匿名下载。\n\n新创建的空间（Bucket）缺省为私有，也可以将某个 Bucket 设为公有，公有 Bucket 中的资源为公有资源，公有资源可以匿名下载。\n\n## 公有资源下载\n\n如果在给bucket绑定了域名的话，可以通过以下地址访问。\n\n \n \n [GET] http://<domain>/<key>\n \n\n其中<domain>是bucket所对应的域名。七牛云存储为每一个bucket提供一个默认域名。默认域名可以到[七牛开发者平台](https://portal.qiniu.com/)中，空间设置的域名设置一节查询。用户也可以将自有的域名绑定到bucket上，通过自有域名访问七牛云存储。\n\n**注意：** key必须采用utf8编码，如使用非utf8编码访问七牛云存储将反馈错误\n\n## 私有资源下载\n\n私有资源必须通过临时下载授权凭证(downloadToken)下载，如下：\n\n \n \n [GET] http://<domain>/<key>?token=<downloadToken>\n \n\n注意，尖括号不是必需，代表替换项。\n\n`downloadToken` 可以使用 SDK 提供的如下方法生成：\n\n \n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rs.GetPolicy;\n import com.qiniu.api.rs.URLUtils;\n \n public class DownloadFile {\n \n \tpublic static void main(String[] args) throws Exception {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\tString baseUrl = URLUtils.makeBaseUrl(\"<domain>\", \"<key>\");\n \t\tGetPolicy getPolicy = new GetPolicy();\n \t\tString downloadUrl = getPolicy.makeRequest(baseUrl, mac);\n \t}\n }\n \n\n# 资源管理接口\n\n文件管理包括对存储在七牛云存储上的文件进行查看、复制、移动和删除处理。\n\n## 查看单个文件属性信息\n\n \n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rs.Entry;\n import com.qiniu.api.rs.RSClient;\n \n public class Stat {\n \n \tpublic static void main(String[] args) {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\tRSClient client = new RSClient(mac);\n \t\tEntry statRet = client.stat(\"<bucketName>\", \"<key>\");\n \t}\n }\n \n\n## 复制单个文件\n\n \n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rs.RSClient;\n \n public class Copy {\n \n \tpublic static void main(String[] args) {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\tRSClient client = new RSClient(mac);\n \t\tclient.copy(\"<bucketSrc>\", \"<keySrc>\", \"<bucketDest>\", \"<keyDest>\");\n \t}\n }\n \n\n## 移动单个文件\n\n \n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rs.RSClient;\n \n public class Move {\n \n \tpublic static void main(String[] args) {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\tRSClient client = new RSClient(mac);\n \t\tclient.move(\"<bucketSrc>\", \"<keySrc>\", \"<bucketDest>\", \"<keyDest>\");\n \t}\n }\n \n \n\n## 删除单个文件\n\n \n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rs.RSClient;\n \n public class Delete {\n \n \tpublic static void main(String[] args) {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\tRSClient client = new RSClient(mac);\n \t\tclient.delete(\"<bucketName>\", \"<key>\");\n \t}\n }\n \n\n## 批量操作\n\n当您需要一次性进行多个操作时, 可以使用批量操作.\n\n**批量获取文件属性信息**\n\n \n \n import java.util.ArrayList;\n import java.util.List;\n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rs.BatchStatRet;\n import com.qiniu.api.rs.EntryPath;\n import com.qiniu.api.rs.RSClient;\n \n public class BatchStat {\n \n \tpublic static void main(String[] args) {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\t\n \t\tRSClient rs = new RSClient(mac);\n \t\tList<EntryPath> entries = new ArrayList<EntryPath>();\n \n \t\tEntryPath e1 = new EntryPath();\n \t\te1.bucket = \"<bucketName>\";\n \t\te1.key = \"<key1>\";\n \t\tentries.add(e1);\n \n \t\tEntryPath e2 = new EntryPath();\n \t\te2.bucket = \"<bucketName>\";\n \t\te2.key = \"<key2>\";\n \t\tentries.add(e2);\n \n \t\tBatchStatRet bsRet = rs.batchStat(entries);\n \t}\n }\n \n\n**批量复制文件**\n\n \n \n import java.util.ArrayList;\n import java.util.List;\n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rs.BatchCallRet;\n import com.qiniu.api.rs.EntryPath;\n import com.qiniu.api.rs.EntryPathPair;\n import com.qiniu.api.rs.RSClient;\n \n public class BatchCopy {\n \n \tpublic static void main(String[] args) {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\tRSClient rs = new RSClient(mac);\n \t\tList<EntryPathPair> entries = new ArrayList<EntryPathPair>();\n \n \t\tEntryPathPair pair1 = new EntryPathPair();\n \n \t\tEntryPath src = new EntryPath();\n \t\tsrc.bucket = \"<srcBucket>\";\n \t\tsrc.key = \"<key1>\";\n \n \t\tEntryPath dest = new EntryPath();\n \t\tdest.bucket = \"<destBucket>\";\n \t\tdest.key = \"<key1>\";\n \n \t\tpair1.src = src;\n \t\tpair1.dest = dest;\n \n \t\tEntryPathPair pair2 = new EntryPathPair();\n \n \t\tEntryPath src2 = new EntryPath();\n \t\tsrc2.bucket = \"<srcBucket>\";\n \t\tsrc2.key = \"<key2>\";\n \n \t\tEntryPath dest2 = new EntryPath();\n \t\tdest2.bucket = \"<destBucket>\";\n \t\tdest2.key = \"<key2>\";\n \n \t\tpair2.src = src2;\n \t\tpair2.dest = dest2;\n \n \t\tentries.add(pair1);\n \t\tentries.add(pair2);\n \n \t\tBatchCallRet ret = rs.batchCopy(entries);\n \t}\n }\n \n\n**批量移动文件**\n\n \n \n import java.util.ArrayList;\n import java.util.List;\n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rs.BatchCallRet;\n import com.qiniu.api.rs.EntryPath;\n import com.qiniu.api.rs.EntryPathPair;\n import com.qiniu.api.rs.RSClient;\n \n public class BatchMove {\n \n \tpublic static void main(String[] args) {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\tRSClient rs = new RSClient(mac);\n \t\tList<EntryPathPair> entries = new ArrayList<EntryPathPair>();\n \t\t\n \t\tEntryPathPair pair1 = new EntryPathPair();\n \t\t\n \t\tEntryPath src = new EntryPath();\n \t\tsrc.bucket = \"<srcBucket>\";\n \t\tsrc.key = \"<key1>\";\n \t\t\n \t\tEntryPath dest = new EntryPath();\n \t\tdest.bucket = \"<destBucket>\";\n \t\tdest.key = \"<key1>\";\n \t\t\n \t\tpair1.src = src;\n \t\tpair1.dest = dest;\n \t\t\n \t\tEntryPathPair pair2 = new EntryPathPair();\n \t\t\n \t\tEntryPath src2 = new EntryPath();\n \t\tsrc2.bucket = \"<srcBucket>\";\n \t\tsrc2.key = \"<key2>\";\n \t\t\n \t\tEntryPath dest2 = new EntryPath();\n \t\tdest2.bucket = \"<destBucket>\";\n \t\tdest2.key = \"<key2>\";\n \t\t\n \t\tpair2.src = src2;\n \t\tpair2.dest = dest2;\n \t\t\n \t\tentries.add(pair1);\n \t\tentries.add(pair2);\n \t\t\n \t\tBatchCallRet ret = rs.batchMove(entries);\n \t}\n } \n \n\n**批量删除文件**\n\n \n \n import java.util.ArrayList;\n import java.util.List;\n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rs.BatchCallRet;\n import com.qiniu.api.rs.EntryPath;\n import com.qiniu.api.rs.RSClient;\n \n public class BatchDelete {\n \n \tpublic static void main(String[] args) {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\tRSClient rs = new RSClient(mac);\n \t\tList<EntryPath> entries = new ArrayList<EntryPath>();\n \n \t\tEntryPath e1 = new EntryPath();\n \t\te1.bucket = \"<bucketName>\";\n \t\te1.key = \"<key1>\";\n \t\tentries.add(e1);\n \n \t\tEntryPath e2 = new EntryPath();\n \t\te2.bucket = \"<bucketName>\";\n \t\te2.key = \"<key2>\";\n \t\tentries.add(e2);\n \n \t\tBatchCallRet bret = rs.batchDelete(entries);\n \t}\n }\n \n \n\n参阅: `rs.EntryPath`, `rs.Client.BatchDelete`\n\n## 高级批量操作\n\n批量操作不仅仅支持同时进行多个相同类型的操作, 同时也支持不同的操作.\n\n \n \n to do!\n \n\n# 数据处理接口\n\n七牛支持在云端对图像, 视频, 音频等富媒体进行个性化处理\n\n## 图像\n\n**查看图像属性**\n\n \n \n import com.qiniu.api.fop.ImageInfo;\n import com.qiniu.api.fop.ImageInfoRet;\n \n public class FopImageInfo {\n \n \tpublic static void main(String[] args) {\n \t\tString url = \"<domain>\" + \"/\" + \"<key>\";\n \t\tImageInfoRet ret = ImageInfo.call(url);\n \t}\n }\n \n\n参阅: `fop.ImageInfoRet`, `fop.ImageInfo`\n\n**查看图片EXIF信息**\n\n \n \n import com.qiniu.api.fop.ExifRet;\n import com.qiniu.api.fop.ImageExif;\n \n public class FopImageExif {\n \n \tpublic static void main(String[] args) {\n \t\tString url = \"<domain>\" + \"/\" + \"<key>\";\n \t\tExifRet ret = ImageExif.call(url);\n \t}\n }\n \n\n**生成图片预览**\n\n \n \n import com.qiniu.api.fop.ImageView;\n import com.qiniu.api.net.CallRet;\n \n public class FopImageView {\n \n \tpublic static void main(String[] args) {\n \t\tString url = \"http://domain/key\";\n \t\tImageView iv = new ImageView();\n \t\tiv.mode = 1 ;\n \t\tiv.width = 100 ;\n \t\tiv.height = 200 ;\n \t\tiv.quality = 1 ;\n \t\tiv.format = \"jpg\" ;\n \t\tCallRet ret = iv.call(url);\n \t}\n }\n \n\n# 高级资源管理接口 (rsf)\n\n## 批量获取文件列表\n\n \n \n import com.qiniu.api.auth.digest.Mac;\n import com.qiniu.api.config.Config;\n import com.qiniu.api.rsf.RSFClient;\n \n public class ListPrefix {\n \n \tpublic static void main(String[] args) {\n \t\tConfig.ACCESS_KEY = \"<YOUR APP ACCESS_KEY>\";\n \t\tConfig.SECRET_KEY = \"<YOUR APP SECRET_KEY>\";\n \t\tMac mac = new Mac(Config.ACCESS_KEY, Config.SECRET_KEY);\n \t\t\n \t\tRSFClient client = new RSFClient(mac);\n \t\tString marker = \"\";\n \t\t\t\n \t\tList<ListItem> all = new ArrayList<ListItem>();\n \t\tListPrefixRet ret = null;\n \t\twhile (true) {\n \t\t\tret = client.listPrifix(bucketName, \"<prifix>\", marker, 10);\n \t\t\tmarker = ret.marker;\n \t\t\tall.addAll(ret.results);\n \t\t\tif (!ret.ok()) {\n \t\t\t\t// no more items or error occurs\n \t\t\t\tbreak;\n \t\t\t}\n \t\t}\n \t\tif (ret.exception.getClass() != RSFEofException.class) {\n \t\t\t// error handler\n \t\t} \n \t}\n }\n \n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储JavaScript SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > JavaScript SDK\n\n# JavaScript SDK\n\n最近更新时间: 2023-12-14 18:26:14\n\n# Qiniu-JavaScript-SDK\n\n[__](https://travis-ci.org/qiniu/js-sdk) \n[__](https://github.com/qiniu/js-sdk/releases) \n[__](https://codecov.io/gh/qiniu/js-sdk)\n\n基于七牛 API 开发的前端 JavaScript SDK\n\n## 当前版本为 3.x，旧版本文档：[2.x __](https://github.com/qiniu/js-sdk/tree/2.x)、[1.x\n__](https://github.com/qiniu/js-sdk/tree/1.x)\n\n### 2.x 升级到 3.x 的注意事项请参考 [文档 __](https://github.com/qiniu/js-\nsdk/wiki/2.x-%E5%8D%87%E7%BA%A7%E5%88%B0-3.x-%E6%96%87%E6%A1%A3%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9)\n\n## 快速导航\n\n * 功能简介\n * 准备\n * 引入\n * 使用\n * 运行示例\n * 说明\n * 常见问题\n\n## 概述\n\nQiniu-JavaScript-SDK （下文简称为 JS-SDK）适用于 ：IE11、Edge、Chrome、Firefox、Safari\n等浏览器，基于七牛云存储官方 API 构建，其中上传功能基于 H5 File API。开发者基于 JS-SDK\n可以方便的从浏览器端上传文件至七牛云存储，并对上传成功后的图片进行丰富的数据处理操作。 \nJS-SDK 兼容支持 H5 File API 的浏览器，在低版本浏览器下，需要额外的插件如 plupload，JS-SDK\n提供了一些接口可以结合插件来进行上传工作，注意：(在低版本浏览器需要引入 [babel-polyfill\n__](https://babeljs.cn/docs/usage/polyfill/)来解决 SDK 里某些语法或者属性浏览器不能识别的问题)。\n\nQiniu-JavaScript-SDK 为客户端 SDK，没有包含 `token` 生成实现，为了安全，`token`\n建议通过网络从服务端获取，具体生成代码可以参考以下服务端 SDK 的文档。\n\n * [Android __](https://developer.qiniu.com/kodo/sdk/android)\n * [Java __](https://developer.qiniu.com/kodo/sdk/java)\n * [PHP __](https://developer.qiniu.com/kodo/sdk/php)\n * [Python __](https://developer.qiniu.com/kodo/sdk/python)\n * [Ruby __](https://developer.qiniu.com/kodo/sdk/ruby)\n * [Go __](https://developer.qiniu.com/kodo/sdk/go)\n * [Node.js __](https://developer.qiniu.com/kodo/sdk/nodejs)\n * [C#__](https://developer.qiniu.com/kodo/sdk/csharp)\n * [C/C++__](https://developer.qiniu.com/kodo/sdk/cpp)\n * [Objective-C __](https://developer.qiniu.com/kodo/sdk/objc)\n\nQiniu-JavaScript-SDK 的示例 [Demo\n__](http://jssdk-v2.demo.qiniu.io)中的服务器端部分是基于[Node.js 服务器端 SDK\n__](https://developer.qiniu.com/kodo/sdk/nodejs)开发的。\n\n * [JavaScript SDK 在线示例 V3 __](https://js-sdk-demo.qiniu.io)\n * [JavaScript SDK 在线示例 V2 __](http://jssdk-v2.demo.qiniu.io)\n\n## 功能简介\n\n * 上传 \n * 大于 4M 时可分块上传，小于 4M 时直传\n * 分块上传时，支持断点续传\n * 数据处理（图片） \n * imageView2（缩略图）\n * imageMogr2（高级处理，包含缩放、裁剪、旋转等）\n * imageInfo （获取基本信息）\n * exif （获取图片 EXIF 信息）\n * watermark （文字、图片水印）\n * pipeline （管道，可对 imageView2、imageMogr2、watermark 进行链式处理）\n\n## 准备\n\n * 在使用 JS-SDK 之前，您必须先注册一个七牛帐号，并登录控制台获取一对有效的 `AccessKey` 和 `SecretKey`，您可以阅读 [快速入门 __](https://developer.qiniu.com/kodo/manual/console-quickstart)和[安全机制 __](https://developer.qiniu.com/kodo/manual/security#security)以进一步了解如何正确使用和管理密钥 。\n\n * JS-SDK 依赖服务端颁发 `token`，可以通过以下二种方式实现：\n\n * 利用 [七牛服务端 SDK __](https://developer.qiniu.com/sdk#sdk)构建后端服务\n * 利用七牛底层 API 构建服务，详见七牛 [上传策略 __](https://developer.qiniu.com/kodo/manual/put-policy)和[上传凭证 __](https://developer.qiniu.com/kodo/manual/upload-token)\n\n前端通过接口请求以获得 `token` 信息\n\n## 引入\n\n支持以下几种安装方式\n\n * 直接使用静态文件地址：\n \n https://cdnjs.cloudflare.com/ajax/libs/qiniu-js/<version>/qiniu.min.js\n // 或者\n https://cdn.jsdelivr.net/npm/qiniu-js@<version>/dist/qiniu.min.js\n \n\n通过 script 标签引入该文件，会在全局生成名为 `qiniu` 的对象\n\n> **引入在线资源方式依赖于 CDN 服务器的稳定性，推荐用户使用离线方式引入，即通过本地资源或自行构建的方式引入** 。 \n> 使用引入本地资源方式时，src 请填写本地资源相对于示例程序的相对路径。\n\n * 使用 NPM 安装\n\nNPM 的全称是 Node Package Manager，是一个 [NodeJS\n__](https://nodejs.org)包管理和分发工具，已经成为了非官方的发布 Node 模块（包）的标准。如果需要更详细的关于 NPM\n的使用说明，您可以访问[NPM 官方网站 __](https://www.npmjs.com)，或对应的[中文网站\n__](http://www.npmjs.com.cn/)\n\n \n npm install qiniu-js\n \n \n const qiniu = require('qiniu-js')\n // or\n import * as qiniu from 'qiniu-js'\n \n\n * 通过源码编译\n\n`git clone [email protected]:qiniu/js-sdk.git`，进入项目根目录执行 `npm install` ，执行 `npm\nrun build`，即可在dist 目录生成 `qiniu.min.js`。\n\n## 使用\n\n`qiniu.upload` 返回一个 `observable` 对象用来控制上传行为，`observable` 对像通过 `subscribe`\n方法可以被 `observer` 所订阅，订阅同时会开始触发上传，同时返回一个 `subscription` 对象，该对象有一个 `unsubscribe`\n方法取消订阅，同时终止上传行为。对于不支持 SDK 的浏览器可以参考 demo1 中用插件处理和 form 直传的方式； 一般 form\n提交常常会导致网页跳转，demo1 中 form 直传通过加入 iframe，并结合后端 SDK 上传来解决网页跳转问题，实现 form\n无刷新上传。分片上传时，JS-\nSDK支持断点续传功能，会把已上传片的后端返回值ctx信息存储到本地，有效期为一天，超过一天后，当继续上传该文件时会清除掉本地存储信息重新上传。\n\n### Example\n\n文件上传：\n\n \n \n const observable = qiniu.upload(file, key, token, putExtra, config)\n \n const subscription = observable.subscribe(observer) // 上传开始\n // or\n const subscription = observable.subscribe(next, error, complete) // 这样传参形式也可以\n \n subscription.unsubscribe() // 上传取消\n \n\n图片上传前压缩：\n\n \n \n const options = {\n quality: 0.92,\n noCompressIfLarger: true\n // maxWidth: 1000,\n // maxHeight: 618\n }\n qiniu.compressImage(file, options).then(data => {\n const observable = qiniu.upload(data.dist, key, token, putExtra, config)\n const subscription = observable.subscribe(observer) // 上传开始\n })\n \n\n## API Reference Interface\n\n### qiniu.upload(file: File, key: string, token: string, putExtra?: object,\nconfig?: object): observable\n\n * **observable** : 为一个带有 subscribe 方法的类实例\n\n * observable.subscribe(observer: object): subscription\n\n * observer: `observer` 为一个 `object`，用来设置上传过程的监听函数，有三个属性 `next`、`error`、`complete`:\n \n const observer = {\n next(res){\n // ...\n },\n error(err){\n // ...\n },\n complete(res){\n // ...\n }\n }\n \n\n * next: 接收上传进度信息的回调函数，回调函数参数值为 `object`，包含字段信息如下：\n\n * uploadInfo: `object`，只有分片上传时才返回该字段 \n * uploadInfo.id: 上传任务的唯一标识。\n * uploadInfo.url: 上传地址。\n * chunks: `Array<ProgressCompose>` 每个 `chunk` 的上传信息，只有分片上传有此字段 \n * ProgressCompose 的信息如下 \n * size: `number` chunk 的尺寸\n * loaded: `number` 已经发送完毕的尺寸\n * percent: `number` 进度比例，范围在 0 - 100\n * fromCache?: `boolean` 是否是来自缓存\n * total: 包含 `loaded`、`total`、`percent` 三个属性: \n * total.loaded: `number`，已上传大小，单位为字节。\n * total.total: `number`，本次上传的总量控制信息，单位为字节，注意这里的 total 跟文件大小并不一致。\n * total.percent: `number`，当前上传进度，范围：0～100。\n * error: 上传错误后触发；自动重试本身并不会触发该错误，而当重试次数到达上限后则可以触发。当不是 xhr 请求错误时，会把当前错误产生原因直接抛出，诸如 JSON 解析异常等；当产生 xhr 请求错误时，参数 err 的类型为 `QiniuError`, 对于请求错误，err 的类型为 `QiniuRequestError`(继承自`QiniuError`)，如果是由于非服务端原因发生错误时（例如断网、跨域等等），错误的类型为 `QiniuNetworkError`(继承自`QiniuRequestError`)。\n\n * `QiniuError`\n * name: `QiniuErrorName` 错误的类型。\n * message: `string` 错误的信息。\n * stack: `string` 调用堆栈信息。\n * `QiniuRequestError` 继承自 `QiniuError`\n * data: `any` 服务端返回的错误信息，如果不是标准的 `json` 格式，则该字段为 `undefined`。\n * reqId: `string` xhr 请求错误的 `X-Reqid`。\n * code: `number` 请求错误状态码，可查阅码值对应 [说明 __](https://developer.qiniu.com/kodo/api/3928/error-responses)。\n * isRequestError: 固定为 `true`， _不推荐使用，即将废弃_ 。\n * `QiniuNetworkError` 继承自 `QiniuRequestError`\n * reqId: 由于请求可能还未真正发出，所以可能无法收集到 `reqId`，该字段可能为 `''`。\n * complete: 接收上传完成后的后端返回信息，具体返回结构取决于后端 SDK 的配置，可参考 [上传策略 __](https://developer.qiniu.com/kodo/manual/1206/put-policy)。\n\n * subscription: 为一个带有 `unsubscribe` 方法的类实例，通过调用 `subscription.unsubscribe()` 停止当前文件上传。\n\n * **bucket** : 上传的目标空间\n\n * **file** : `File` 对象，上传的文件\n\n * **key** : 文件资源名，为空字符串时则文件资源名也为空，为 `null` 或者 `undefined` 时则自动使用文件的 `hash` 作为文件名\n\n * **token** : 上传验证信息，前端通过接口请求后端获得\n\n * **config** : `object`，其中的每一项都为可选\n \n const config = {\n useCdnDomain: true,\n region: qiniu.region.z2\n };\n \n\n * config.useCdnDomain: 表示是否使用 cdn 加速域名，为布尔值，`true` 表示使用，默认为 `false`。\n * config.disableStatisticsReport: 是否禁用日志报告，为布尔值，默认为 `false`。\n * config.uphost: 上传 `host`，类型为 `string[] | string`，如果指定一个非空数组或者非空字符串，则仅使用该数据作为上传 `host`，默认为 `[]`，传入多个 `host` 时，内部会在重试过程中根据情况自动切换不同的 `host`。\n * config.upprotocol: 自定义上传域名协议，值为 `https` 或者 `http`，默认为 `https`。\n * config.region: 选择上传域名区域；当为 `null` 或 `undefined` 时，自动分析上传域名区域，当指定了 `uphost` 时，此设置项无效。\n * config.retryCount: 上传自动重试次数（整体重试次数，而不是某个分片的重试次数）；默认 3 次（即上传失败后最多重试两次）。\n * config.concurrentRequestLimit: 分片上传的并发请求量，`number`，默认为3；因为浏览器本身也会限制最大并发量，所以最大并发量与浏览器有关。\n * config.checkByServer: 是否开启服务端文件签名校验，为布尔值；开启后在文件上传时会计算本地的文件签名，服务端会根据本地的签名与接收到的数据的签名进行比对，如果不相同、则说明文件可能存在问题，此时会返回错误（`code`: 406），默认为 `false`，不开启。\n * config.checkByMD5: 是否开启 `MD5` 校验，为布尔值；在断点续传时，开启 `MD5` 校验会将已上传的分片与当前分片进行 `MD5` 值比对，若不一致，则重传该分片，避免使用错误的分片。读取分片内容并计算 `MD5` 需要花费一定的时间，因此会稍微增加断点续传时的耗时，默认为 `false`，不开启。\n * config.forceDirect: 是否上传全部采用直传方式，为布尔值；为 `true` 时则上传方式全部为直传 form 方式，禁用断点续传，默认 `false`。\n * config.chunkSize: `number`，分片上传时每片的大小，必须为正整数，单位为 `MB`，且最大不能超过 1024，默认值 4。因为 chunk 数最大 10000，所以如果文件以你所设的 `chunkSize` 进行分片并且 chunk 数超过 10000，我们会把你所设的 `chunkSize` 扩大二倍，如果仍不符合则继续扩大，直到符合条件。\n * config.debugLogLevel: `INFO` | `WARN` | `ERROR` | `OFF`，允许程序在控制台输出日志，默认为 `OFF`，不输出任何日志，本功能仅仅用于本地调试，不建议在线上环境开启。\n * **putExtra** : `object`，其中的每一项都为可选\n \n const putExtra = {\n fname: \"qiniu.txt\",\n mimeType: \"text/plain\",\n customVars: { 'x:test': 'qiniu', ... },\n metadata: { 'x-qn-meta': 'qiniu', ... },\n };\n \n\n * fname: `string`，文件原始文件名，若未指定，则魔法变量中无法使用 fname、ext、suffix\n * customVars: `object`，用来放置自定义变量，变量名必须以 `x:` 开始，自定义变量格式及说明请参考 [文档 __](https://developer.qiniu.com/kodo/manual/1235/vars)\n * metadata: `object`，用来防止自定义 meta，变量名必须以 `x-qn-meta-`开始，自定义资源信息格式及说明请参考 \n[文档 __](https://developer.qiniu.com/kodo/api/1252/chgm)\n\n * mimeType: `string`，指定所传的文件类型\n\n### qiniu.region: object\n\n * **qiniu.region.z0** : 代表华东区域\n * **qiniu.region.z1** : 代表华北区域\n * **qiniu.region.z2** : 代表华南区域\n * **qiniu.region.na0** : 代表北美区域\n * **qiniu.region.as0** : 代表新加坡区域\n\n### qiniu.getUploadUrl(config: object, token: string): Promise\n\n接收参数为 `config` 对象，返回根据 `config` 里所配置信息的上传域名\n\n \n \n qiniu.getUploadUrl(config, token).then(res => {}) // res 即为上传的 url\n \n\n### qiniu.getHeadersForChunkUpload(token: string): object\n\n返回 `object`，包含用来获得分片上传设置的头信息，参数为 `token` 字符串；当分片上传时，请求需要带该函数返回的头信息\n\n * **token** : 后端返回的上传验证信息\n \n const headers = qiniu.getHeadersForChunkUpload(token)\n \n\n### qiniu.deleteUploadedChunks(token: string, key: stting, uploadInfo:\nobject): Promise\n\n删除指定上传任务中已上传完成的片，`key` 为目标文件名，`uploadInfo` 可通过 `next` 的返回获取，`token` 由服务端生成\n\n### qiniu.compressImage(file: File, options: object): Promise (上传前图片压缩)\n\n**在 v3.3.3 版本之前，该压缩行为会根据图片的`Orientation(设备角度)` 信息对图片进行旋转处理，详细的信息可以参考** \n[issue：关于 canvas 绘制图像的方向兼容处理 __](https://github.com/qiniu/js-sdk/issues/522)\n\n \n \n const imgLink = qiniu.compressImage(file, options).then(res => {\n // res : {\n // dist: 压缩后输出的 Blob 对象或原始的 File 对象，具体看下面的 options 配置\n // width: 压缩后的图片宽度\n // height: 压缩后的图片高度\n // }\n }\n })\n \n\n * file: 要压缩的源图片，为 `File` 对象，支持 `image/png`、`image/jpeg`、`image/bmp`、`image/webp` 这几种图片类型\n * options: `object`\n * options.quality: `number`，图片压缩质量，在图片格式为 `image/jpeg` 或 `image/webp` 的情况下生效，其他格式不会生效，可以从 0 到 1 的区间内选择图片的质量。默认值 0.92\n * options.maxWidh: `number`，压缩图片的最大宽度值\n * options.maxHeight: `number`，压缩图片的最大高度值 \n（注意：当 `maxWidth` 和 `maxHeight` 都不设置时，则采用原图尺寸大小）\n\n * options.noCompressIfLarger: `boolean`，为 `true` 时如果发现压缩后图片大小比原来还大，则返回源图片（即输出的 dist 直接返回了输入的 file）；默认 `false`，即保证图片尺寸符合要求，但不保证压缩后的图片体积一定变小\n * CompressResult: `object`，包含如下字段： \n * dist: 压缩后输出的 Blob 对象或原始的 File 对象\n * width: 压缩后的图片宽度\n * height: 压缩后的图片高度\n\n### qiniu.watermark(options: object, key?: string, domain?: string):\nstring（水印）\n\n返回添加水印后的图片地址\n\n * **key** : 文件资源名\n\n * **domain** : 为七牛空间（bucket)对应的域名，选择某个空间后，可通过\"空间设置->基本设置->域名设置\"查看获取，前端可以通过接口请求后端得到\n \n const imgLink = qiniu.watermark({\n mode: 1, // 图片水印\n image: 'http://www.b1.qiniudn.com/images/logo-2.png', // 图片水印的Url，mode = 1 时 **必需**\n dissolve: 50, // 透明度，取值范围1-100，非必需，下同\n gravity: 'SouthWest', // 水印位置，为以下参数 [NorthWest、North、NorthEast、West、Center、East、SouthWest、South、SouthEast] 之一\n dx: 100, // 横轴边距，单位:像素(px)\n dy: 100 // 纵轴边距，单位:像素(px)\n }, key, domain)\n \n // imgLink 可以赋值给 html 的 img 元素的 src 属性，下同\n \n // 若未指定key，可以通过以下方式获得完整的 imgLink，下同\n // imgLink = '<domain>/<key>?' + imgLink\n // <domain> 为七牛空间（bucket)对应的域名，选择某个空间后，可通过\"空间设置->基本设置->域名设置\"查看获取\n \n // 或者\n \n const imgLink = qiniu.watermark({\n mode: 2, // 文字水印\n text: 'hello world !', // 水印文字，mode = 2 时 **必需**\n dissolve: 50, // 透明度，取值范围1-100，非必需，下同\n gravity: 'SouthWest', // 水印位置，同上\n fontsize: 500, // 字体大小，单位: 缇\n font: '黑体', // 水印文字字体\n dx: 100, // 横轴边距，单位:像素(px)\n dy: 100, // 纵轴边距，单位:像素(px)\n fill: '#FFF000' // 水印文字颜色，RGB格式，可以是颜色名称\n }, key, domain)\n \n\noptions包含的具体水印参数解释见 [水印（watermark）\n__](https://developer.qiniu.com/dora/api/image-watermarking-processing-\nwatermark)\n\n### qiniu.imageView2(options: object, key?: string, domain?: string): string\n(缩略)\n\n返回处理后的图片url\n\n \n \n const imgLink = qiniu.imageView2({\n mode: 3, // 缩略模式，共 6 种 [0-5]\n w: 100, // 具体含义由缩略模式决定\n h: 100, // 具体含义由缩略模式决定\n q: 100, // 新图的图像质量，取值范围：1-100\n format: 'png' // 新图的输出格式，取值范围：jpg，gif，png，webp 等\n }, key, domain)\n \n\noptions包含的具体缩略参数解释见 [图片基本处理（imageView2）\n__](https://developer.qiniu.com/dora/api/basic-processing-images-imageview2)\n\n### qiniu.imageMogr2(options: object, key?: string, domain?: string): string\n(图像高级处理)\n\n返回处理后的图片url\n\n \n \n const imgLink = qiniu.imageMogr2({\n \"auto-orient\": true, // 布尔值，是否根据原图EXIF信息自动旋正，便于后续处理，建议放在首位。\n strip: true, // 布尔值，是否去除图片中的元信息\n thumbnail: '1000x1000' // 缩放操作参数\n crop: '!300x400a10a10', // 裁剪操作参数\n gravity: 'NorthWest', // 裁剪锚点参数\n quality: 40, // 图片质量，取值范围1-100\n rotate: 20, // 旋转角度，取值范围1-360，缺省为不旋转。\n format: 'png', // 新图的输出格式，取值范围：jpg，gif，png，webp等\n blur: '3x5' // 高斯模糊参数\n }, key, domain)\n \n\noptions包含的具体高级图像处理参数解释见 [图像高级处理（imageMogr2）\n__](https://developer.qiniu.com/dora/api/the-advanced-treatment-of-images-\nimagemogr2)\n\n### qiniu.imageInfo(key: string, domain: string): Promise\n\n \n \n qiniu.imageInfo(key, domain).then(res => {})\n \n\n具体 imageInfo 解释见 [图片基本信息（imageInfo）\n__](https://developer.qiniu.com/dora/api/pictures-basic-information-imageinfo)\n\n### qiniu.exif(key: string, domain: string): Promise\n\n \n \n qiniu.exif(key, domain).then(res => {})\n \n\n具体 exif 解释见 [图片 EXIF 信息（exif） __](https://developer.qiniu.com/dora/api/photo-\nexif-information-exif)\n\n### qiniu.pipeline(fopArr: array, key?: string, domain?: string): string\n\n \n \n const fopArr = [{\n fop: 'watermark', // 指定watermark操作\n mode: 2, // 此参数同watermark函数的参数，下同。\n text: 'hello world !',\n dissolve: 50,\n gravity: 'SouthWest',\n fontsize: 500,\n font : '黑体',\n dx: 100,\n dy: 100,\n fill: '#FFF000'\n },{\n fop: 'imageView2', // 指定imageView2操作\n mode: 3, // 此参数同imageView2函数的参数，下同\n w: 100,\n h: 100,\n q: 100,\n format: 'png'\n },{\n fop: 'imageMogr2', // 指定imageMogr2操作\n \"auto-orient\": true, // 此参数同imageMogr2函数的参数，下同。\n strip: true,\n thumbnail: '1000x1000'\n crop: '!300x400a10a10',\n gravity: 'NorthWest',\n quality: 40,\n rotate: 20,\n format: 'png',\n blur:'3x5'\n }]\n \n // fopArr 可以为三种类型'watermark'、'imageMogr2'、'imageView2'中的任意1-3个\n // 例如只对'watermark'、'imageMogr2'进行管道操作，则如下即可\n // const fopArr = [{\n // fop: 'watermark', // 指定watermark操作\n // mode: 2, // 此参数同watermark函数的参数，下同。\n // text: 'hello world !',\n // dissolve: 50,\n // gravity: 'SouthWest',\n // fontsize: 500,\n // font : '黑体',\n // dx: 100,\n // dy: 100,\n // fill: '#FFF000'\n // },{\n // fop: 'imageMogr2', // 指定imageMogr2操作\n // \"auto-orient\": true, // 此参数同imageMogr2函数的参数，下同。\n // strip: true,\n // thumbnail: '1000x1000'\n // crop: '!300x400a10a10',\n // gravity: 'NorthWest',\n // quality: 40,\n // rotate: 20,\n // format: 'png',\n // blur:'3x5'\n // }];\n \n const imgLink = qiniu.pipeline(fopArr, key, domain))\n \n\nfopArr包含的具体管道操作解释见 [管道操作\n__](https://developer.qiniu.com/dora/manual/processing-mechanism)\n\n### 运行示例\n\n 1. 进入 test 目录，按照目录下的 `config.json.example` 示例，创建 `config.json` 文件，其中，`Access Key` 和 `Secret Key` 按如下方式获取\n\n * [开通七牛开发者帐号 __](https://portal.qiniu.com/signup)\n * [登录七牛开发者自助平台，查看 AccessKey 和 SecretKey __](https://portal.qiniu.com/user/key)。\n \n {\n \"AccessKey\": \"<Your Access Key>\",\n \"SecretKey\": \"<Your Secret Key>\",\n \"Bucket\": \"<Your Bucket Name>\",\n \"Port\": 9000,\n \"UptokenUrl\": \"<Your Uptoken_Url>\", // demo 启动后会在本地 /uptoken 上提供获取 uptoken 的接口，所以这里可以填 'token'\n \"Domain\": \"<Your Bucket Domain>\" // Bucket 的外链默认域名，在 Bucket 的内容管理里查看，如：'http://xxx.bkt.clouddn.com/'\n }\n \n\n 2. 进入项目根目录，执行 `npm install` 安装依赖库，然后打开两个终端，一个执行 `npm run serve` 跑 server， 一个执行 `npm run dev` 运行服务；demo1：`http://0.0.0.0:8080/test/demo1`；demo3：`http://0.0.0.0:8080/test/demo3`；demo1为测试上传功能的示例，demo3为测试图片压缩功能的示例；demo2 为测试 es6 语法的示例，进入 demo2 目录，执行 `npm install`，然后 `npm start` 运行 demo2；demo1、demo2 和 demo3 都共用一个 server，请注意 server 文件里的 `region` 设置跟 `config` 里的`region` 设置要保持一致。\n\n### 说明\n\n 1. 如果您想了解更多七牛的上传策略，建议您仔细阅读 [七牛官方文档-上传 __](https://developer.qiniu.com/kodo/manual/upload-types)。另外，七牛的上传策略是在后端服务指定的.\n\n 2. 如果您想了解更多七牛的图片处理，建议您仔细阅读 [七牛官方文档-图片处理 __](https://developer.qiniu.com/dora/api/image-processing-api)\n\n 3. JS-SDK 示例生成 `token` 时，指定的 `Bucket Name` 为公开空间，所以可以公开访问上传成功后的资源。若您生成 `token` 时，指定的 `Bucket Name` 为私有空间，那您还需要在服务端进行额外的处理才能访问您上传的资源。具体参见 [下载凭证 __](https://developer.qiniu.com/kodo/manual/download-token)。JS-SDK 数据处理部分功能不适用于私有空间。\n\n### 常见问题\n\n**1\\. 关于上传文件命名问题，可以参考：**\n\n 1. 上传的 scope 为 `bucket` 的形式，上传后文件资源名以设置的 `key` 为主，如果 `key` 为 `null` 或者 `undefined`，则文件资源名会以 hash 值作为资源名。\n 2. 上传的 scope 为 `bucket:key` 的形式，上传文件本地的名字需要和 scope 中的 `key` 是一致的，不然会报错 key doesn‘t match with scope。\n 3. 上传的 scope 为 `bucket`，但是 `token` 中有设定 `saveKey`，这种形式下客户端的 `key` 如果设定为 `null` 或者 `undefined`，则会以 `saveKey` 作为文件资源名，否则仍然是以 `key` 值作为资源名，并且上传的本地文件名也是需要和这个 `savekey` 文件名一致的。\n\n**2\\. 限制上传文件的类型：**\n\n通过在生成 `token` 时指定 [上传策略 __](https://developer.qiniu.com/kodo/1206/put-\npolicy)中的`mimeLimit` 字段限定上传文件的类型，该功能由生成 `token` 的服务端 SDK 提供，请查看对应的服务端 SDK 文档。\n\n### 贡献代码\n\n 1. 登录 <https://github.com>[__](https://github.com)\n\n 2. Fork [email protected]:qiniu/js-sdk.git\n\n 3. 创建您的特性分支 (git checkout -b new-feature)\n\n 4. 提交您的改动 (git commit -am ‘Added some features or fixed a bug’)\n\n 5. 将您的改动记录提交到远程 git 仓库 (git push origin new-feature)\n\n 6. 然后到 github 网站的该 git 远程仓库的 new-feature 分支下发起 Pull Request\n\n### 许可证\n\n> Copyright © 2018 qiniu.com\n\n### 基于 MIT 协议发布\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储JavaScript SDK历史文档2.x"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [JavaScript\nSDK](https://developer.qiniu.com/kodo/sdk/1283/javascript) > JavaScript\nSDK历史文档2.x\n\n# JavaScript SDK历史文档2.x\n\n最近更新时间: 2020-06-28 15:14:03\n\nQiniu-JavaScript-SDK （下文简称为 JS-SDK）适用于 ：IE11、Edge、Chrome、Firefox、Safari\n等浏览器，基于七牛云存储官方 API 构建，其中上传功能基于 H5 File API。开发者基于 JS-SDK\n可以方便的从浏览器端上传文件至七牛云存储，并对上传成功后的图片进行丰富的数据处理操作。 \nJS-SDK 兼容支持 H5 File API 的浏览器，在低版本浏览器下，需要额外的插件如 plupload，JS-SDK\n提供了一些接口可以结合插件来进行上传工作。\n\nQiniu-JavaScript-SDK 为客户端 SDK，没有包含 `token` 生成实现，为了安全，`token`\n建议通过网络从服务端获取，具体生成代码可以参考服务端 SDK 的文档。\n\n * [JavaScript SDK 下载地址](https://github.com/qiniu/js-sdk/releases)\n * [JavaScript SDK 源码地址](https://github.com/qiniu/js-sdk)\n * [JavaScript SDK 在线示例](http://jssdk-v2.demo.qiniu.io/)\n\n### 功能简介\n\n * 上传\n * 大于 4M 时可分块上传，小于 4M 时直传\n * 分块上传时，支持断点续传\n * 数据处理（图片）\n * imageView2（缩略图）\n * imageMogr2（高级处理，包含缩放、裁剪、旋转等）\n * imageInfo （获取基本信息）\n * exif （获取图片 EXIF 信息）\n * watermark （文字、图片水印）\n * pipeline （管道，可对 imageView2、imageMogr2、watermark 进行链式处理）\n\n### 准备\n\n * 在使用 JS-SDK 之前，您必须先注册一个七牛帐号，并登录控制台获取一对有效的 `AccessKey` 和 `SecretKey`，您可以阅读[ 快速入门 ](https://developer.qiniu.com/kodo/manual/console-quickstart)和[ 安全机制 ](https://developer.qiniu.com/kodo/manual/security#security) 以进一步了解如何正确使用和管理密钥 。\n\n * JS-SDK 依赖服务端颁发 `token`，可以通过以下二种方式实现：\n\n * 利用[七牛服务端 SDK ](https://developer.qiniu.com/sdk#sdk)构建后端服务\n * 利用七牛底层 API 构建服务，详见七牛[上传策略](https://developer.qiniu.com/kodo/manual/put-policy)和[上传凭证](https://developer.qiniu.com/kodo/manual/upload-token)\n\n前端通过接口请求以获得 `token` 信息\n\n# 引入\n\n支持以下几种安装方式\n\n * 直接使用静态文件地址：\n \n https://unpkg.com/qiniu-js@<version>/dist/qiniu.min.js\n \n\n通过script标签引入该文件，会在全局生成名为 `qiniu` 的对象，其中 `<version>` 为 SDK 版本号，详细版本号列表可参考\n<https://www.npmjs.com/package/qiniu-js>\n\n * 使用 NPM 安装\n\nNPM 的全称是 Node Package Manager，是一个[ NodeJS\n](https://nodejs.org)包管理和分发工具，已经成为了非官方的发布 Node 模块（包）的标准。如果需要更详细的关于 NPM\n的使用说明，您可以访问[ NPM\n官方网站](https://www.npmjs.com)，或对应的[中文网站](http://www.npmjs.com.cn/)\n\n \n npm install qiniu-js\n \n \n var qiniu = require('qiniu-js')\n // or\n import * as qiniu from 'qiniu-js'\n \n\n * 通过源码编译\n\n`·git clone [email protected]:qiniu/js-sdk.git`，进入项目根目录执行`npm install`，执行 `npm\nrun build`，即可在dist目录生成qiniu.min.js\n\n# 上传\n\n## 使用\n\n`qiniu.upload` 返回一个 `observable` 对象用来控制上传行为，`observable` 对像通过 `subscribe`\n方法可以被 `observer` 所订阅，订阅同时会开始触发上传，同时返回一个 `subscription` 对象，该对象有一个 `unsubscribe`\n方法取消订阅，同时终止上传行为。对于不支持 sdk 的浏览器可以参考 demo1 中用插件处理和 form 直传的方式； 一般 form\n提交常常会导致网页跳转，demo1 中 form 直传通过加入 iframe，并结合后端 sdk 上传来解决网页跳转问题，实现 form\n无刷新上传。分片上传时，JS-\nSDK支持断点续传功能，会把已上传片的后端返回值ctx信息存储到本地，有效期为一天，超过一天后，当继续上传该文件时会清除掉本地存储信息重新上传。\n\n### Example\n\n \n \n var observable = qiniu.upload(file, key, token, putExtra, config)\n \n var subscription = observable.subscribe(observer) // 上传开始\n // or\n var subscription = observable.subscribe(next, error, complete) // 这样传参形式也可以\n \n subscription.unsubscribe() // 上传取消\n \n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/1731/api-overview)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n\n### qiniu.upload(file: blob, key: string, token: string, putExtra: object,\nconfig: object): observable\n\n * **observable** : 为一个带有 subscribe 方法的类实例\n\n * observable.subscribe(observer: object): subscription\n\n * observer: `observer` 为一个 `object`，用来设置上传过程的监听函数，有三个属性 `next`、`error`、`complete`:\n \n var observer = {\n next(res){\n // ...\n },\n error(err){\n // ...\n }, \n complete(res){\n // ...\n }\n }\n \n\n * next: 接收上传进度信息，res 参数是一个带有 `total` 字段的 `object`，包含`loaded`、`total`、`percent`三个属性，提供上传进度信息。\n\n * total.loaded: `number`，已上传大小，单位为字节。\n * total.total: `number`，本次上传的总量控制信息，单位为字节，注意这里的 total 跟文件大小并不一致。\n * total.percent: `number`，当前上传进度，范围：0～100。\n * error: 上传错误后触发，当不是 xhr 请求错误时，会把当前错误产生原因直接抛出，诸如 JSON 解析异常等；当产生 xhr 请求错误时，参数 err 为一个包含 `code`、`message`、`isRequestError` 三个属性的 `object`：\n\n * err.isRequestError: 用于区分是否 xhr 请求错误；当 xhr 请求出现错误并且后端通过 HTTP 状态码返回了错误信息时，该参数为 `true`；否则为 `undefined` 。\n * err.reqId: `string`，xhr请求错误的 `X-Reqid`。\n * err.code: `number`，请求错误状态码，只有在 `err.isRequestError` 为 true 的时候才有效，可查阅码值对应[说明](https://developer.qiniu.com/kodo/api/3928/error-responses)。\n * err.message: `string`，错误信息，包含错误码，当后端返回提示信息时也会有相应的错误信息。\n * complete: 接收上传完成后的后端返回信息，res 参数为一个 `object`， 为上传成功后后端返回的信息，具体返回结构取决于后端sdk的配置，可参考[上传策略](https://developer.qiniu.com/kodo/manual/1206/put-policy)。\n\n * subscription: 为一个带有 `unsubscribe` 方法的类实例，通过调用 `subscription.unsubscribe()` 停止当前文件上传\n\n * **file** : `Blob` 对象，上传的文件\n\n * **key** : 文件资源名\n * **token** : 上传验证信息，前端通过接口请求后端获得\n * **config** : `object`\n \n var config = {\n useCdnDomain: true,\n region: qiniu.region.z2\n };\n \n\n * config.useCdnDomain: 表示是否使用 cdn 加速域名，为布尔值，`true` 表示使用，默认为 `false`。\n * config.disableStatisticsReport: 是否禁用日志报告，为布尔值，默认为`false`。\n * config.region: 选择上传域名区域；当为 `null` 或 `undefined` 时，自动分析上传域名区域\n * config.retryCount: 上传自动重试次数（整体重试次数，而不是某个分片的重试次数）；默认 3 次（即上传失败后最多重试两次）；**目前仅在上传过程中产生`599` 内部错误时生效**，**但是未来很可能会扩展为支持更多的情况** 。\n * config.concurrentRequestLimit: 分片上传的并发请求量，`number`，默认为3；因为浏览器本身也会限制最大并发量，所以最大并发量与浏览器有关。\n * config.checkByMD5: 是否开启 MD5 校验，为布尔值；在断点续传时，开启 MD5 校验会将已上传的分片与当前分片进行 MD5 值比对，若不一致，则重传该分片，避免使用错误的分片。读取分片内容并计算 MD5 需要花费一定的时间，因此会稍微增加断点续传时的耗时，默认为 false，不开启。\n * **putExtra** :\n \n var putExtra = {\n fname: \"\",\n params: {},\n mimeType: [\"image/png\"]\n };\n \n\n * fname: `string`，文件原文件名\n * params: `object`，用来放置自定义变量\n * mimeType: `null || array`，用来限定上传文件类型，指定null时自动判断文件类型。 \n`[\"image/png\", \"image/jpeg\", \"image/gif\"]`\n\n### qiniu.createMkFileUrl(url: string, size: number, key: string, putExtra:\nobject): string\n\n返回创建文件的 url；当分片上传时，我们需要把分片返回的 ctx 信息拼接后通过该 url 上传给七牛以创建文件。\n\n * **url** : 上传域名，可以通过qiniu.getUploadUrl()获得\n * **size** : 文件大小\n * **key** : 文件资源名\n * **putExtra** : 同上\n \n var requestUrl = qiniu.createMkFileUrl(\n uploadUrl,\n file.size,\n key,\n putExtra\n );\n \n\n### qiniu.region: object\n\n * **qiniu.region.z0** : 代表华东区域\n * **qiniu.region.z1** : 代表华北区域\n * **qiniu.region.z2** : 代表华南区域\n * **qiniu.region.na0** : 代表北美区域\n * **qiniu.region.as0** : 代表东南亚区域\n\n### qiniu.getUploadUrl(config: object): string\n\n接收参数为 `config` 对象，返回根据 `config` 里所配置信息的上传域名\n\n \n \n var requestUrl = qiniu.getUploadUrl(config)\n \n\n### qiniu.getHeadersForChunkUpload(token: string): object\n\n返回 `object`，包含用来获得分片上传设置的头信息，参数为 `token` 字符串；当分片上传时，请求需要带该函数返回的头信息\n\n * **token** : 后端返回的上传验证信息\n \n var headers = qiniu.getHeadersForChunkUpload(token)\n \n\n### qiniu.getHeadersForMkFile(token: string): object\n\n返回 `object`，包含用来获得文件创建的头信息，参数为 `token` 字符串；当分片上传完需要把 ctx\n信息传给七牛用来创建文件时，请求需要带该函数返回的头信息\n\n \n \n var headers = qiniu.getHeadersForMkFile(token)\n \n\n### qiniu.filterParams(params: object): array\n\n返回[[k, v],...]格式的数组，k 为自定义变量 `key` 名，v 为自定义变量值，用来提取 `putExtra.params` 包含的自定义变量\n\n \n \n var customVarList = qiniu.filterParams(putExtra.params)\n \n for (var i = 0; i < customVarList.length; i++) {\n var k = customVarList[i]\n multipart_params_obj[k[0]] = k[1]\n }\n \n\n### qiniu.watermark(options: object, key: string, domain: string): string（水印）\n\n返回添加水印后的图片地址\n\n * **key** : 文件资源名\n * **domain** : 为七牛空间（bucket)对应的域名，选择某个空间后，可通过\"空间设置->基本设置->域名设置\"查看获取，前端可以通过接口请求后端得到\n \n var imgLink = qiniu.watermark({\n mode: 1, // 图片水印\n image: 'http://www.b1.qiniudn.com/images/logo-2.png', // 图片水印的Url，mode = 1 时 **必需**\n dissolve: 50, // 透明度，取值范围1-100，非必需，下同\n gravity: 'SouthWest', // 水印位置，为以下参数[NorthWest、North、NorthEast、West、Center、East、SouthWest、South、SouthEast]之一\n dx: 100, // 横轴边距，单位:像素(px)\n dy: 100 // 纵轴边距，单位:像素(px)\n }, key, domain) // key 为非必需参数，下同\n \n // imgLink 可以赋值给 html 的 img 元素的 src 属性，下同\n \n // 若未指定key，可以通过以下方式获得完整的 imgLink，下同\n // imgLink = '<domain>/<key>?' + imgLink\n // <domain> 为七牛空间（bucket)对应的域名，选择某个空间后，可通过\"空间设置->基本设置->域名设置\"查看获取\n \n // 或者\n \n var imgLink = qiniu.watermark({\n mode: 2, // 文字水印\n text: 'hello world !', // 水印文字，mode = 2 时 **必需**\n dissolve: 50, // 透明度，取值范围1-100，非必需，下同\n gravity: 'SouthWest', // 水印位置，同上\n fontsize: 500, // 字体大小，单位: 缇\n font: '黑体', // 水印文字字体\n dx: 100, // 横轴边距，单位:像素(px)\n dy: 100, // 纵轴边距，单位:像素(px)\n fill: '#FFF000' // 水印文字颜色，RGB格式，可以是颜色名称\n }, key,domain)\n \n\noptions包含的具体水印参数解释见[水印（watermark）](https://developer.qiniu.com/dora/api/image-\nwatermarking-processing-watermark)\n\n### qiniu.imageView2(options: object, key: string, domain: string): string\n(缩略)\n\n返回处理后的图片url\n\n \n \n var imgLink = qiniu.imageView2({\n mode: 3, // 缩略模式，共6种[0-5]\n w: 100, // 具体含义由缩略模式决定\n h: 100, // 具体含义由缩略模式决定\n q: 100, // 新图的图像质量，取值范围：1-100\n format: 'png' // 新图的输出格式，取值范围：jpg，gif，png，webp等\n }, key, domain)\n \n\noptions包含的具体缩略参数解释见[图片基本处理（imageView2）](https://developer.qiniu.com/dora/api/basic-\nprocessing-images-imageview2)\n\n### qiniu.imageMogr2(options: object, key: string, domain: string): string\n(图像高级处理)\n\n返回处理后的图片url\n\n \n \n var imgLink = qiniu.imageMogr2({\n \"auto-orient\": true, // 布尔值，是否根据原图EXIF信息自动旋正，便于后续处理，建议放在首位。\n strip: true, // 布尔值，是否去除图片中的元信息\n thumbnail: '1000x1000' // 缩放操作参数\n crop: '!300x400a10a10', // 裁剪操作参数\n gravity: 'NorthWest', // 裁剪锚点参数\n quality: 40, // 图片质量，取值范围1-100\n rotate: 20, // 旋转角度，取值范围1-360，缺省为不旋转。\n format: 'png', // 新图的输出格式，取值范围：jpg，gif，png，webp等\n blur: '3x5' // 高斯模糊参数\n }, key, domain)\n \n\noptions包含的具体高级图像处理参数解释见[图像高级处理（imageMogr2）](https://developer.qiniu.com/dora/api/the-\nadvanced-treatment-of-images-imagemogr2)\n\n### qiniu.imageInfo(key: string, domain: string): Promise\n\n \n \n qiniu.imageInfo(key, domain).then(res => {})\n \n\n具体 imageInfo\n解释见[图片基本信息（imageInfo）](https://developer.qiniu.com/dora/api/pictures-basic-\ninformation-imageinfo)\n\n### qiniu.exif(key: string, domain: string): Promise\n\n \n \n qiniu.exif(key, domain).then(res => {})\n \n\n具体 exif 解释见[图片 EXIF 信息（exif）](https://developer.qiniu.com/dora/api/photo-exif-\ninformation-exif)\n\n### qiniu.pipeline(fopArr: array, key: string, domain: string): string\n\n \n \n var fopArr = [{\n fop: 'watermark', // 指定watermark操作\n mode: 2, // 此参数同watermark函数的参数，下同。\n text: 'hello world !',\n dissolve: 50,\n gravity: 'SouthWest',\n fontsize: 500,\n font : '黑体',\n dx: 100,\n dy: 100,\n fill: '#FFF000'\n },{\n fop: 'imageView2', // 指定imageView2操作\n mode: 3, // 此参数同imageView2函数的参数，下同\n w: 100,\n h: 100,\n q: 100,\n format: 'png'\n },{\n fop: 'imageMogr2', // 指定imageMogr2操作\n \"auto-orient\": true, // 此参数同imageMogr2函数的参数，下同。\n strip: true,\n thumbnail: '1000x1000'\n crop: '!300x400a10a10',\n gravity: 'NorthWest',\n quality: 40,\n rotate: 20,\n format: 'png',\n blur:'3x5'\n }]\n \n // fopArr 可以为三种类型'watermark'、'imageMogr2'、'imageView2'中的任意1-3个\n // 例如只对'watermark'、'imageMogr2'进行管道操作，则如下即可\n // var fopArr = [{\n // fop: 'watermark', // 指定watermark操作\n // mode: 2, // 此参数同watermark函数的参数，下同。\n // text: 'hello world !',\n // dissolve: 50,\n // gravity: 'SouthWest',\n // fontsize: 500,\n // font : '黑体',\n // dx: 100,\n // dy: 100,\n // fill: '#FFF000'\n // },{\n // fop: 'imageMogr2', // 指定imageMogr2操作\n // \"auto-orient\": true, // 此参数同imageMogr2函数的参数，下同。\n // strip: true,\n // thumbnail: '1000x1000'\n // crop: '!300x400a10a10',\n // gravity: 'NorthWest',\n // quality: 40,\n // rotate: 20,\n // format: 'png',\n // blur:'3x5'\n // }];\n \n var imgLink = qiniu.pipeline(fopArr, key, domain))\n \n\nfopArr包含的具体管道操作解释见[管道操作](https://developer.qiniu.com/dora/api/3683/img-\ndirections-for-use)\n\n# 运行示例\n\n 1. 进入 test 目录，按照目录下的 `config.json.example` 示例，创建 `config.json` 文件，其中，`Access Key` 和 `Secret Key` 按如下方式获取\n\n * [开通七牛开发者帐号](https://portal.qiniu.com/signup)\n * [登录七牛开发者自助平台，查看 AccessKey 和 SecretKey](https://portal.qiniu.com/user/key) 。\n \n module.exports = {\n AccessKey: \"<Your Access Key>\",\n SecretKey: \"<Your Secret Key>\",\n Bucket: \"<Your Bucket Name>\",\n Port: 19110,\n UptokenUrl: \"<Your Uptoken_Url>\", // demo 启动后会在本地 /uptoken 上提供获取 uptoken 的接口，所以这里可以填 'token'\n Domain: \"<Your Bucket Domain>\" // Bucket 的外链默认域名，在 Bucket 的内容管理里查看，如：'http://xxx.bkt.clouddn.com/'\n }\n \n\n 2. 进入项目根目录，执行 `npm install` 安装依赖库，然后打开两个终端，一个执行 `npm run serve` 跑 server， 一个执行 `npm run dev` 运行服务 demo1； demo2 为测试es6语法的 demo，进入 demo2 目录，执行 `npm install`，然后 `npm start` 运行 demo2，demo1 和 demo2 都共用一个 server。\n\n**说明**\n\n 1. 如果您想了解更多七牛的上传策略，建议您仔细阅读 [七牛官方文档-上传](https://developer.qiniu.com/kodo/manual/upload-types)。另外，七牛的上传策略是在后端服务指定的.\n\n 2. 如果您想了解更多七牛的图片处理，建议您仔细阅读 [七牛官方文档-图片处理](https://developer.qiniu.com/dora/api/3683/img-directions-for-use)\n\n 3. JS-SDK 示例生成 `token` 时，指定的 `Bucket Name` 为公开空间，所以可以公开访问上传成功后的资源。若您生成 `token` 时，指定的 `Bucket Name` 为私有空间，那您还需要在服务端进行额外的处理才能访问您上传的资源。具体参见[下载凭证](https://developer.qiniu.com/kodo/manual/download-token)。JS-SDK 数据处理部分功能不适用于私有空间。\n\n# 常见问题\n\n**1\\. 关于上传文件命名问题，可以参考：**\n\n 1. 上传的 scope 为 `bucket` 的形式，上传后文件资源名以设置的 `key` 为主，如果 `key` 为 `null` 或者 `undefined`，则文件资源名会以 hash 值作为资源名。\n 2. 上传的 scope 为 `bucket:key` 的形式，上传文件本地的名字需要和 scope 中的 `key` 是一致的，不然会报错 key doesn‘t match with scope。\n 3. 上传的 scope 为 `bucket`，但是 `token` 中有设定 `saveKey`，这种形式下客户端的 `key` 如果设定为 `null` 或者 `undefined`，则会以 `saveKey` 作为文件资源名，否则仍然是以 `key` 值作为资源名，并且上传的本地文件名也是需要和这个 `savekey` 文件名一致的。\n\n**2\\. 限制上传文件的类型：**\n\n这里又分为两种方法：\n\n 1. 通过在 `token` 中设定 `mimeLimit` 字段限定上传文件的类型，该设定是在后端 sdk 设置，请查看相应的 sdk 文档，示例\n \n \"image/\\*\": 表示只允许上传图片类型；\n \"image/jpeg;image/png\": 表示只允许上传 jpg 和 png 类型的图片；\n \"!application/json;text/plain\": 表示禁止上传 json 文本和纯文本。（注意最前面的感叹号）\n \n\n 2. 通过 `putExtra` 的 `mimeType` 参数直接在前端限定\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛](http://segmentfault.com/qiniu) \\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单](http://support.qiniu.com/) \\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客](http://blog.qiniu.com) \\- 这里会持续更新发布市场活动和技术分享文章\n * [微博](http://weibo.com/qiniutek)\n * [常见问题](http://support.qiniu.com/)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am 'Added some feature'\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright (c) 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储JavaScript SDK历史文档1.x"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [JavaScript\nSDK](https://developer.qiniu.com/kodo/sdk/1283/javascript) > JavaScript\nSDK历史文档1.x\n\n# JavaScript SDK历史文档1.x\n\n最近更新时间: 2023-12-13 14:58:40\n\nJavaScript SDK 适用于 IE9+、Chrome、Firefox、Safari 等浏览器，基于七牛云 API 构建。开发者使用本 SDK\n可以方便的从浏览器端上传文件至七牛云。\n\n本 SDK 为客户端 SDK，没有包含 token 生成实现，为了安全，token 建议您通过网络从服务端获取，具体生成代码可以参考七牛服务端官方\nSDKs。\n\n * [JavaScript SDK 下载地址 __](https://github.com/qiniu/js-sdk/releases)\n * [JavaScript SDK 源码地址 __](https://github.com/qiniu/js-sdk/tree/1.x)\n * [JavaScript SDK 在线示例 __](http://jssdk.demo.qiniu.io/)\n\n### 功能简介\n\n * 上传\n * html5 模式大于 4 M 时可分块上传，小于 4 M 时直传\n * Flash、html4 模式直接上传\n * 继承了 Plupload 的功能，可筛选文件上传、拖曳上传等\n\n### 服务端准备\n\n本 SDK 依赖服务端颁发的上传凭证，可以通过以下二种方式实现：\n\n * 利用七牛服务端 SDK 构建后端服务\n * 利用七牛底层 API 构建服务，详见七牛[上传策略](https://developer.qiniu.com/kodo/manual/put-policy)和[上传凭证](https://developer.qiniu.com/kodo/manual/upload-token)\n\n后端服务应提供一个 URL 地址，供 SDK 初始化使用，前端通过 Ajax 请求该地址后获得 upToken。 \nAjax 请求成功后，服务端应返回如下格式的 json：\n\n \n \n {\n \"uptoken\": \"0MLvWPnyya1WtPnXFy9KLyGHyFPNdZceomL...\"\n }\n \n\n**引入 qiniu.js**\n\n获取 SDK 源码：\n\n \n \n git clone [email protected]:qiniupd/qiniu-js-sdk.git\n git checkout 1.x\n \n\nqiniu.min.js 位于 dist 目录内\n\n### 初始化\n\n要接入七牛云存储，您需要拥有一对有效的 Access Key 和 Secret Key 进行签名认证。可以通过如下步骤获得：\n\n 1. [开通七牛开发者帐号 __](https://portal.qiniu.com/signup)\n 2. 登录七牛开发者平台，查看[Access Key 和 Secret Key __](https://portal.qiniu.com/user/key)\n\n# 安装\n\n * 通过 Github 上的 qiniu/js-sdk 仓库获取，下载最新的[1.x 版本 __](https://github.com/qiniu/js-sdk/releases)并解压或直接克隆仓库，JS-SDK 在 dist 目录中：\n \n git clone https://github.com/qiniu/js-sdk.git\n git checkout 1.x\n \n\n * 或者下载1.0.14-beta版本并解压，在项目中静态引入：\n \n https://dn-odum9helk.qbox.me/qiniu-js-sdk/1.0.14-beta/qiniu.min.js.zip\n \n\n# 上传\n\n * 在页面中引入 qiniu.min.js\n\n * 初始化 uploader (**请确保在执行初始化时，页面已经引入 plupload**)：\n \n var uploader = Qiniu.uploader({\n runtimes: 'html5,flash,html4', // 上传模式，依次退化\n browse_button: 'pickfiles', // 上传选择的点选按钮，必需\n // 在初始化时，uptoken，uptoken_url，uptoken_func三个参数中必须有一个被设置\n // 切如果提供了多个，其优先级为uptoken > uptoken_url > uptoken_func\n // 其中uptoken是直接提供上传凭证，uptoken_url是提供了获取上传凭证的地址，如果需要定制获取uptoken的过程则可以设置uptoken_func\n // uptoken : '<Your upload token>', // uptoken是上传凭证，由其他程序生成\n // uptoken_url: '/uptoken', // Ajax请求uptoken的Url，强烈建议设置（服务端提供）\n // uptoken_func: function(){ // 在需要获取uptoken时，该方法会被调用\n // // do something\n // return uptoken;\n // },\n get_new_uptoken: false, // 设置上传文件的时候是否每次都重新获取新的uptoken\n // downtoken_url: '/downtoken',\n // Ajax请求downToken的Url，私有空间时使用，JS-SDK将向该地址POST文件的key和domain，服务端返回的JSON必须包含url字段，url值为该文件的下载地址\n // unique_names: true, // 默认false，key为文件名。若开启该选项，JS-SDK会为每个文件自动生成key（文件名）\n // save_key: true, // 默认false。若在服务端生成uptoken的上传策略中指定了sava_key，则开启，SDK在前端将不对key进行任何处理\n domain: '<Your bucket domain>', // bucket域名，下载资源时用到，必需\n container: 'container', // 上传区域DOM ID，默认是browser_button的父元素\n max_file_size: '100mb', // 最大文件体积限制\n flash_swf_url: 'path/of/plupload/Moxie.swf', //引入flash，相对路径\n max_retries: 3, // 上传失败最大重试次数\n dragdrop: true, // 开启可拖曳上传\n drop_element: 'container', // 拖曳上传区域元素的ID，拖曳文件或文件夹后可触发上传\n chunk_size: '4mb', // 分块上传时，每块的体积\n auto_start: true, // 选择文件后自动上传，若关闭需要自己绑定事件触发上传\n //x_vars : {\n // 查看自定义变量\n // 'time' : function(up,file) {\n // var time = (new Date()).getTime();\n // do something with 'time'\n // return time;\n // },\n // 'size' : function(up,file) {\n // var size = file.size;\n // do something with 'size'\n // return size;\n // }\n //},\n init: {\n 'FilesAdded': function(up, files) {\n plupload.each(files, function(file) {\n // 文件添加进队列后，处理相关的事情\n });\n },\n 'BeforeUpload': function(up, file) {\n // 每个文件上传前，处理相关的事情\n },\n 'UploadProgress': function(up, file) {\n // 每个文件上传时，处理相关的事情\n },\n 'FileUploaded': function(up, file, info) {\n // 每个文件上传成功后，处理相关的事情\n // 其中info.response是文件上传成功后，服务端返回的json，形式如：\n // {\n // \"hash\": \"Fh8xVqod2MQ1mocfI4S4KpRL6D98\",\n // \"key\": \"gogopher.jpg\"\n // }\n // 查看简单反馈\n // var domain = up.getOption('domain');\n // var res = parseJSON(info.response);\n // var sourceLink = domain +\"/\"+ res.key; 获取上传成功后的文件的Url\n },\n 'Error': function(up, err, errTip) {\n //上传出错时，处理相关的事情\n },\n 'UploadComplete': function() {\n //队列文件处理完毕后，处理相关的事情\n },\n 'Key': function(up, file) {\n // 若想在前端对每个文件的key进行个性化处理，可以配置该函数\n // 该配置必须要在unique_names: false，save_key: false时才生效\n \n var key = \"\";\n // do something with key here\n return key\n }\n }\n });\n \n // domain为七牛空间对应的域名，选择某个空间后，可通过 空间设置->基本设置->域名设置 查看获取\n \n // uploader为一个plupload对象，继承了所有plupload的方法\n \n\n * [自定义变量](https://developer.qiniu.com/kodo/manual/vars#xvar)\n * [简单反馈](https://developer.qiniu.com/kodo/manual/response-body)\n * [plupload __](http://plupload.com/docs)\n * 如果一个页面中有多个上传实例，可以按如下操作：\n \n var option1 = {\n key : val ,\n ……\n };\n var uploader = Qiniu.uploader(option1);\n \n var Qiniu2 = new QiniuJsSDK();\n var option2 = {\n key : val ,\n ……\n };\n var uploader2 = Qiniu2.uploader(option2);\n \n \n\n# 运行示例\n\n直接运行本 SDK 示例网站的服务\n\n * 安装[Nodejs __](http://nodejs.org/download/)\n\n * 获取源代码：\n \n git clone [email protected]:qiniu/js-sdk.git\n git checkout 1.x\n \n\n * 进入项目根目录，执行 make install，安装七牛 Node.js SDK、Express\n\n * 进入 demo 目录，按照目录下的 config.example 示例，创建 config.js 文件，其中 Access Key 和 Secret Key 按如下方式获取：\n\n 1. [开通七牛开发者帐号 __](https://portal.qiniu.com/signup)\n 2. 登录七牛开发者自助平台，查看[Access Key 和 Secret Key __](https://portal.qiniu.com/user/key)。\n\n \n \n \n module.exports = {\n 'ACCESS_KEY': '<Your Access Key>',\n 'SECRET_KEY': '<Your Secret Key>',\n 'Bucket_Name': '<Your Bucket Name>',\n 'Port': 19110,\n 'Uptoken_Url': '<Your Uptoken_Url>',\n 'Domain': '<Your Bucket Domain>'\n }\n \n\n * 进入项目根目录，执行 make dev 访问 `http://127.0.0.1:19110/` 或 `http://localhost:19110/`。\n\n**说明**\n\n * 本 SDK 依赖 uptoken，可以直接设置 upload，通过提供 Ajax 请求地址 uptoken_url 或者通过提供一个能够返回 uptoken 的函数 uptoken_func 实现。\n\n * 如果您想了解更多七牛的上传策略，建议您仔细阅读[上传策略](https://developer.qiniu.com/kodo/manual/put-policy)。另外，七牛的上传策略是在后端服务指定的，本 SDK 的 setOption API 只是设置 Plupload 的初始化参数，和上传策略无关。\n\n * 如果您想了解更多七牛的图片处理，建议您仔细阅读七牛官方文档[图片处理](https://developer.qiniu.com/dora/manual/3683)。\n\n * 本 SDK 示例生成 upToken 时，指定的 Bucket Name 为公开空间，所以可以公开访问上传成功后的资源。若您生成 upToken 时，指定的 Bucket Name 为私有空间，那您还需要在服务端进行额外的处理才能访问您上传的资源，具体请参阅[下载凭证](https://developer.qiniu.com/kodo/manual/download-token)。本 SDK 数据处理功能不适用于私有空间。\n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/1731/api-overview)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n\n# 常见问题\n\n七牛提供基于 plupload 插件封装上传的[demo __](http://jssdk.demo.qiniu.io/)，如果不需要 plupload\n插件请参阅<https://github.com/iwillwen/qiniu.js/tree/develop>[\n__](https://github.com/iwillwen/qiniu.js/tree/develop)，这里主要针对基于 plupload\n插件的方式讲解遇到的一些问题，通过参阅 plupload 文档资料，可以对七牛的 demo 进行修改，以满足自己的业务需求，plupload\n插件的使用文档请参阅<http://www.cnblogs.com/2050/p/3913184.html>[\n__](http://www.cnblogs.com/2050/p/3913184.html)。\n\n**1\\. 关于上传文件命名问题**\n\n在 main.js 里面，unique_names 是 plupload 插件下面的一个参数，当值为 true\n时会为每个上传的文件生成一个唯一的文件名，这个是 plupload 插件自动生成的，如果设置成 false，七牛会以上传的原始名进行命名。\n\n * 上传的 scope 为 bucket 的形式，unique_names 参数设置为 false ，上传后文件的 key 是本地的文件名 abc.txt。\n * 上传的 scope 为 bucket 的形式，unique_names 参数设置为 true ，plupload 插件会忽略本地文件名，而且这个命名也是没有规律的，上传后文件的 key 是 plupload 插件生成的，如： Yc7DZRS1m73o.txt。\n * 上传的 scope 为 bucket:key 的形式，上传文件本地的名字需要和 scope 中的 key 是一致的，不然会报错`key doesn‘t match with scope`。 \n**注意：**这种形式不能设置 unique_names 为 true，因为即使上传文件本地名字为 abc.txt，但是 plupload\n会给这个文件赋值另外一个文件名。\n\n * 上传的 scope 为 bucket，但是 token 中有设定 saveKey，这种形式 save_key 应该设置为 true ，并且上传的本地文件名需要和这个 savekey 文件名一致。\n * 通过 JS 前端设置上传的 key，在 main.js 文件里面设置如下：\n\n \n \n 'Key': function(up, file) {\n var key = \"\";\n // do something with key\n return key\n }\n \n\n这个默认是注释的，若想在前端对每个文件的 key 进行个性化处理，可以配置该函数， \n该配置必须要在 unique_names: false，save_key: false 时才生效， \n取消注释后，其优先级要高于：qiniu.js 文件中 getFileKey。\n\n**2\\. 设置自定义预览样式**\n\n \n \n // 该设置在ui.js文件里，默认为\n var imageView ='?imageView2/1/w/100/h/100'\n // 可修改成\n var imageView ='样式符+样式名'\n \n\n**3\\. 关于设置取消上传问题**\n\n<http://stackoverflow.com/questions/11014384/cancel-file-upload-\nlistener>[__](http://stackoverflow.com/questions/11014384/cancel-file-upload-\nlistener)\n\n（文件 plupload.dev.js 1950行 removeFile : function(file) 方法）\n\n**4\\. 限制上传文件的类型**\n\n这里分为两种方法：\n\n1.通过在 token 中设定 mimeLimit 字段限定上传文件的类型，示例：\n\n * image/*：表示只允许上传图片类型\n * image/jpeg;image/png：表示只允许上传 jpg 和 png 类型的图片\n * !application/json;text/plain：表示禁止上传 json 文本和纯文本（注意最前面的感叹号）\n\n 2. FilesAdded 判断\n\n \n \n 'FilesAdded': function(up, files) {\n $('table').show();\n $('#success').hide();\n //文件限制\n plupload.each(files, function(file) {\n console.log('filetype: ' + file.type);\n if(file.type=='image/jpeg'||file.type=='image/jpg'||file.type=='image/png'||file.type=='image/gif' || file.type=='video/x-matroska' || file.type=='video/mp4'){\n console.log('type:' + file.type);\n isUpload =true;\n // file.album_name=album_name;\n var progress = new FileProgress(file, 'fsUploadProgress');\n progress.setStatus(\"等待...\");\n progress.bindUploadCancel(up);\n }else {\n isUpload = false;\n up.removeFile(file);\n console.log('上传类型只能是.jpg,.png,.gif,.mkv');\n return false;\n }});\n },\n \n \n \n **5. 设置每次只能选择一个文件**\n \n 通过 plupload 插件中的 multi_selection 参数控制，如下：\n \n ```javascript\n // 设置一次只能选择一个文件\n multi_selection: false,\n \n\n**6\\. 设置取消上传，暂停上传**\n\n在 index.html 中加入两个控制按钮：\n\n \n \n <a class=\"btn btn-default btn-lg \" id=\"up_load\" href=\"#\" >\n <span>确认上传</span>\n </a>\n <a class=\"btn btn-default btn-lg \" id=\"stop_load\" href=\"#\" >\n <span>暂停上传</span>\n </a>\n \n\n然后在 main.js 文件里面绑定这两个按钮，添加代码如下：\n\n \n \n $('#up_load').on('click', function(){\n uploader.start();\n });\n $('#stop_load').on('click', function(){\n uploader.stop();\n });\n \n\n**7\\. 取消分片上传**\n\n将 main.js 里面的 chunk_size: ‘4mb’ 参数设置为 chunk_size: ‘0mb’，注意分片上传默认分片大小是\n4M，如果设置一个别的分片大小则会上传失败。\n\n**8\\. 取消自动上传**\n\n将 main.js 里面的 auto_start 参数设置为 auto_start: false\n\n**9\\. 关于请求 token 出现跨域**\n\n因为都是建议用户从后端 SDK 获取 token，然后在 main.js 里设置参数\nuptoken_url:‘获取uptoken的url’，这里就有可能出现跨域的现象，此时在服务端添加 response.setHeader(“Access-\nControl-Allow-Origin”,\"*\"); 相应头字段即可。\n\n推荐一个关于[CORS __](http://enable-cors.org/)的网站\n\n**10\\. Android 自带的 Webview 对JS SDK不支持**\n\n在 Android 自带的 Webview 里面引用 JS SDK 的[demo __](http://jssdk.demo.qiniu.io/)：\n\n \n \n public class MainActivity extends Activity {\n private WebView webview;\n @Override\n protected void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n setContentView(R.layout.activity_main);\n webview = (WebView) findViewById(R.id.wv);\n webview.getSettings().setJavaScriptEnabled(true);\n webview.setWebViewClient(new WebViewClient(){\n public boolean shouldOverrideUrlLoading(WebView view, String url){\n view.loadUrl(url); \n return true;\n }\n });\n webview.loadUrl(\"http://demos.qiniu.com/demo/simpleuploader/\");\n }\n \n }\n \n\n但是点击选择文件按钮没有反应，这个是 Webview 对 JS 不是很支持造成的，解决方法可以引入这个 Webview ，jar包地址如下: \n<https://o8qpi53g2.qnssl.com/Android-\nAdvancedWebView.jar>[__](https://o8qpi53g2.qnssl.com/Android-\nAdvancedWebView.jar)，使用方法请参考：\n\n \n \n private AdvancedWebView mWebView;\n @Override\n protected void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n setContentView(R.layout.activity_main);\n \n mWebView = (AdvancedWebView) findViewById(R.id.webview);\n mWebView.setListener(this, this);\n mWebView.loadUrl(\"http://jssdk.demo.qiniu.io/\");\n }\n \n\n**11\\. 关于多个按钮选择文件的 Demo**\n\n很多用户都在问 JSSDK 多文件选择的 Demo，其实只需要在 main.js 文件里多 new 几个 Uploader\n对象，然后在主页上写好对应的上传按钮就可以了。\n\nmain.js 里面多 new 几个 uploader 对象：\n\n \n \n $(function() {\n var uploader = Qiniu.uploader({\n runtimes: 'html5,flash,html4',\n browse_button: 'pickfiles',\n container: 'container',\n drop_element: 'container',\n max_file_size: '100mb',\n flash_swf_url: 'js/plupload/Moxie.swf',\n dragdrop: true,\n chunk_size: '4mb',\n uptoken:'um6IEH7mtwnwkGpjImD08JdxlvViuELhI4mFfoeL:79ApUIePTtKIdVGDHJ9D9BfBnhE=:eyJzY29wZSI6ImphdmFkZW1vIiwiZGVhZGxpbmUiOjE0NTk4ODMyMzV9Cg==',\n // uptoken_url: $('#uptoken_url').val(), //当然建议这种通过url的方式获取token\n domain: $('#domain').val(),\n auto_start: false,\n init: {\n 'FilesAdded': function(up, files) {\n $('table').show();\n $('#success').hide();\n plupload.each(files, function(file) {\n var progress = new FileProgress(file, 'fsUploadProgress');\n progress.setStatus(\"等待...\");\n });\n },\n 'BeforeUpload': function(up, file) {\n var progress = new FileProgress(file, 'fsUploadProgress');\n var chunk_size = plupload.parseSize(this.getOption('chunk_size'));\n if (up.runtime === 'html5' && chunk_size) {\n progress.setChunkProgess(chunk_size);\n }\n },\n 'UploadProgress': function(up, file) {\n var progress = new FileProgress(file, 'fsUploadProgress');\n var chunk_size = plupload.parseSize(this.getOption('chunk_size'));\n \n progress.setProgress(file.percent + \"%\", file.speed, chunk_size);\n },\n 'UploadComplete': function() {\n $('#success').show();\n },\n 'FileUploaded': function(up, file, info) {\n var progress = new FileProgress(file, 'fsUploadProgress');\n progress.setComplete(up, info);\n },\n 'Error': function(up, err, errTip) {\n $('table').show();\n var progress = new FileProgress(err.file, 'fsUploadProgress');\n progress.setError();\n progress.setStatus(errTip);\n }\n }\n });\n \n uploader.bind('FileUploaded', function() {\n console.log('hello man,a file is uploaded');\n });\n \n $('#up_load').on('click', function(){\n uploader.start();\n });\n $('#stop_load').on('click', function(){\n uploader.stop();\n });\n \n var Q2 = new QiniuJsSDK();\n var uploader2 = Q2.uploader({\n runtimes: 'html5,flash,html4',\n browse_button: 'pickfiles2',\n container: 'container2',\n drop_element: 'container2',\n max_file_size: '100mb',\n flash_swf_url: 'js/plupload/Moxie.swf',\n dragdrop: true,\n chunk_size: '4mb',\n uptoken:'um6IEH7mtwnwkGpjImD08JdxlvViuELhI4mFfoeL:79ApUIePTtKIdVGDHJ9D9BfBnhE=:eyJzY29wZSI6ImphdmFkZW1vIiwiZGVhZGxpbmUiOjE0NTk4ODMyMzV9Cg==',\n // uptoken_url: $('#uptoken_url').val(), //当然建议这种通过url的方式获取token\n domain: $('#domain').val(),\n auto_start: false,\n init: {\n 'FilesAdded': function(up, files) {\n $('table').show();\n $('#success').hide();\n plupload.each(files, function(file) {\n var progress = new FileProgress(file, 'fsUploadProgress');\n progress.setStatus(\"等待...\");\n });\n },\n 'BeforeUpload': function(up, file) {\n var progress = new FileProgress(file, 'fsUploadProgress');\n var chunk_size = plupload.parseSize(this.getOption('chunk_size'));\n if (up.runtime === 'html5' && chunk_size) {\n progress.setChunkProgess(chunk_size);\n }\n },\n 'UploadProgress': function(up, file) {\n var progress = new FileProgress(file, 'fsUploadProgress');\n var chunk_size = plupload.parseSize(this.getOption('chunk_size'));\n \n progress.setProgress(file.percent + \"%\", file.speed, chunk_size);\n },\n 'UploadComplete': function() {\n $('#success').show();\n },\n 'FileUploaded': function(up, file, info) {\n var progress = new FileProgress(file, 'fsUploadProgress');\n progress.setComplete(up, info);\n },\n 'Error': function(up, err, errTip) {\n $('table').show();\n var progress = new FileProgress(err.file, 'fsUploadProgress');\n progress.setError();\n progress.setStatus(errTip);\n }\n }\n });\n \n uploader2.bind('FileUploaded', function() {\n console.log('hello man 2,a file is uploaded');\n });\n $('#up_load2').on('click', function(){\n uploader2.start();\n });\n $('#stop_load2').on('click', function(){\n uploader2.stop();\n });\n \n\n相应的 index.html 文件加入相关按钮：\n\n \n \n <div id=\"container\">\n <a class=\"btn btn-default btn-lg \" id=\"pickfiles\" style=\"width:160px\" href=\"#\" >\n <i class=\"glyphicon glyphicon-plus\"></i>\n <span>选择文件</span>\n </a>\n \n <a class=\"btn btn-default btn-lg \" id=\"up_load\" style=\"width:160px\" href=\"#\" >\n <span>确认上传</span>\n </a> \n \n <a class=\"btn btn-default btn-lg \" id=\"stop_load\" style=\"width:160px\" href=\"#\" >\n <span>暂停上传</span>\n </a> \n </div>\n \n <div id=\"container2\">\n <a class=\"btn btn-default btn-lg \" id=\"pickfiles2\" style=\"width:160px\" href=\"#\" >\n <i class=\"glyphicon glyphicon-plus\"></i>\n <span>选择文件</span>\n </a>\n \n <a class=\"btn btn-default btn-lg \" id=\"up_load2\" style=\"width:160px\" href=\"#\" >\n <span>确认上传</span>\n </a> \n \n <a class=\"btn btn-default btn-lg \" id=\"stop_load2\" style=\"width:160px\" href=\"#\" >\n <span>暂停上传</span>\n </a> \n </div>\n </div>\n \n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](http://support.qiniu.com/)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](http://support.qiniu.com/)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Node.js SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > Node.js SDK\n\n# Node.js SDK\n\n最近更新时间: 2024-04-30 14:22:50\n\n# 简介\n\n此 SDK 适用于 Node.js v6 及以上版本。使用此 SDK\n构建您的网络应用程序，能让您以非常便捷的方式将数据安全地存储到七牛云上。无论您的网络应用是一个网站程序，还是包括从云端（服务端程序）到终端（手持设备应用）的架构服务和应用，通过七牛云及其\nSDK，都能让您应用程序的终端用户高速上传和下载，同时也让您的服务端更加轻盈。\n\nNode.js SDK 属于七牛服务端 SDK 之一，主要有如下功能：\n\n 1. 提供生成客户端上传所需的上传凭证的功能\n 2. 提供文件从服务端直接上传七牛的功能\n 3. 提供对七牛空间中文件进行管理的功能\n 4. 提供对七牛空间中文件进行处理的功能\n 5. 提供七牛CDN相关的刷新，预取，日志功能\n\n# 开源\n\n * [Node.js SDK 项目地址 __](https://github.com/qiniu/nodejs-sdk)\n * [Node.js SDK 发布地址 __](https://github.com/qiniu/nodejs-sdk/releases)\n * [Node.js SDK 历史文档](https://developer.qiniu.com/kodo/sdk/3828/node-js-v6)\n\n# 安装\n\n推荐使用`npm`来安装：\n\n \n \n $ npm install qiniu\n \n\n# 鉴权\n\nNode.js SDK 的所有功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的 `Access Key` 和 `Secret Key`\n，这对密钥可以通过如下步骤获得：\n\n 1. 点击[注册🔗 __](https://portal.qiniu.com/signup)开通 七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里🔗 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n# 文件上传\n\n * 上传流程\n * 客户端上传凭证\n * 简单上传凭证\n * 覆盖上传凭证\n * 自定义上传回复凭证\n * 带回调业务服务器的凭证\n * 带数据处理的凭证\n * 带自定义参数的凭证\n * 综合上传凭证\n * 服务器直传\n * 构建配置类\n * 文件上传（表单方式）\n * 字节数组上传（表单方式）\n * 数据流上传（表单方式）\n * 文件分片上传（断点续传）\n * 数据流分片上传（断点续传）\n * 解析自定义回复内容\n * 业务服务器验证存储服务回调\n * 上传加速\n\n### 上传流程\n\n文件上传分为客户端上传（主要是指网页端和移动端等面向终端用户的场景）和服务端上传两种场景，具体可以参考文档[业务流程](https://developer.qiniu.com/kodo/manual/1205/programming-\nmodel)。\n\n服务端SDK在上传方面主要提供两种功能，一种是生成客户端上传所需要的上传凭证，另外一种是直接上传文件到云端。\n\n### 客户端上传凭证\n\n客户端（移动端或者Web端）上传文件的时候，需要从客户自己的业务服务器获取上传凭证，而这些上传凭证是通过服务端的 SDK 来生成的，然后通过客户自己的业务\nAPI 分发给客户端使用。根据上传的业务需求不同，Node.js SDK 支持丰富的上传凭证生成方式。\n\n创建各种上传凭证之前，我们需要定义好其中鉴权对象 `mac`：\n\n \n \n const accessKey = 'your access key';\n const secretKey = 'your secret key';\n const mac = new qiniu.auth.digest.Mac(accessKey, secretKey);\n \n\n#### 简单上传的凭证\n\n最简单的上传凭证只需要 `AccessKey`，`SecretKey` 和 `Bucket` 就可以。\n\n \n \n const options = {\n scope: bucket,\n };\n const putPolicy = new qiniu.rs.PutPolicy(options);\n const uploadToken=putPolicy.uploadToken(mac);\n \n\n默认情况下，在不指定上传凭证的有效时间情况下，默认有效期为 1 个小时。也可以自行指定上传凭证的有效期，例如：\n\n \n \n // 自定义凭证有效期（示例 2 小时，expires 单位为秒，为上传凭证的有效时间）\n const options = {\n scope: bucket,\n expires: 7200\n };\n const putPolicy = new qiniu.rs.PutPolicy(options);\n const uploadToken=putPolicy.uploadToken(mac);\n \n\n#### 覆盖上传的凭证\n\n覆盖上传除了需要`简单上传`所需要的信息之外，还需要想进行覆盖的文件名称，这个文件名称同时可是客户端上传代码中指定的文件名，两者必须一致。\n\n \n \n const keyToOverwrite = 'qiniu.mp4';\n const options = {\n scope: bucket + \":\" + keyToOverwrite\n }\n const putPolicy = new qiniu.rs.PutPolicy(options);\n const uploadToken=putPolicy.uploadToken(mac);\n \n\n#### 自定义上传回复的凭证\n\n默认情况下，文件上传到存储之后，在没有设置`returnBody`或者`回调`相关的参数情况下，存储返回给上传端的回复格式为`hash`和`key`，例如：\n\n \n \n {\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"key\":\"qiniu.jpg\"}\n \n\n有时候我们希望能自定义这个返回的 JSON 格式的内容，可以通过设置 `returnBody` 参数来实现，在 `returnBody`\n中，我们可以使用七牛支持的[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)和[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)。\n\n \n \n const options = {\n scope: bucket,\n returnBody: '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\"}'\n }\n const putPolicy = new qiniu.rs.PutPolicy(options);\n const uploadToken=putPolicy.uploadToken(mac);\n \n\n则文件上传到存储之后，收到的回复内容如下：\n\n \n \n {\"key\":\"qiniu.jpg\",\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"bucket\":\"if-bc\",\"fsize\":39335,\"name\":\"qiniu\"}\n \n\n#### 带回调业务服务器的凭证\n\n上面生成的`自定义上传回复`的上传凭证适用于上传端（无论是客户端还是服务端）和存储服务器之间进行直接交互的情况下。在客户端上传的场景之下，有时候客户端需要在文件上传到存储之后，从业务服务器获取相关的信息，这个时候就要用到存储的上传回调及相关回调参数的设置。\n\n \n \n const options = {\n scope: bucket,\n callbackUrl: 'http://api.example.com/qiniu/upload/callback',\n callbackBody: '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\"}',\n callbackBodyType: 'application/json'\n }\n const putPolicy = new qiniu.rs.PutPolicy(options);\n const uploadToken=putPolicy.uploadToken(mac);\n \n\n在使用了上传回调的情况下，客户端收到的回复就是业务服务器响应存储服务的JSON格式内容。 \n通常情况下，我们建议使用 `application/json` 格式来设置\n`callbackBody`，保持数据格式的统一性。实际情况下，`callbackBody` 也支持 `application/x-www-form-\nurlencoded` 格式来组织内容，这个主要看业务服务器在接收到 `callbackBody` 的内容时如何解析。例如：\n\n \n \n const options = {\n scope: bucket,\n callbackUrl: 'http://api.example.com/qiniu/upload/callback',\n callbackBody: 'key=$(key)&hash=$(etag)&bucket=$(bucket)&fsize=$(fsize)&name=$(x:name)'\n }\n const putPolicy = new qiniu.rs.PutPolicy(options);\n const uploadToken=putPolicy.uploadToken(mac);\n \n\n#### 带数据处理的凭证\n\nSDK 支持在文件上传到存储之后，立即对其进行多种指令的数据处理，这个只需要在生成的上传凭证中指定相关的处理参数即可。\n\n \n \n const saveMp4Entry = qiniu.util.urlsafeBase64Encode(bucket + \":avthumb_test_target.mp4\");\n const saveJpgEntry = qiniu.util.urlsafeBase64Encode(bucket + \":vframe_test_target.jpg\");\n //数据处理指令，支持多个指令\n const avthumbMp4Fop = \"avthumb/mp4|saveas/\" + saveMp4Entry;\n const vframeJpgFop = \"vframe/jpg/offset/1|saveas/\" + saveJpgEntry;\n const options = {\n scope: bucket,\n //将多个数据处理指令拼接起来\n persistentOps: avthumbMp4Fop + \";\" + vframeJpgFop,\n //数据处理队列名称，必填\n persistentPipeline: \"video-pipe\",\n //数据处理完成结果通知地址\n persistentNotifyUrl: \"http://api.example.com/qiniu/pfop/notify\",\n }\n const putPolicy = new qiniu.rs.PutPolicy(options);\n const uploadToken=putPolicy.uploadToken(mac);\n \n\n队列 pipeline 请参阅[创建私有队列 __](https://portal.qiniu.com/dora/media-\ngate/pipeline)；转码操作具体参数请参阅[音视频转码](https://developer.qiniu.com/dora/api/audio-\nand-video-transcoding-avthumb)；saveas\n请参阅[处理结果另存](https://developer.qiniu.com/dora/api/processing-results-save-\nsaveas)。\n\n#### 带自定义参数的凭证\n\nSDK支持客户端上传文件的时候定义一些自定义参数，这些参数可以在 `returnBody` 和 `callbackBody`\n里面和存储牛内置支持的魔法变量（即系统变量）通过相同的方式来引用。这些自定义的参数名称必须以 `x:`\n开头。例如客户端上传的时候指定了自定义的参数`x:name`和`x:age`分别是`string`和`int`类型。那么可以通过下面的方式引用：\n\n \n \n const options = {\n //其他上传策略参数...\n returnBody: '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\",\"age\":$(x:age)}'\n }\n \n\n或者\n\n \n \n const options = {\n //其他上传策略参数...\n callbackBody: '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\",\"age\":$(x:age)}',\n }\n \n\n#### 综合上传凭证\n\n上面的生成上传凭证的方法，都是通过设置[上传策略🔗](https://developer.qiniu.com/kodo/manual/1206/put-\npolicy)相关的参数来支持的，这些参数可以通过不同的组合方式来满足不同的业务需求，可以灵活地组织你所需要的上传凭证。\n\n### 服务端直传\n\n服务端直传是指客户利用服务端SDK从服务端直接上传文件到存储，交互的双方一般都在机房里面，所以服务端可以自己生成上传凭证，然后利用SDK中的上传逻辑进行上传，最后从存储服务获取上传的结果，这个过程中由于双方都是业务服务器，所以很少利用到上传回调的功能，而是直接自定义`returnBody`来获取自定义的回复内容。\n\n#### 构建配置类\n\n存储支持空间创建在不同的机房，在使用 Node.js SDK 中的 `FormUploader` 和 `ResumeUploader`\n上传文件之前，必须要构建一个上传用的 `config` 对象，在该对象中，可以使用默认配置，也可以指定空间对应的区域以及其他的一些影响上传的参数。\n\n若不配置区域，将会通过 AK 与 Bucket 查询对应区域。若非必要，建议不配置区域信息。\n\n使用对应区域 ID 可生成对应的 RegionsProvider。区域 ID\n请参考[存储区域文档](https://developer.qiniu.com/kodo/1671/region-endpoint-fq)。\n\n \n \n const config = new qiniu.conf.Config();\n // 空间对应的区域，若不配置将自动查询\n config.regionsProvider = qiniu.httpc.Region.fromRegionId('z0');\n // 是否使用https域名\n // config.useHttpsDomain = true;\n // 上传是否使用cdn加速\n // config.useCdnDomain = true;\n \n\n`config.zone` 已弃用，目前仅兼容支持，若需要配置请尽快更新使用 `config.regionsProvider`。\n\n若同时配置 `config.zone` 与 `config.regionsProvider`，则优先使用 `config.regionsProvider`。\n\n其中关于`Zone`对象和区域的关系如下：\n\n区域 | Zone 对象 \n---|--- \n华东-浙江 | `qiniu.zone.Zone_z0` \n华东-浙江2 | `qiniu.zone.Zone_cn_east_2` \n华北-河北 | `qiniu.zone.Zone_z1` \n华南-广东 | `qiniu.zone.Zone_z2` \n北美-洛杉矶 | `qiniu.zone.Zone_na0` \n亚太-新加坡（原东南亚） | `qiniu.zone.Zone_as0` \n \n#### 文件上传（表单方式）\n\n最简单的就是上传本地文件，直接指定文件的完整路径即可上传。\n\n \n \n const localFile = \"/Users/jemy/Documents/qiniu.mp4\";\n const formUploader = new qiniu.form_up.FormUploader(config);\n const putExtra = new qiniu.form_up.PutExtra();\n const key='test.mp4';\n // 文件上传\n formUploader.putFile(uploadToken, key, localFile, putExtra)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n#### 字节数组上传（表单方式）\n\n可以支持将内存中的字节数组上传到空间中。\n\n \n \n const formUploader = new qiniu.form_up.FormUploader(config);\n const putExtra = new qiniu.form_up.PutExtra();\n const key='test.txt';\n formUploader.put(uploadToken, key, \"hello world\", putExtra)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n#### 数据流上传（表单方式）\n\n这里演示的是`ReadableStream`对象的上传。\n\n \n \n const formUploader = new qiniu.form_up.FormUploader(config);\n const putExtra = new qiniu.form_up.PutExtra();\n const readableStream = xxx; // 可读的流\n formUploader.putStream(uploadToken, key, readableStream, putExtra)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n#### 文件分片上传（断点续传）\n\n可以选择分片上传版本，推荐上传时制定 putExtra.version = ‘v2’，表示 分片上传 v2 版，默认分片上传 v1\n版，兼容历史情况。若需深入了解上传方式之间的区别，请参阅上传类型中\n[表单上传](https://developer.qiniu.com/kodo/manual/1272/form-upload) 、[分片上传 v1\n版](https://developer.qiniu.com/kodo/manual/1650/chunked-upload) 和 [分片上传 v2\n版](https://developer.qiniu.com/kodo/6364/multipartupload-interface) 接口说明。\n\n \n \n const localFile = \"/Users/jemy/Documents/qiniu.mp4\";\n const resumeUploader = new qiniu.resume_up.ResumeUploader(config);\n const putExtra = new qiniu.resume_up.PutExtra();\n // 扩展参数\n putExtra.params = {\n \"x:name\": \"\",\n \"x:age\": 27,\n }\n putExtra.fname = 'testfile.mp4';\n \n // 如果指定了断点记录文件，那么下次会从指定的该文件尝试读取上次上传的进度，以实现断点续传\n putExtra.resumeRecordFile = 'progress.log';\n // 分片上传可指定 version 字段，v2 表示分片上传 v2\n putExtra.version = 'v2'\n // 当使用分片上传 v2 时，默认分片大小为 4MB，也可自定义分片大小，单位为 Bytes。例如设置为 6MB\n // putExtra.partSize = 6 * 1024 * 1024\n const key = null;\n // 文件分片上传\n resumeUploader.putFile(uploadToken, key, localFile, putExtra)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n#### 数据流分片上传（断点续传）\n\n这里演示的是`ReadableStream`对象的上传。\n\n \n \n const resumeUploader = new qiniu.resume_up.ResumeUploader(config);\n const putExtra = new qiniu.resume_up.PutExtra();\n const readableStream = xxx; // 可读的流\n const readableStreamLen = xxx; // 可读流长度\n // 如果指定了断点记录文件，那么下次会从指定的该文件尝试读取上次上传的进度，以实现断点续传\n putExtra.resumeRecordFile = 'progress.log';\n // 分片上传可指定 version 字段，v2 表示分片上传 v2\n putExtra.version = 'v2'\n // 当使用分片上传 v2 时，默认分片大小为 4MB，也可自定义分片大小，单位为 Bytes。例如设置为 6MB\n // putExtra.partSize = 6 * 1024 * 1024\n resumeUploader.putStream(\n uploadToken,\n key,\n readableStream,\n readableStreamLen,\n putExtra,\n )\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n### 解析自定义回复内容\n\n有些情况下，存储返回给上传端的内容不是默认的 `hash` 和 `key` 形式，这种情况下，可能出现在自定义 `returnBody` 或者自定义了\n`callbackBody`\n的情况下，前者一般是服务端直传的场景，而后者则是接受上传回调的场景，这两种场景之下，都涉及到需要将自定义的回复进行内容解析，一般建议在交互过程中，都采用\n`JSON` 的方式，这样处理起来方法比较一致，而且 `JSON` 的方法最通用，在 Node.js 里面处理 `JSON`\n的回复相当地方便，基本上了解回复结构就可以处理，这里不再赘述。\n\n### 业务服务器验证存储服务回调\n\n在上传策略里面设置了上传回调相关参数的时候，存储服务在文件上传到服务器之后，会主动地向`callbackUrl`发送POST请求的回调，回调的内容为`callbackBody`模版所定义的内容，如果这个模版里面引用了[魔法变量](https://developer.qiniu.com/kodo/manual/vars#magicvar)或者[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)，那么这些变量会被自动填充对应的值，然后在发送给业务服务器。\n\n业务服务器在收到来自存储服务的回调请求的时候，可以根据请求头部的`Authorization`字段来进行验证，查看该请求是否是来自存储服务的未经篡改的请求。\n\nNode.js SDK中提供了一个方法`qiniu.util.isQiniuCallback`来校验该头部是否合法：\n\n \n \n // 校验存储服务上传回调的Authorization\n // @param mac AK&SK对象\n // @param requestURI 回调的URL中的requestURI\n // @param reqBody 请求Body，仅当请求的ContentType为\n // application/x-www-form-urlencoded时才需要传入该参数\n // @param callbackAuth 回调时请求的Authorization头部值\n exports.isQiniuCallback = function(mac, requestURI, reqBody, callbackAuth) {\n var auth = exports.generateAccessToken(mac, requestURI, reqBody);\n return auth === callbackAuth;\n }\n \n\n### 上传加速\n\n \n \n const config = new qiniu.conf.Config({\n regionsProvider: new qiniu.httpc.Region({\n services: {\n // 这里填写空间级别传输加速域名\n up: [new qiniu.httpc.Endpoint('<BucketId>.kodo-accelerate.<RegionId>.qiniucs.com', { defaultScheme: 'https' })]\n }\n }),\n });\n \n const localFile = '/Users/jemy/Documents/qiniu.mp4';\n const key = 'test.mp4';\n \n const formUploader = new qiniu.form_up.FormUploader(config);\n formUploader.putFile(uploadToken, key, localFile, new qiniu.form_up.PutExtra())\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n const resumeUploader = new qiniu.resume_up.ResumeUploader(config);\n const putExtra = new qiniu.resume_up.PutExtra();\n putExtra.version = 'v2';\n resumeUploader.putFile(uploadToken, key, localFile, putExtra)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n# 下载文件\n\n * 公开空间\n * 私有空间\n\n文件下载分为公开空间的文件下载和私有空间的文件下载。\n\n### 公开空间\n\n对于公开空间，其访问的链接主要是将空间绑定的域名（可以是空间的默认域名或者是绑定的自定义域名）拼接上空间里面的文件名即可访问，标准情况下需要在拼接链接之前，将文件名进行`urlencode`以兼容不同的字符。\n\n \n \n const mac = new qiniu.auth.digest.Mac(accessKey, secretKey);\n const config = new qiniu.conf.Config();\n const bucketManager = new qiniu.rs.BucketManager(mac, config);\n const publicBucketDomain = 'http://if-pbl.qiniudn.com';\n \n // 公开空间访问链接\n const publicDownloadUrl = bucketManager.publicDownloadUrl(publicBucketDomain, key);\n console.log(publicDownloadUrl);\n \n\n### 私有空间\n\n对于私有空间，首先需要按照公开空间的文件访问方式构建对应的公开空间访问链接，然后再对这个链接进行私有授权签名。\n\n \n \n const mac = new qiniu.auth.digest.Mac(accessKey, secretKey);\n const config = new qiniu.conf.Config();\n const bucketManager = new qiniu.rs.BucketManager(mac, config);\n const privateBucketDomain = 'http://if-pri.qiniudn.com';\n const deadline = parseInt(Date.now() / 1000) + 3600; // 1小时过期\n const privateDownloadUrl = bucketManager.privateDownloadUrl(privateBucketDomain, key, deadline);\n \n\n# 资源管理\n\n资源管理包括的主要功能有：\n\n * 获取文件信息\n * 修改文件 MimeType\n * 修改文件 Headers\n * 修改文件存储类型\n * 移动或重命名文件\n * 复制文件副本\n * 删除空间中的文件\n * 设置或更新文件生存时间\n * 获取指定前缀文件列表\n * 抓取网络资源到空间\n * 更新镜像存储空间中文件内容\n * 资源管理批量操作\n * 批量获取文件信息\n * 批量修改文件类型\n * 批量删除文件\n * 批量复制文件\n * 批量移动或重命名文件\n * 批量更新文件的有效期\n * 批量更新文件存储类型\n\n资源管理相关的操作首先要构建`BucketManager`对象：\n\n \n \n const mac = new qiniu.auth.digest.Mac(accessKey, secretKey);\n const config = new qiniu.conf.Config();\n config.useHttpsDomain = true;\n // config.regionsProvider = qiniu.httpc.Region.fromRegionId('z0');\n const bucketManager = new qiniu.rs.BucketManager(mac, config);\n \n\n## 获取文件信息\n\n \n \n const bucket = \"if-pbl\";\n const key = \"qiniux.mp4\";\n \n bucketManager.stat(bucket, key)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data.hash);\n console.log(data.fsize);\n console.log(data.mimeType);\n console.log(data.putTime);\n console.log(data.type);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 修改文件 MimeType\n\n \n \n const bucket = 'if-pbl';\n const key = 'qiniu.mp4';\n const newMime = 'video/x-mp4';\n \n bucketManager.changeMime(bucket, key, newMime)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 修改文件 Headers\n\n \n \n const bucket = 'if-pbl';\n const key = 'qiniu.mp4';\n const headers = {\n 'Content-Type': 'application/octet-stream',\n 'Last-Modified': 'Web, 21 Oct 2015 07:00:00 GMT',\n 'x-custom-header-xx': 'value',\n };\n \n bucketManager.changeHeaders(bucket, key, headers)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 修改文件存储类型\n\n \n \n const bucket = 'if-pbl';\n const key = 'qiniu.mp4';\n // newType = 0 表示普通存储，\n // 1 表示低频存储\n // 2 表示归档存储\n // 3 表示深度归档存储\n // 4 表示归档直读存储\n const newType = 0;\n \n bucketManager.changeType(bucket, key, newType)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 移动或重命名文件\n\n移动操作本身支持移动文件到相同，不同空间中，在移动的同时也可以支持文件重命名。唯一的限制条件是，移动的源空间和目标空间必须在同一个机房。\n\n源空间 | 目标空间 | 源文件名 | 目标文件名 | 描述 \n---|---|---|---|--- \nBucketA | BucketA | KeyA | KeyB | 相当于同空间文件重命名 \nBucketA | BucketB | KeyA | KeyA | 移动文件到BucketB，文件名一致 \nBucketA | BucketB | KeyA | KeyB | 移动文件到BucketB，文件名变成KeyB \n \n`move`操作支持强制覆盖选项，即如果目标文件已存在，可以设置强制覆盖选项`force`来覆盖那个文件的内容。\n\n \n \n const srcBucket = \"if-pbl\";\n const srcKey = \"qiniu.mp4\";\n const destBucket = \"if-pbl\";\n const destKey = \"qiniu_new.mp4\";\n // 强制覆盖已有同名文件\n const options = {\n force: true\n }\n bucketManager.move(srcBucket, srcKey, destBucket, destKey, options)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 复制文件副本\n\n文件的复制和文件移动其实操作一样，主要的区别是移动后源文件不存在了，而复制的结果是源文件还存在，只是多了一个新的文件副本。\n\n \n \n const srcBucket = \"if-pbl\";\n const srcKey = \"qiniu.mp4\";\n const destBucket = \"if-pbl\";\n const destKey = \"qiniu_new_copy.mp4\";\n // 强制覆盖已有同名文件\n const options = {\n force: true\n }\n \n bucketManager.copy(srcBucket, srcKey, destBucket, destKey, options)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 删除空间中的文件\n\n \n \n const bucket = \"if-pbl\";\n const key = \"qiniu_new_copy.mp4\";\n \n bucketManager.delete(bucket, key)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 设置或更新文件的生存时间\n\n可以给已经存在于空间中的文件设置文件生存时间，或者更新已设置了生存时间但尚未被删除的文件的新的生存时间。\n\n \n \n const bucket = \"if-pbl\";\n const key = \"qiniu_new_copy.mp4\";\n const days = 10;\n \n bucketManager.deleteAfterDays(bucket, key, days)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 获取指定前缀的文件列表\n\n \n \n const bucket = 'if-pbl';\n // @param options 列举操作的可选参数\n // prefix 列举的文件前缀\n // marker 上一次列举返回的位置标记，作为本次列举的起点信息\n // limit 每次返回的最大列举文件数量\n // delimiter 指定目录分隔符\n const options = {\n limit: 10,\n prefix: 'images/',\n };\n \n let nextMarker = '';\n bucketManager.listPrefix(bucket, options)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n //如果这个nextMarker不为空，那么还有未列举完毕的文件列表，下次调用listPrefix的时候，\n //指定options里面的marker为这个值\n const commonPrefixes = data.commonPrefixes;\n nextMarker = data.marker\n console.log(nextMarker);\n console.log(commonPrefixes);\n const items = data.items;\n items.forEach(function(item) {\n console.log(item.key);\n // console.log(item.putTime);\n // console.log(item.hash);\n // console.log(item.fsize);\n // console.log(item.mimeType);\n // console.log(item.endUser);\n // console.log(item.type);\n });\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 抓取网络资源到空间\n\n \n \n const resUrl = 'http://devtools.qiniu.com/qiniu.png';\n const bucket = \"if-bc\";\n const key = \"qiniu.png\";\n \n bucketManager.fetch(resUrl, bucket, key)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(respBody.key);\n console.log(respBody.hash);\n console.log(respBody.fsize);\n console.log(respBody.mimeType);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 更新镜像空间中存储的文件内容\n\n \n \n const bucket = \"if-pbl\";\n const key = \"qiniu.mp4\";\n \n bucketManager.prefetch(bucket, key)\n .then(({ data, resp }) => {\n if (resp.statusCode === 200) {\n console.log(data);\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n## 资源管理批量操作\n\n### 批量获取文件信息\n\n \n \n // 每次调用，operations 的数量不可以超过 1000 个，如果总数量超过 1000，需要分批发送\n const statOperations = [\n qiniu.rs.statOp(srcBucket, 'qiniu1.mp4'),\n qiniu.rs.statOp(srcBucket, 'qiniu2.mp4'),\n qiniu.rs.statOp(srcBucket, 'qiniu3.mp4'),\n qiniu.rs.statOp(srcBucket, 'qiniu4x.mp4'),\n ];\n \n bucketManager.batch(statOperations)\n .then(({ data, resp }) => {\n // 200 is success, 298 is part success\n if (Math.floor(respInfo.statusCode / 100) === 2) {\n respBody.forEach(function(item) {\n console.log(item.data.fsize);\n console.log(item.data.hash);\n console.log(item.data.mimeType);\n console.log(item.data.putTime);\n console.log(item.data.type);\n });\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n### 批量修改文件类型\n\n \n \n // 每次调用，operations 的数量不可以超过 1000 个，如果总数量超过 1000，需要分批发送\n const chgmOperations = [\n qiniu.rs.changeMimeOp(srcBucket, 'qiniu1.mp4', 'video/x-mp4'),\n qiniu.rs.changeMimeOp(srcBucket, 'qiniu2.mp4', 'video/x-mp4'),\n qiniu.rs.changeMimeOp(srcBucket, 'qiniu3.mp4', 'video/x-mp4'),\n qiniu.rs.changeMimeOp(srcBucket, 'qiniu4.mp4', 'video/x-mp4'),\n ];\n \n bucketManager.batch(chgmOperations)\n .then(({ data, resp }) => {\n // 200 is success, 298 is part success\n if (Math.floor(respInfo.statusCode / 100) == 2) {\n respBody.forEach(function(item) {\n if (item.code == 200) {\n console.log(\"success\");\n } else {\n console.log(item.code);\n console.log(item.data.error);\n }\n });\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n### 批量删除文件\n\n \n \n // 每次调用，operations 的数量不可以超过 1000 个，如果总数量超过 1000，需要分批发送\n const deleteOperations = [\n qiniu.rs.deleteOp(srcBucket, 'qiniu1.mp4'),\n qiniu.rs.deleteOp(srcBucket, 'qiniu2.mp4'),\n qiniu.rs.deleteOp(srcBucket, 'qiniu3.mp4'),\n qiniu.rs.deleteOp(srcBucket, 'qiniu4x.mp4'),\n ];\n \n bucketManager.batch(deleteOperations)\n .then(({ data, resp }) => {\n // 200 is success, 298 is part success\n if (Math.floor(respInfo.statusCode / 100) == 2) {\n respBody.forEach(function(item) {\n if (item.code == 200) {\n console.log(\"success\");\n } else {\n console.log(item.code);\n console.log(item.data.error);\n }\n });\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n### 批量复制文件\n\n \n \n const srcBucket = 'if-pbl';\n const srcKey = 'qiniu.mp4';\n const destBucket = srcBucket;\n \n // 每次调用，operations 的数量不可以超过 1000 个，如果总数量超过 1000，需要分批发送\n const copyOperations = [\n qiniu.rs.copyOp(srcBucket, srcKey, destBucket, 'qiniu1.mp4'),\n qiniu.rs.copyOp(srcBucket, srcKey, destBucket, 'qiniu2.mp4'),\n qiniu.rs.copyOp(srcBucket, srcKey, destBucket, 'qiniu3.mp4'),\n qiniu.rs.copyOp(srcBucket, srcKey, destBucket, 'qiniu4.mp4'),\n ];\n \n bucketManager.batch(copyOperations)\n .then(({ data, resp }) => {\n // 200 is success, 298 is part success\n if (Math.floor(respInfo.statusCode / 100) == 2) {\n respBody.forEach(function(item) {\n if (item.code == 200) {\n console.log(\"success\");\n } else {\n console.log(item.code);\n console.log(item.data.error);\n }\n });\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n### 批量移动或重命名文件\n\n \n \n const srcBucket = 'if-pbl';\n const destBucket = srcBucket;\n \n // 每次调用，operations 的数量不可以超过 1000 个，如果总数量超过 1000，需要分批发送\n const moveOperations = [\n qiniu.rs.moveOp(srcBucket, 'qiniu1.mp4', destBucket, 'qiniu1_move.mp4'),\n qiniu.rs.moveOp(srcBucket, 'qiniu2.mp4', destBucket, 'qiniu2_move.mp4'),\n qiniu.rs.moveOp(srcBucket, 'qiniu3.mp4', destBucket, 'qiniu3_move.mp4'),\n qiniu.rs.moveOp(srcBucket, 'qiniu4.mp4', destBucket, 'qiniu4_move.mp4'),\n ];\n \n bucketManager.batch(moveOperations)\n .then(({ data, resp }) => {\n // 200 is success, 298 is part success\n if (Math.floor(respInfo.statusCode / 100) == 2) {\n respBody.forEach(function(item) {\n if (item.code == 200) {\n console.log(\"success\");\n } else {\n console.log(item.code);\n console.log(item.data.error);\n }\n });\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n### 批量更新文件的有效期\n\n \n \n const srcBucket = 'if-pbl';\n \n // 每次调用，operations 的数量不可以超过 1000 个，如果总数量超过 1000，需要分批发送\n const deleteAfterDaysOperations = [\n qiniu.rs.deleteAfterDaysOp(srcBucket, 'qiniu1.mp4', 10),\n qiniu.rs.deleteAfterDaysOp(srcBucket, 'qiniu2.mp4', 10),\n qiniu.rs.deleteAfterDaysOp(srcBucket, 'qiniu3.mp4', 10),\n qiniu.rs.deleteAfterDaysOp(srcBucket, 'qiniu4.mp4', 10),\n ];\n \n bucketManager.batch(deleteAfterDaysOperations)\n .then(({ data, resp }) => {\n // 200 is success, 298 is part success\n if (Math.floor(respInfo.statusCode / 100) == 2) {\n respBody.forEach(function(item) {\n if (item.code == 200) {\n console.log(\"success\");\n } else {\n console.log(item.code);\n console.log(item.data.error);\n }\n });\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n### 批量更新文件存储类型\n\n \n \n const srcBucket = 'if-pbl';\n \n // 每次调用，operations 的数量不可以超过 1000 个，如果总数量超过 1000，需要分批发送\n // newType\n // 0 表示普通存储\n // 1 表示低频存储\n // 2 表示归档存储\n // 3 表示深度归档存储\n // 4 表示归档直读存储\n const newType = 1;\n const changeTypeOperations = [\n qiniu.rs.changeTypeOp(srcBucket, 'qiniu1.mp4', newType),\n qiniu.rs.changeTypeOp(srcBucket, 'qiniu2.mp4', newType),\n qiniu.rs.changeTypeOp(srcBucket, 'qiniu3.mp4', newType),\n qiniu.rs.changeTypeOp(srcBucket, 'qiniu4.mp4', newType),\n ];\n \n bucketManager.batch(changeTypeOperations)\n .then(({ data, resp }) => {\n // 200 is success, 298 is part success\n if (Math.floor(respInfo.statusCode / 100) == 2) {\n respBody.forEach(function(item) {\n if (item.code == 200) {\n console.log(\"success\");\n } else {\n console.log(item.code);\n console.log(item.data.error);\n }\n });\n } else {\n console.log(resp.statusCode);\n console.log(data);\n }\n })\n .catch(err => {\n console.log('failed', err);\n });\n \n\n# 持久化数据处理\n\n## 发送数据处理请求\n\n对于已经保存到七牛空间的文件，可以通过发送持久化的数据处理指令来进行处理，这些指令支持七牛官方提供的指令，也包括客户自己开发的自定义数据处理的指令。数据处理的结果还可以通过七牛主动通知的方式告知业务服务器。\n\n \n \n var mac = new qiniu.auth.digest.Mac(accessKey, secretKey);\n var config = new qiniu.conf.Config();\n //config.useHttpsDomain = true;\n config.zone = qiniu.zone.Zone_z1;\n var operManager = new qiniu.fop.OperationManager(mac, config);\n \n //处理指令集合\n var saveBucket = 'if-bc';\n var fops = [\n 'avthumb/mp4/s/480x320/vb/150k|saveas/' + qiniu.util.urlsafeBase64Encode(saveBucket + \":qiniu_480x320.mp4\"),\n 'vframe/jpg/offset/10|saveas/' + qiniu.util.urlsafeBase64Encode(saveBucket + \":qiniu_frame1.jpg\")\n ];\n var pipeline = 'jemy';\n var srcBucket = 'if-bc';\n var srcKey = 'qiniu.mp4';\n \n var options = {\n 'notifyURL': 'http://api.example.com/pfop/callback',\n 'force': false,\n };\n \n //持久化数据处理返回的是任务的persistentId，可以根据这个id查询处理状态\n operManager.pfop(srcBucket, srcKey, fops, pipeline, options, function(err, respBody, respInfo) {\n if (err) {\n throw err;\n }\n \n if (respInfo.statusCode == 200) {\n console.log(respBody.persistentId);\n } else {\n console.log(respInfo.statusCode);\n console.log(respBody);\n }\n });\n \n\n## 查询数据处理请求状态\n\n由于数据处理是异步处理，可以根据发送处理请求时返回的 `persistentId`\n去查询任务的处理进度，如果在设置了`persistentNotifyUrl`\n的情况下，直接业务服务器等待处理结果通知即可，如果需要主动查询，可以采用如下代码中的：\n\n \n \n var persistentId = 'na0.58df4eee92129336c2075195';\n var config = new qiniu.conf.Config();\n var operManager = new qiniu.fop.OperationManager(null, config);\n //持久化数据处理返回的是任务的persistentId，可以根据这个id查询处理状态\n operManager.prefop(persistentId, function(err, respBody, respInfo) {\n if (err) {\n console.log(err);\n throw err;\n }\n \n if (respInfo.statusCode == 200) {\n console.log(respBody.inputBucket);\n console.log(respBody.inputKey);\n console.log(respBody.pipeline);\n console.log(respBody.reqid);\n respBody.items.forEach(function(item) {\n console.log(item.cmd);\n console.log(item.code);\n console.log(item.desc);\n console.log(item.hash);\n console.log(item.key);\n });\n } else {\n console.log(respInfo.statusCode);\n console.log(respBody);\n }\n });\n \n\n# CDN相关功能\n\n * 文件刷新\n * 目录刷新\n * 文件预取操作\n * 获取域名流量\n * 获取域名带宽\n * 获取日志下载链接\n * 构建时间戳防盗链访问链接\n\n在使用CDN相关功能之前，需要构建`CdnManager`对象：\n\n \n \n var accessKey = 'your access key';\n var secretKey = 'your secret key';\n var mac = new qiniu.auth.digest.Mac(accessKey, secretKey);\n var cdnManager = new qiniu.cdn.CdnManager(mac);\n \n\n## 文件刷新\n\n \n \n //URL 列表\n var urlsToRefresh = [\n 'http://if-pbl.qiniudn.com/nodejs.png',\n 'http://if-pbl.qiniudn.com/qiniu.jpg'\n ];\n \n //刷新链接，单次请求链接不可以超过100个，如果超过，请分批发送请求\n cdnManager.refreshUrls(urlsToRefresh, function(err, respBody, respInfo) {\n if (err) {\n throw err;\n }\n \n console.log(respInfo.statusCode);\n if (respInfo.statusCode == 200) {\n var jsonBody = JSON.parse(respBody);\n console.log(jsonBody.code);\n console.log(jsonBody.error);\n console.log(jsonBody.requestId);\n console.log(jsonBody.invalidUrls);\n console.log(jsonBody.invalidDirs);\n console.log(jsonBody.urlQuotaDay);\n console.log(jsonBody.urlSurplusDay);\n console.log(jsonBody.dirQuotaDay);\n console.log(jsonBody.dirSurplusDay);\n }\n });\n \n\n## 目录刷新\n\n \n \n //DIR 列表\n var dirsToRefresh = [\n 'http://if-pbl.qiniudn.com/examples/',\n 'http://if-pbl.qiniudn.com/images/'\n ];\n \n \n //单次请求链接不可以超过10个，如果超过，请分批发送请求\n qiniu.cdn.refreshDirs(dirsToRefresh, function(err, respBody, respInfo) {\n if (err) {\n throw err;\n }\n \n console.log(respInfo.statusCode);\n if (respInfo.statusCode == 200) {\n var jsonBody = JSON.parse(respBody);\n console.log(jsonBody.code);\n console.log(jsonBody.error);\n console.log(jsonBody.requestId);\n console.log(jsonBody.invalidUrls);\n console.log(jsonBody.invalidDirs);\n console.log(jsonBody.urlQuotaDay);\n console.log(jsonBody.urlSurplusDay);\n console.log(jsonBody.dirQuotaDay);\n console.log(jsonBody.dirSurplusDay);\n }\n });\n \n\n## 文件预取\n\n \n \n //URL 列表\n var urlsToPrefetch = [\n 'http://if-pbl.qiniudn.com/nodejs.png',\n 'http://if-pbl.qiniudn.com/qiniu.jpg'\n ];\n \n //预取链接，单次请求链接不可以超过100个，如果超过，请分批发送请求\n cdnManager.prefetchUrls(urlsToPrefetch, function(err, respBody, respInfo) {\n if (err) {\n throw err;\n }\n \n console.log(respInfo.statusCode);\n if (respInfo.statusCode == 200) {\n var jsonBody = JSON.parse(respBody);\n console.log(jsonBody.code);\n console.log(jsonBody.error);\n console.log(jsonBody.requestId);\n console.log(jsonBody.invalidUrls);\n console.log(jsonBody.invalidDirs);\n console.log(jsonBody.urlQuotaDay);\n console.log(jsonBody.urlSurplusDay);\n console.log(jsonBody.dirQuotaDay);\n console.log(jsonBody.dirSurplusDay);\n }\n });\n \n\n## 获取域名流量\n\n \n \n //域名列表\n var domains = [\n 'if-pbl.qiniudn.com',\n 'qdisk.qiniudn.com'\n ];\n \n //指定日期\n var startDate = '2017-06-20';\n var endDate = '2017-06-22';\n var granularity = 'day';\n \n //获取域名流量\n cdnManager.getFluxData(startDate, endDate, granularity, domains, function(err,\n respBody, respInfo) {\n if (err) {\n throw err;\n }\n \n console.log(respInfo.statusCode);\n if (respInfo.statusCode == 200) {\n var jsonBody = JSON.parse(respBody);\n var code = jsonBody.code;\n console.log(code);\n \n var tickTime = jsonBody.time;\n console.log(tickTime);\n \n var fluxData = jsonBody.data;\n domains.forEach(function(domain) {\n var fluxDataOfDomain = fluxData[domain];\n if (fluxDataOfDomain != null) {\n console.log(\"flux data for:\" + domain);\n var fluxChina = fluxDataOfDomain[\"china\"];\n var fluxOversea = fluxDataOfDomain[\"oversea\"];\n console.log(fluxChina);\n console.log(fluxOversea);\n } else {\n console.log(\"no flux data for:\" + domain);\n }\n console.log(\"----------\");\n });\n }\n });\n \n\n## 获取域名带宽\n\n \n \n //域名列表\n var domains = [\n 'if-pbl.qiniudn.com',\n 'qdisk.qiniudn.com'\n ];\n \n //指定日期\n var startDate = '2017-06-20';\n var endDate = '2017-06-22';\n var granularity = 'day';\n \n //获取域名带宽\n cdnManager.getBandwidthData(startDate, endDate, granularity, domains, function(\n err, respBody, respInfo) {\n if (err) {\n console.log(err);\n throw err;\n }\n \n console.log(respInfo.statusCode);\n if (respInfo.statusCode == 200) {\n var jsonBody = JSON.parse(respBody);\n var code = jsonBody.code;\n console.log(code);\n \n var tickTime = jsonBody.time;\n console.log(tickTime);\n \n var bandwidthData = jsonBody.data;\n domains.forEach(function(domain) {\n var bandwidthDataOfDomain = bandwidthData[domain];\n if (bandwidthDataOfDomain != null) {\n console.log(\"bandwidth data for:\" + domain);\n var bandwidthChina = bandwidthDataOfDomain[\"china\"];\n var bandwidthOversea = bandwidthDataOfDomain[\"oversea\"];\n console.log(bandwidthChina);\n console.log(bandwidthOversea);\n } else {\n console.log(\"no bandwidth data for:\" + domain);\n }\n console.log(\"----------\");\n });\n }\n });\n \n\n## 获取日志下载链接\n\n \n \n //域名列表\n var domains = [\n 'if-pbl.qiniudn.com',\n 'qdisk.qiniudn.com'\n ];\n \n //指定日期\n var logDay = '2017-06-20';\n \n //获取域名日志\n cdnManager.getCdnLogList(domains, logDay, function(err, respBody, respInfo) {\n if (err) {\n throw err;\n }\n \n console.log(respInfo.statusCode);\n if (respInfo.statusCode == 200) {\n var jsonBody = JSON.parse(respBody);\n var code = jsonBody.code;\n console.log(code);\n var logData = jsonBody.data;\n domains.forEach(function(domain) {\n console.log(\"log for domain: \" + domain);\n var domainLogs = logData[domain];\n if (domainLogs != null) {\n domainLogs.forEach(function(logItem) {\n console.log(logItem.name);\n console.log(logItem.size);\n console.log(logItem.mtime);\n console.log(logItem.url);\n });\n console.log(\"------------------\");\n }\n });\n }\n });\n \n\n## 构建时间戳防盗链访问链接\n\n具体算法可以参考：[时间戳防盗链](https://developer.qiniu.com/fusion/kb/timestamp-hotlinking-\nprevention)\n\n \n \n var domain = 'http://sg.xiaohongshu.com';\n var fileName = 'github.png';\n //加密密钥\n var encryptKey = 'xxx';\n var query = {\n 'name': 'qiniu',\n 'location': 'shanghai'\n };\n var deadline = parseInt(Date.now() / 1000) + 3600;\n var cdnManager = new qiniu.cdn.CdnManager(null);\n var finalUrl = cdnManager.createTimestampAntiLeechUrl(domain, fileName, query, encryptKey, deadline);\n console.log(finalUrl);\n \n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n * [融合CDN API 参考](https://developer.qiniu.com/fusion)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n\n# 常见问题\n\n * Node.js SDK的callback保留了请求的错误信息，回复信息和头部信息，遇到问题时，可以都打印出来提交给我们排查问题。\n * API 的使用，可以参考我们为大家精心准备的[使用实例 __](https://github.com/qiniu/nodejs-sdk/tree/master/examples)。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](https://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](https://support.qiniu.com/tickets/new)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Node.js SDK V6"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [Node.js\nSDK](https://developer.qiniu.com/kodo/sdk/1289/nodejs) > Node.js SDK V6\n\n# Node.js SDK V6\n\n最近更新时间: 2023-04-04 11:44:00\n\n该 SDK 适用于 Node.js 0.4.7 及其以上版本，若您的服务端是一个基于 Node.js 编写的网络程序，使用此 SDK\n，可以安全地将您的数据存储到七牛云上。 \n方便让您应用的终端用户进行高速上传和下载，同时也使您的服务端更加轻盈。\n\n * [Node.js SDK 下载地址 __](https://github.com/qiniu/nodejs-sdk/releases)\n * [Node.js SDK 源码地址 __](https://github.com/qiniu/nodejs-sdk)\n\nNode.js SDK 主要包含对七牛云API的包装，遵循[qiniu sdkspec\n__](https://github.com/qiniu/sdkspec) \n涉及到以下几个方面：\n\n * 服务端操作，生成上传授权(uptoken)，私有bucket下载URL(downloadUrl)，文件操作授权\n * 客户端操作，上传文件(qiniu/io.js)\n * 文件管理(qiniu/rs.js)\n * 数据处理(qiniu/fop.js)\n * 公共库(qiniu/rpc.js, qiniu/util.js)\n\n# 安装\n\n通过 npm 以 node 模块化的方式安装：\n\n \n \n npm install qiniu\n \n\n**初始化**\n\n在使用SDK 前，您需要一对有效的 AccessKey 和 SecretKey 签名授权。\n\n可以通过如下步骤获得：\n\n 1. 开通[七牛开发者帐号 __](https://portal.qiniu.com/signup)\n 2. 登录七牛开发者平台，查看 [Access Key 和 Secret Key __](https://portal.qiniu.com/user/key)\n\n对于服务端而言，常规程序流程是：\n\n \n \n qiniu.conf.ACCESS_KEY = '<Your Access Key>'\n qiniu.conf.SECRET_KEY = '<Your Secret Key>'\n \n\n服务端操作时请务必初始化这两个变量\n\n# 文件上传\n\n## 上传流程\n\n为了尽可能地改善终端用户的上传体验，七牛云存储首创了客户端直传功能。更多信息请参阅[业务流程\n__](https://developer.qiniu.com/kodo/manual/1205/programming-model#2)。\n\n上传代码：\n\n \n \n var qiniu = require(\"qiniu\");\n \n //需要填写你的 Access Key 和 Secret Key\n qiniu.conf.ACCESS_KEY = 'Access_Key';\n qiniu.conf.SECRET_KEY = 'Secret_Key';\n \n //要上传的空间\n bucket = 'Bucket_Name';\n \n //上传到七牛后保存的文件名\n key = 'my-nodejs-logo.png';\n \n //构建上传策略函数\n function uptoken(bucket, key) {\n var putPolicy = new qiniu.rs.PutPolicy(bucket+\":\"+key);\n return putPolicy.token();\n }\n \n //生成上传 Token\n token = uptoken(bucket, key);\n \n //要上传文件的本地路径\n filePath = './ruby-logo.png'\n \n //构造上传函数\n function uploadFile(uptoken, key, localFile) {\n var extra = new qiniu.io.PutExtra();\n qiniu.io.putFile(uptoken, key, localFile, extra, function(err, ret) {\n if(!err) {\n // 上传成功， 处理返回值\n console.log(ret.hash, ret.key, ret.persistentId); \n } else {\n // 上传失败， 处理返回代码\n console.log(err);\n }\n });\n }\n \n //调用uploadFile上传\n uploadFile(token, key, filePath);\n \n\n## 上传&回调\n\n \n \n var qiniu = require(\"qiniu\");\n \n //需要填写你的 Access Key 和 Secret Key\n qiniu.conf.ACCESS_KEY = 'Access_Key';\n qiniu.conf.SECRET_KEY = 'Secret_Key';\n \n //要上传的空间\n bucket = 'Bucket_Name';\n \n //上传到七牛后保存的文件名\n key = 'my-nodejs-logo.png';\n \n //构建上传策略函数，设置回调的url以及需要回调给业务服务器的数据\n function uptoken(bucket, key) {\n var putPolicy = new qiniu.rs.PutPolicy(bucket+\":\"+key);\n putPolicy.callbackUrl = 'http://your.domain.com/callback';\n putPolicy.callbackBody = 'filename=$(fname)&filesize=$(fsize)';\n return putPolicy.token();\n }\n \n //生成上传 Token\n token = uptoken(bucket, key);\n \n //要上传文件的本地路径\n filePath = './nodejs-logo.png'\n \n //构造上传函数\n function uploadFile(uptoken, key, localFile) {\n var extra = new qiniu.io.PutExtra();\n qiniu.io.putFile(uptoken, key, localFile, extra, function(err, ret) {\n if(!err) {\n // 上传成功， 处理返回值\n console.log(ret.hash, ret.key, ret.persistentId); \n } else {\n // 上传失败， 处理返回代码\n console.log(err);\n }\n });\n }\n \n //调用uploadFile上传\n uploadFile(token, key, filePath);\n \n\n## 上传&预转持续化\n\n以视频转码为例：\n\n \n \n var qiniu = require(\"qiniu\");\n \n //需要填写你的 Access Key 和 Secret Key\n qiniu.conf.ACCESS_KEY = 'Access_Key';\n qiniu.conf.SECRET_KEY = 'Secret_Key';\n \n //要上传的空间\n bucket = 'Bucket_Name';\n \n //上传到七牛后保存的文件名\n key = 'my-nodejs.mp4';\n \n //转码是使用的队列名称。 \n pipeline = 'abc' #设定自己账号下的pipleline\n \n //要进行转码的转码操作。 \n fops = \"avthumb/mp4/s/640x360/vb/1.25m\"\n \n //可以对转码后的文件进行使用saveas参数自定义命名，当然也可以不指定文件会默认命名并保存在当间。\n saveas_key = qiniu.util.urlsafeBase64Encode(目标Bucket_Name:自定义文件key); \n fops = fops+'|saveas/'+saveas_key;;\n \n //上传策略中设置pipeline以及fops\n function uptoken(bucket, key) {\n var putPolicy = new qiniu.rs.PutPolicy(bucket+\":\"+key);\n putPolicy.persistentOps = fops;\n putPolicy.persistentPipeline = pipleline;\n return putPolicy.token();\n }\n \n //生成上传 Token\n token = uptoken(bucket, key);\n \n //要上传文件的本地路径\n filePath = './nodejs.mp4'\n \n //构造上传函数\n function uploadFile(uptoken, key, localFile) {\n var extra = new qiniu.io.PutExtra();\n qiniu.io.putFile(uptoken, key, localFile, extra, function(err, ret) {\n if(!err) {\n // 上传成功， 处理返回值\n console.log(ret.hash, ret.key, ret.persistentId); \n } else {\n // 上传失败， 处理返回代码\n console.log(err);\n }\n });\n }\n \n //调用uploadFile上传\n uploadFile(token, key, filePath);\n \n\n队列 pipeline 请参阅[创建私有队列 __](https://portal.qiniu.com/dora/media-\ngate/pipeline)；转码操作具体参数请参阅[音视频转码](https://developer.qiniu.com/dora/api/audio-\nand-video-transcoding-avthumb)；saveas\n请参阅[处理结果另存](https://developer.qiniu.com/dora/api/processing-results-save-\nsaveas)。\n\n**Tips：**上面的 Demo 只是针对视频转码功能，如果您需要使用比如音视频切片、视频截图、视频拼接等功能只需要修改上面 fops\n后面的参数即可，如： _$fops = vframe/jpg/offset/1/w/480/h/360/rotate/90_ 就表示视频截图了。\n\n可以看到上传成功后的行为主要是由[上传凭证](https://developer.qiniu.com/kodo/manual/upload-\ntoken)中的上传策略来指定。其中上传策略可以指定的行为不止这些，具体请参阅[上传策略](https://developer.qiniu.com/kodo/manual/put-\npolicy)。\n\n# 文件下载\n\n生成下载链接：\n\n \n \n var qiniu = require(\"qiniu\");\n \n qiniu.conf.ACCESS_KEY = 'Access_Key';\n qiniu.conf.SECRET_KEY = 'Secret_Key';\n \n //构建私有空间的链接\n url = 'http://domain/key';\n var policy = new qiniu.rs.GetPolicy();\n \n //生成下载链接url\n var downloadUrl = policy.makeRequest(url);\n \n //打印下载的url\n console.log(downloadUrl);\n \n\n# 空间资源管理\n\n## 获取文件信息\n\n \n \n var qiniu = require(\"qiniu\");\n \n qiniu.conf.ACCESS_KEY = 'Access_Key';\n qiniu.conf.SECRET_KEY = 'Secret_Key';\n \n //构建bucketmanager对象\n var client = new qiniu.rs.Client();\n \n //你要测试的空间， 并且这个key在你空间中存在\n bucket = 'Bucket_Name';\n key = 'nodejs-logo.png';\n \n //获取文件信息\n client.stat(bucket, key, function(err, ret) {\n if (!err) {\n console.log(ret.hash, ret.fsize, ret.putTime, ret.mimeType);\n } else {\n console.log(err);\n }\n });\n \n\n## 移动单个文件\n\n \n \n var qiniu = require(\"qiniu\");\n \n qiniu.conf.ACCESS_KEY = 'Access_Key';\n qiniu.conf.SECRET_KEY = 'Secret_Key';\n \n //构建bucketmanager对象\n var client = new qiniu.rs.Client();\n \n //你要测试的空间， 并且这个key在你空间中存在\n bucket = 'Bucket_Name';\n key = 'nodejs-logo.png';\n \n //移动到的目标空间名和重命名的key\n dstbucket = 'dst_bucket'\n dstkey = 'dst_key'\n \n //移动资源\n client.move(bucket, key, dstbucket, deskey, function(err, ret) {\n if (!err) {\n // ok\n } else {\n console.log(err);\n }\n });\n \n\n## 复制单个文件\n\n \n \n var qiniu = require(\"qiniu\");\n \n qiniu.conf.ACCESS_KEY = 'Access_Key';\n qiniu.conf.SECRET_KEY = 'Secret_Key';\n \n //构建bucketmanager对象\n var client = new qiniu.rs.Client();\n \n //你要测试的空间， 并且这个key在你空间中存在\n bucket = 'Bucket_Name';\n key = 'nodejs-logo.png';\n \n //复制到的目标空间名和重命名的key\n dstbucket = 'dst_bucket'\n dstkey = 'dst_key'\n \n //复制资源\n client.copy(bucket, key, dstbucket, deskey, function(err, ret) {\n if (!err) {\n // ok\n } else {\n console.log(err);\n }\n });\n \n\n## 删除单个文件\n\n \n \n var qiniu = require(\"qiniu\");\n \n qiniu.conf.ACCESS_KEY = 'Access_Key';\n qiniu.conf.SECRET_KEY = 'Secret_Key';\n \n //构建bucketmanager对象\n var client = new qiniu.rs.Client();\n \n //你要测试的空间， 并且这个key在你空间中存在\n bucket = 'Bucket_Name';\n key = 'nodejs-logo.png';\n \n //删除资源\n client.remove(bucket, key, function(err, ret) {\n if (!err) {\n // ok\n } else {\n console.log(err);\n }\n });\n \n\n# 触发持久化操作\n\n以视频转码为例：\n\n \n \n var qiniu = require(\"qiniu\");\n \n //\n qiniu.conf.ACCESS_KEY = 'Access_Key';\n qiniu.conf.SECRET_KEY = 'Secret_Key';\n \n //要转码的文件所在的空间和文件名\n bucket = 'Bucket_Name';\n key = '1.mp4';\n \n //转码所使用的队列名称。 \n pipeline = 'abc';\n \n //要进行转码的转码操作。 \n fops = \"avthumb/mp4/s/640x360/vb/1.25m\"\n \n //可以对转码后的文件进行使用saveas参数自定义命名，当然也可以不指定文件会默认命名并保存在当前空间\n saveas_key = qiniu.util.urlsafeBase64Encode(saved_bucket+':'+saved_key);\n fops = fops+'|saveas/'+saveas_key;\n \n opts = {\n pipeline: pipleline\n };\n \n var PFOP = qiniu.fop.pfop(bucket, key, fops, opts, function(err, ret) {\n if(!err) {\n // 上传成功， 处理返回值\n console.log('curl '+'http://api.qiniu.com/status/get/prefop?id='+ret.persistentId); \n } else {\n // 上传失败， 处理返回代码\n console.log(err);\n }\n });\n \n\n**Tips：**上面的Demo只是针对视频转码功能，如果您需要使用比如音视频切片、视频截图、视频拼接等功能只需要修改上面 fops 后面的参数即可，如：\n_fops = vframe/jpg/offset/1/w/480/h/360/rotate/90_ 就表示视频截图了。\n\n但这个只是将转码这个耗时的操作提交到队列中，要想知道转码操作现在的状态， 需要根据返回的 **persitentId**\n进行查询。如果您不方便持续轮询每个异步处理的进度和状态，七牛可以异步处理完成后通知您们的业务服务器。这样就需要您在视频转码的例子中, 初始化\n**PersistentFop** 时添加上 **notifyUrl** , 来通知您们的业务服务器。\n\n# API参考手册\n\n * [对象存储API参考手册](https://developer.qiniu.com/kodo/api/1731/api-overview)\n * [数据处理API参考手册](https://developer.qiniu.com/dora)\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎到我们的技术论坛参与讨论。\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](https://support.qiniu.com/tickets/new)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Objective-C SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > Objective-C SDK\n\n# Objective-C SDK\n\n最近更新时间: 2024-08-05 18:23:52\n\nObjective-C SDK 为客户端 SDK，没有包含 token 生成实现，为了安全，token 都建议通过网络从服务端获取\n具体生成代码可以参考七牛服务端官方 SDK 。支持 Mac 和 iOS，会根据文件大小自动选择表单上传还是断点续上传。\n\n * [Objective-C SDK 下载地址 __](https://github.com/qiniu/objc-sdk/releases)\n * [Objective-C SDK 源码地址 __](https://github.com/qiniu/objc-sdk)\n * [Objective-C SDK 单元测试 __](https://github.com/qiniu/objc-sdk/tree/master/QiniuSDKTests)\n\n**版本**\n\nQiniu SDK 版本 | 最低 iOS 版本 | 最低 OS X 版本 | Notes \n---|---|---|--- \n[ 8.8.x __](https://github.com/qiniu/objc-sdk/tree/v8.5.0)| iOS 9 | OS X 10.15 | Xcode 最低版本 11. \n[ 8.7.x __](https://github.com/qiniu/objc-sdk/tree/v8.5.0)| iOS 9 | OS X 10.15 | Xcode 最低版本 11. \n[ 8.6.x __](https://github.com/qiniu/objc-sdk/tree/v8.5.0)| iOS 9 | OS X 10.15 | Xcode 最低版本 11. \n[ 8.5.x __](https://github.com/qiniu/objc-sdk/tree/v8.5.0)| iOS 7 | OS X 10.15 | Xcode 最低版本 11. \n[ 8.4.x __](https://github.com/qiniu/objc-sdk/tree/v8.4.0)| iOS 7 | OS X 10.15 | Xcode 最低版本 11. \n[ 8.3.x __](https://github.com/qiniu/objc-sdk/tree/v8.3.0)| iOS 7 | OS X 10.15 | Xcode 最低版本 11. \n[ 8.2.x __](https://github.com/qiniu/objc-sdk/tree/v8.2.0)| iOS 7 | OS X 10.15 | Xcode 最低版本 11. \n[ 8.1.x __](https://github.com/qiniu/objc-sdk/tree/v8.1.0)| iOS 7 | OS X 10.15 | Xcode 最低版本 11. \n[ 8.0.x __](https://github.com/qiniu/objc-sdk/tree/v8.0.0)| iOS 7 | OS X 10.15 | Xcode 最低版本 11. \n[ 7.4.x __](https://github.com/qiniu/objc-sdk/tree/v7.4.0)| iOS 7 | OS X 10.9 | Xcode 最低版本 6. \n[ 7.3.x __](https://github.com/qiniu/objc-sdk/tree/v7.3.0)| iOS 7 | OS X 10.9 | Xcode 最低版本 6. \n[ 7.2.x __](https://github.com/qiniu/objc-sdk/tree/v7.2.0)| iOS 7 | OS X 10.9 | Xcode 最低版本 6. \n[7.1.x / AFNetworking-3.x __](https://github.com/qiniu/objc-sdk/tree/AFNetworking-3.x)| iOS 7 | OS X 10.9 | Xcode 最低版本 6. \n[7.0.x / AFNetworking-2.x __](https://github.com/qiniu/objc-sdk/tree/7.0.x/AFNetworking-2.x)| iOS 6 | OS X 10.8 | Xcode 最低版本 5. \n[7.x / AFNetworking-1.x __](https://github.com/qiniu/objc-sdk/tree/AFNetworking-1.x)| iOS 5 | OS X 10.7 | Xcode 最低版本 5. \n[6.x __](https://github.com/qiniu/ios-sdk)| iOS 6 | None | Xcode 最低版本 5. \n \n# 1 安装\n\n## 1.1 使用 Cocoapods 进行安装\n\n \n \n pod \"Qiniu\", \"~> 8.8.0\"\n \n\n## 1.2 通过 Swift Package Manager\n\n \n \n App 对接:\n File -> Swift Packages -> Add Package Dependency，输入库链接，选择相应版本即可。\n 库链接: https://github.com/qiniu/objc-sdk\n \n 库对接:\n let package = Package(\n dependencies: [\n .package(url: \"https://github.com/qiniu/objc-sdk\", from: \"8.8.0\")\n ],\n // ...\n )\n \n 库引入方式：\n import QiniuSDK\n \n\n# 2 推荐的使用姿势\n\niOS SDK 作为移动端的 SDK，在使用时会被嵌入到移动端的应用中，为了保证信息的安全以及业务的灵活性，我们给出以下几点建议：\n\n### 2.1 AccessKey 和 SecretKey 下发\n\n账户以及 iam 子账户的密钥对 AccessKey 和 SecretKey\n不要固化在客户端中，其涉及相关参数通过用户自己的业务服务端来生成并下发（比如上传的 Token）。业务服务端集中管理 AccessKey 和\nSecretKey ，避免泄漏；其次 AccessKey 、SecretKey 和客户端应用需解耦，其因泄露更换时不会产生不必要麻烦。\n\n### 2.2 上传域名下发，并可以下发多个域名\n\nSDK 上传过程：\n\n 1. 获取七牛 Bucket 的上传域名； \n * 指定域名。通过指定区域 id 或直接给上传域名列表方式指定域名，详情见 域名配置 QNFixedZone；\n * SDK 自动查询域名。SDK 内部自动调用七牛服务端接口，查询 Bucket 的上传域名，详情见 域名配置 QNAutoZone；\n 2. 使用上传域名进行上传，上传过程会伴随主备重试，既多个域名时，一个域名上传失败，会尝试使用其他域名进行上传。\n\n**建议的上传域名下发方式**\n\n用户服务在下发上传 Token 时同时下发上传域名（可以在 App 需要进行上传时，先请求获取获取上传 Token 及上传域名），可下发多个域名，App\n在拿到 Token 和上传域名后，配置上传 Config 以及 QNUploadManager，进而进行上传操作。\n\n具体代码示例如下：\n\n \n \n // Upload_Domain1, Upload_Domain2 为服务下发的上传域名\n QNFixedZone *fixedZone = [[QNFixedZone alloc] initWithUpDomainList:@[@\"Upload_Domain1\", @\"Upload_Domain2\"]];\n QNConfiguration *config = [QNConfiguration build:^(QNConfigurationBuilder *builder) {\n builder.zone = fixedZone;\n }];\n QNUploadManager *manager = [[QNUploadManager alloc] initWithConfiguration:config];\n \n\n**域名下发的优点：**\n\n 1. 跳过域名查询过程，上传更高效。\n 2. 避免在 App 硬编码上传域名，导致使用不灵活，比如： \n * 在客户更换/增加区域时，由于 App 硬编码了区域，已发布的 App 无法处理此问题。\n * 某些客户生产环境使用的 Bucket 和 测试环境使用的 Bucket 不在同一个区域，在实际上线时错用了测试 Bucket 的区域，导致 Bucket 和区域不匹配，App 相关功能不可用。\n * 自定义域名，由于硬编码，老版本 App 也无法灵活应对。\n\n除了上面的问题，还有很多情景不再列举，上面问题的根本原因是由于 App 硬编码了区域的上传域名导致 App\n不能灵活应对上传域名需要修改的场景，所以建议客户通过服务下发上传的方式来配置 SDK 的上传域名, 而不是直接硬编码上传域名。\n\n# 3 域名配置\n\n域名配置分为 QNFixZone 和 QNAutoZone 两种方式。\n\n## 3.1 QNFixZone\n\n在 QNFixZone 中，上传域名被固定，且不可更改。有两种配置方式：\n\n### 3.1.1 通过指定上传区域 ID 方式\n\n区域 ID 和区域域名对应关系参考 [这里 __](https://developer.qiniu.com/kodo/1671/region-\nendpoint-fq)\n\n \n \n // 指定上传区域为 华东-浙江\n QNFixedZone *zone = [QNFixedZone createWithRegionId:@\"z0\"];\n \n\n这种方式硬编码了上传域名的区域，且不可更改，所以不建议在生产环境中使用，仅供测试使用。\n\n### 3.1.2 直接配置上传域名\n\n直接配置上传域名的方式可以灵活配置域名，我们不建议上传域名配置为固定域名，而是通过服务下发的方式进行配置。具体上传域名下发请参考**上传域名下发** 介绍。\n\n \n \n // Upload_Domain1, Upload_Domain2 为服务下发的上传域名\n QNFixedZone *fixedZone = [[QNFixedZone alloc] initWithUpDomainList:@[@\"Upload_Domain1\", @\"Upload_Domain2\"]];\n \n\n## 3.2 QNAutoZone\n\n如果用户不想关心上传域名相关的逻辑，而且没有任何自定义的需求，完全依赖七牛的上传域名，则可以使用 AutoZone。AutoZone 相对于 FixZone\n来说，在第一次上传时查询上传域名，后续会使用缓存的上传域名进行上传。在缓存有效期内不会更换上传域名，当前域名缓存有效期为 24 小时。 \n示例代码：\n\n \n \n // 不指定 uc 域名，使用七牛公有云默认域名\n QNAutoZone *zone = [[QNAutoZone alloc] init];\n \n // 指定 uc 域名，公有云无需指定\n QNAutoZone *zone = [QNAutoZone zoneWithUcHosts:@[@\"UCHost0\", @\"UCHost1\"]];\n \n\n不过我们推荐用户使用**上传域名下发** 的方式来配置上传域名，防止后续业务变更需要。\n\n# 4 上传\n\n## 4.1 上传示例\n\nSDK 内置两种上传方式：表单上传和分片上传，并根据具体情况，内部做了自动切换。表单上传使用一个 HTTP POST\n请求完成文件的上传，因此比较适合较小的文件和较好的网络环境。相比而言，分片上传更能适应不稳定的网络环境，也比较适合上传比较大的文件（例如数百 MB\n或更大）。\n\n若需深入了解上传方式之间的区别，请参阅上传类型中\n[表单上传](https://developer.qiniu.com/kodo/manual/1272/form-upload) 、[分片上传 v1\n版](https://developer.qiniu.com/kodo/manual/1650/chunked-upload) 和 [分片上传 v2\n版](https://developer.qiniu.com/kodo/6364/multipartupload-interface) 接口说明。\n\nQNUploadManager 上传接口参数说明：\n\n参数 | 类型 | 说明 \n---|---|--- \ndata | NSData */NSString */PHAsset */PHAssetResource * | 数据，可以是 NSData、文件路径、资源、数据流 \nkey | NSString * | 保存在服务器上的资源唯一标识，请参阅 [键值对](https://developer.qiniu.com/kodo/manual/1277/product-introduction#key-value) \ntoken | NSString * | 服务器分配的 token \ncompletionHandler | QNUpCompletionHandler | 上传回调函数，必填 \noption | QNUploadOption | 如果需要进度通知、中途取消、指定 mimeType，则需要填写相应字段，详见下面的 QNUploadOption 参数说明 \n \nQNUploadOption 参数说明：\n\n参数 | 类型 | 说明 \n---|---|--- \nparams | NSDictionary<NSString *, NSString *> * | 自定义变量，key 必须以 x: 开始 \nmetaDataParam | NSDictionary<NSString *, NSString *> * | 自定义meta数据，key 必须以 x-qn-meta- 开始 \nmimeType | NSString | 指定文件的 mimeType \nprogressHandler | QNUpProgressHandler | 上传进度回调 \n \n \n #import <QiniuSDK.h>\n \n QNConfiguration *configuration = [QNConfiguration build:^(QNConfigurationBuilder *builder) {\n // 配置上传区域，Host0、Host1 建议通过服务方式下发\n builder.zone = [[QNFixedZone alloc] initWithUpDomainList:@[@\"Host0\", @\"Host2\"]];\n // 分片上传阈值：4MB，大于 4MB 采用分片上传，小于 4MB 采用表单上传\n builder.putThreshold = 4*1024*1024;\n // 开启并发分片上传\n builder.useConcurrentResumeUpload = true;\n // 使用分片 V2\n builder.resumeUploadVersion = QNResumeUploadVersionV2;\n // 文件分片上传时断点续传信息保存，表单上传此配置无效\n NSString *recorderPath = [NSHomeDirectory() stringByAppendingPathComponent:@\"Documents\"];\n builder.recorder = [QNFileRecorder fileRecorderWithFolder:recorderPath error:nil];\n }];\n QNUploadManager *upManager = [[QNUploadManager alloc] initWithConfiguration:configuration];\n \n __weak typeof(self) weakSelf = self;\n QNUploadOption *uploadOption = [[QNUploadOption alloc] initWithMime:nil progressHandler:^(NSString *key, float percent) {\n NSLog(@\"percent == %.2f\", percent);\n }\n params:nil\n checkCrc:NO\n cancellationSignal:^BOOL{\n // 当需要取消时，此处返回 true，SDK 内部会多次检查返回值，当返回值为 true 时会取消上传操作\n return false;\n }];\n \n NSString *filePath = @\"\"; // 文件路径\n NSString *key = @\"\"; // 文件 key\n NSString *uploadToken = @\"\"; // 上传的 Token\n [upManager putFile:filePath key:key token:uploadToken complete:^(QNResponseInfo *info, NSString *key, NSDictionary *resp) {\n if (info.isOK) {\n // 上传成功\n } else {\n // 上传失败\n }\n } option:uploadOption];\n \n\n## 4.2 上传配置介绍\n\n### 4.2.1 开启传输加速\n\n默认情况下，SDK 未开启使用加速域名上传的功能，如需开启需按下面方式进行配置：\n\n \n \n // 1. 在七牛云存储控制台修改 Bucket 配置，域名管理 -> 开启传输加速（SDK 开启使用加速域名上传的功能仅仅是 SDK 支持\n // 使用加速域名，所以要想使用传输加速，七牛云服务端需开启此功能）\n // \n // 2. SDK 配置 \n // 方式一：使用 QNFixZone 配置\n QNConfiguration *config = [QNConfiguration build:^(QNConfigurationBuilder *builder) {\n // Upload_Domain1 和 Upload_Domain2 为加速域名，可以参考七牛云存储控制台域名管理页面，建议通过用户服务下发，不要硬编码\n builder.zone = [[QNFixedZone alloc] initWithUpDomainList:@[@\"Upload_Domain1\", @\"Upload_Domain2\"]];\n }];\n \n // 方式二：使用 AutoZone（v8.8.0 开始支持）\n QNConfiguration *config = [QNConfiguration build:^(QNConfigurationBuilder *builder) {\n builder.accelerateUploading = YES; // 开启传输加速，此参数仅对使用 QNAutoZone 时有效\n builder.zone = [[QNAutoZone alloc] init]; // 默认是 AutoZone，所以 zone 也可以不配置\n }];\n \n\n### 4.2.2 其他配置\n\n \n \n QNConfiguration *configuration = [QNConfiguration build:^(QNConfigurationBuilder *builder) {\n builder.zone = [[QNAutoZone alloc] init]; // 配置上传区域，使用 QNAutoZone\n builder.recorderKeyGen = ^NSString *(NSString *uploadKey, NSString *filePath) {\n // 自定义 文件分片上传时断点续传信息保存的 key，默认使用 uploadKey\n return [NSString stringWithFormat:@\"%@-%@\", uploadKey, filePath];\n };\n // 文件分片上传时断点续传信息保存，表单上传此配置无效\n NSString *recorderPath = [NSHomeDirectory() stringByAppendingPathComponent:@\"Documents\"];\n builder.recorder = [QNFileRecorder fileRecorderWithFolder:recorderPath error:nil];\n // 文件采用分片上传时，分片大小为 2MB\n builder.chunkSize = 2*1024*1024;\n \n // 分片上传阈值：4MB，大于 4MB 采用分片上传，小于 4MB 采用表单上传\n builder.putThreshold = 4*1024*1024;\n \n // 单个域名/IP请求失败后最大重试次数为 1 次\n builder.retryMax = 1;\n \n // 重试时间间隔：0.5s\n builder.retryInterval = 0.5;\n \n // 请求超时时间：60s\n builder.timeoutInterval = 60;\n \n // 使用 HTTPS\n builder.useHttps = true;\n \n // 使用备用域名进行重试\n builder.allowBackupHost = true;\n \n // 开启加速上传\n builder.accelerateUploading = true;\n \n // 开启并发分片上传\n builder.useConcurrentResumeUpload = true;\n \n // 使用并发分片上传时，一个文件并发上传的分片个数\n builder.concurrentTaskCount = 2;\n \n // 使用分片 V2\n builder.resumeUploadVersion = QNResumeUploadVersionV2;\n }];\n \n \n // 指定文件 mime type\n NSString *mimeType = @\"\";\n // 用于服务器上传回调通知的自定义参数，参数的key必须以x: 开头 eg: x:foo\n NSDictionary <NSString *, NSString *> * params = @{};\n // 用于设置meta数据，参数的key必须以x-qn-meta- 开头 eg: x-qn-meta-key\n NSDictionary <NSString *, NSString *> * metaDataParams = @{};\n BOOL checkCrc = true;\n QNUploadOption *option = [[QNUploadOption alloc] initWithMime:mimeType\n byteProgressHandler:^(NSString *key, long long uploadBytes, long long totalBytes) {\n // 处理上传进度\n } params:params metaDataParams:metaDataParams checkCrc:checkCrc cancellationSignal:^BOOL{\n // 当需要取消时，此处返回 false，SDK 内部会不间断检测此返回值\n return false;\n }];\n \n // 关闭 DNS 预解析\n //从 7.4.0 开始增加了 DNS 预解析和缓存策略（每 2 分钟（进程非挂起状态）会自动刷新缓存策略）来减少 DNS 解析错误。默认预解析开启，需获取 IP 信息。\n kQNGlobalConfiguration.isDnsOpen = NO;\n \n // 关闭网络状态检测，当因网络异常而失败时，会检测网络状态，进而根据情况调整重试逻辑。默认开启网络状态检测。\n kQNGlobalConfiguration.connectCheckEnable = NO;\n \n\n# 5 下载文件\n\n该 SDK 并未提供下载文件相关的功能接口，因为文件下载是一个标准的 HTTP GET 过程。开发者只需理解资源 URI 的组成格式即可非常方便的构建资源\nURI，并在必要的时候加上 [下载凭证](https://developer.qiniu.com/kodo/manual/1202/download-\ntoken) ，即可使用 HTTP GET 请求获取相应资源。\n\n从安全性和代码可维护性的角度考虑，我们建议下载 URL 的拼接过程也在业务服务器进行，让客户端从业务服务器请求。\n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n\n# 常见问题\n\n * 如果碰到 crc 链接错误，请把 libz.dylib 加入到项目中去。\n * 如果碰到 res_9_ninit 链接错误，请把 libresolv.dylib 加入到项目中去。\n * 如果需要支持 iOS 5 或者支持 RestKit，请用 AFNetworking 1.x 分支的版本。\n * 如果碰到其他编译错误，请参考 Cocoapods 的[troubleshooting __](http://guides.cocoapods.org/using/troubleshooting.html)。\n * iOS 9+ 强制使用 https ，需要在 project build info 添加 NSAppTransportSecurity 类型 Dictionary。在 NSAppTransportSecurity下添加 NSAllowsArbitraryLoads 类型 Boolean ，值设为 YES。具体操作请查阅[这里 __](http://blog.csdn.net/guoer9973/article/details/48622823)。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](http://support.qiniu.com/)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2020 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储PHP SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > PHP SDK\n\n# PHP SDK\n\n最近更新时间: 2024-01-02 10:57:36\n\n此 SDK ( version: 7.x.x ) 适用于**PHP >= 5.3.0**。\n\n * [PHP SDK 下载地址 __](https://github.com/qiniu/php-sdk/releases)\n * [PHP SDK 源码地址 __](https://github.com/qiniu/php-sdk)\n\n此 SDK 包含了如下几个功能：\n\n * 数据的上传和下载。\n\n * 数据的管理: 复制，移动，删除，获取元信息，列取文件等功能。\n\n * 数据的处理: 图片的处理，音视频的处理，文档的处理等功能。\n\n * CDN 相关功能: 文件刷新，预取，日志下载等功能。\n\n * 内容审核 相关功能: 图片审核、视频审核功能。\n\n * 云短信 相关功能: 短信息发送、历史查询等功能。\n\n * 实时音视频 相关功能: 连麦等功能。\n\n \nSDK（version: 6.x.x 适用于PHP >= 5.1.0）: [PHP\nSDK历史文档](https://developer.qiniu.com/kodo/sdk/legacy-php) \n\n# 安装\n\n支持以下3种安装 SDK 的方法，推荐通过[Composer __](https://getcomposer.org/)安装 SDK。\n\n * 使用 Composer 安装\n\n[Composer __](http://getcomposer.org/)是 PHP\n依赖管理工具。你可以在自己的项目中声明所依赖的外部工具库，Composer 会自动帮你安装这些依赖的库文件。\n\n1\\. 安装 Composer\n\n \n \n curl -sS https://getcomposer.org/installer | php\n \n\n2\\. 运行 Composer 命令安装最新稳定版本的 SDK：\n\n \n \n php composer.phar require qiniu/php-sdk\n \n\n3\\. Require Composer 生成的 autoloader：\n\n \n \n <?php\n require 'vendor/autoload.php';\n \n\n如果需要更详细的关于 Composer 的使用说明，你可以访问[Composer官方网站\n__](http://getcomposer.org/)，或对应的[中文网站 __](http://www.phpcomposer.com/)。\n\n * 直接下载 Composer 安装包\n\n鉴于某些原因，国内的用户使用 Composer 下载依赖库比较慢，开发者也可以直接下载我们准备好的符合 Composer 规范的[vendor 压缩包\n__](http://qupfile.cloudvdn.com/vendor.zip)并在本地解压。解压后的内容和使用 Composer\n方式获取到的内容完全一致，之后的使用方式也一致。\n\n * 下载源代码包\n\n直接下载源代码压缩包并解压是另一种 SDK 的安装方法。不过因为有版本更新的维护问题，这种安装方法并不推荐，仅作为万一 Composer\n安装有问题的情况下的一种备选。并且，源码中也包含 SDK 的 [autoloader __](https://github.com/qiniu/php-\nsdk/blob/master/autoload.php)。\n\n下载[源代码包 __](https://github.com/qiniu/php-sdk/releases)后，解压到您的项目中。 然后在您的项目中引入\nautoloader：\n\n \n require 'path_to_sdk/autoload.php';\n \n\n# 基本使用方法\n\n安装好 SDK 后，接下来介绍如何使用 SDK。在使用 SDK 之前，\n\n 1. 点击[注册 __](https://portal.qiniu.com/signup)开通 七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n并且详细阅读[安全机制](https://developer.qiniu.com/kodo/manual/1644/security)以进一步了解如何正确使用和管理密钥。\n\n## 引入SDK\n\n无论你是通过哪种方式安装的 SDK，只需要一句简单的 **require**\n语句将安装好的SDK包含到你的项目中。请参考如下表格，找到适合你的安装方式，将SDK引入到你的项目中。请用你项目中的实际路径替换\n**path_to_sdk** 。\n\n安装方式 | 引入SDK \n---|--- \nComposer 安装 | require ‘path_to_sdk/vendor/autoload.php’; \n下载Composer安装包 | require ‘path_to_sdk/vendor/autoload.php’; \n下载源码安装包 | require ‘path_to_sdk/autoload.php’; \n \n## SDK结构\n\n可以直接查看我们的[SDK目录 __](https://github.com/qiniu/php-\nsdk/tree/master/src/Qiniu)，即可大致了解我们 SDK 的结构。\n\n * 最外层包含：配置文件， 鉴权和一些公共的函数。\n * HTTP 目录主要包含了一些对 http 进行封装的类，这块你可以不用关心。\n * Storage 目录主要包含两大块：Bucket 中文件的管理和文件的上传。\n * Processing 目录主要包含文件的处理，文件处理又包含两个方面：同步处理和异步处理。\n * Cdn 目录主要包含了 CDN 的相关 API ，有文件的刷新和预取，CDN 日志的下载等方法。\n\n为了帮助您更好的了解和使用我们的sdk，我们还提供了各种[使用示例 __](https://github.com/qiniu/php-\nsdk/tree/master/examples)。 如果使用中遇到问题，可以通过[Github\n__](https://github.com/qiniu/php-sdk/issues/new)或者我们的[工单\n__](http://support.qiniu.com/)进行反馈。下面我们对一些关键点进行简单的介绍，方便您快速入门。\n\n## 鉴权类\n\n在使用SDK的过程中鉴权是很重要的一块，不管是上传鉴权，下载签权， 还是回调的签权。 PHP SDK 中的 Auth 类封装了所有的鉴权方式。 \n所以在使用 PHP SDK 时基本都会先对鉴权类进行初始化：\n\n \n \n <?php\n require 'path_to_sdk/vendor/autoload.php';\n use Qiniu\\Auth;\n // 用于签名的公钥和私钥\n $accessKey = 'Access_Key';\n $secretKey = 'Secret_Key';\n \n // 初始化签权对象\n $auth = new Auth($accessKey, $secretKey);\n \n\n初始化好Auth 类后，就可以调用相应的方法了，比如生成私有下载链接方法 privateDownloadUrl，获取上传Token方法\nuploadToken，验证回调方法 verifyCallback等。\n\n## 上传类\n\n在上传类 UploadManager 中主要负责文件的上传，\n文件上传分为两种上传方式：[表单上传](https://developer.qiniu.com/kodo/manual/1272/form-\nupload)和[分片上传](https://developer.qiniu.com/kodo/manual/1650/chunked-\nupload)。当然在PHP SDK中你不用关心这个细节，只需要调用 [UploadManager\n__](https://github.com/qiniu/php-\nsdk/blob/master/src/Qiniu/Storage/UploadManager.php)中的上传方法即可。UploadManager\n中的上传方法会根据上传文件的大小选择不同的上传方式，小于4MB的进行表单上传，大于4MB的进行分片上传。 \n以下一个简单的示例使你更清晰地了解如何初始上传对象：\n\n \n \n require 'path_to_sdk/vendor/autoload.php';\n use Qiniu\\Auth;\n use Qiniu\\Storage\\UploadManager;\n $accessKey = 'Access_Key';\n $secretKey = 'Secret_Key';\n $auth = new Auth($accessKey, $secretKey);\n \n $bucket = 'Bucket_Name';\n \n // 生成上传Token\n $token = $auth->uploadToken($bucket);\n \n // 构建 UploadManager 对象\n $uploadMgr = new UploadManager();\n \n\n空间名请参阅[空间](https://developer.qiniu.com/kodo/manual/1728/buckets)。\n\n## 资源管理类\n\n在资源管理类 [BucketManager](https://developer.qiniu.com/kodo/manual/1728/buckets)\n中主要负责空间中文件的管理： 复制，移动，删除，获取元信息，修改Mime，拉取文件到七牛空间，列取文件。 \n以下一个简单的示例使你更清晰地了解如何初始空间管理对象：\n\n \n \n require 'path_to_sdk/vendor/autoload.php';\n use Qiniu\\Auth;\n use Qiniu\\Storage\\BucketManager;\n $accessKey = 'Access_Key';\n $secretKey = 'Secret_Key';\n //初始化Auth状态\n $auth = new Auth($accessKey, $secretKey);\n //初始化BucketManager\n $bucketMgr = new BucketManager($auth);\n \n\n## 触发持久化类\n\n触发持久化类 [PersistentFop __](https://developer.qiniu.com/dora/api/persistent-\ndata-processing-\npfop)中主要负责对空间中已上传的文件进行异步处理，并对异步处理的结果进行持久化操作。比如对已上传的视频文件进行转码，拼接，切片，水印等处理，并将处理后的结果保存在空间中。\n\n \n \n require 'path_to_sdk/vendor/autoload.php';\n use Qiniu\\Auth;\n use Qiniu\\Processing\\PersistentFop;\n $accessKey = 'Access_Key';\n $secretKey = 'Secret_Key';\n $auth = new Auth($accessKey, $secretKey);\n // 要转码的文件所在的空间\n $bucket = 'Bucket_Name';\n // 转码时使用的队列名称 \n $pipeline = 'abc';\n // 初始化\n $pfop = new PersistentFop($auth, $bucket, $pipeline);\n \n\n# 场景化示例\n\n接下来我们，对一些常见的使用场景，提供一些简单的Demo，使您更快速的接入。\n\n## Hello, World!\n\n在了解了基本概念和[编程模型](https://developer.qiniu.com/kodo/manual/1205/programming-\nmodel)后，我们现在以最短的篇幅将第一个云存储服务的示例程序跑起来。该示例的目标是：将一个本地小文件上传到指定的存储空间中。\n\n \n**提交页面**\n\n我们先写一个简单的 HTML 表单来供用户上传到存储空间信息并选择一个本地文件。在点击提交按钮后，浏览器会发送一个 HTTP\n请求到七牛上传域名执行文件上传动作。\n\n \n \n <form method=\"post\" action=\"http://up.qiniup.com\" enctype=\"multipart/form-data\">\n <input name=\"token\" type=\"hidden\" value=\"<upload_token>\">\n <input name=\"file\" type=\"file\" />\n <input type=\"submit\" value=\"上传\"/>\n </form> \n \n\n \n**上传动作**\n\n也许你注意到了这个上传表单有一个`token`字段，所以想要使用 form\n直传一个文件，必须在页面加载的时候，向服务端请求`token`并设置到这个表单项中。服务端生成这个`token`涉及到我们 SDK\n中提供的方法：`Qiniu\\Auth`。\n\n关键代码如下所示：\n\n \n \n use Qiniu\\Auth;\n $bucket = '<your_bucket>';\n $accessKey = '<your_access_key>';\n $secretKey = '<your_secret_key>';\n $auth = new Auth($accessKey, $secretKey);\n $upToken = $auth->uploadToken($bucket);\n echo $upToken;\n \n\n可以看出，以上代码主要做了以下几步工作：\n\n 1. 使用你的 AccessKey 及 SecretKey 用于初始化`Auth`对象\n 2. 调用初始化的对象`Auth`对象的方法`uploadToken`来生成上传token\n\n到这里为止，第一个示例就可以运行起来了。您也可以直接获取和查看该示例的[源代码\n__](https://github.com/rwifeng/qiniudocs/tree/master/demo/simpleuploader)。\n\n**小结**\n\n这个示例仅用于演示如何使用 PHP SDK\n快速运行第一个云存储服务的程序。本事例尽可能简单的展现存储服务的[表单上传](https://developer.qiniu.com/kodo/manual/1272/form-\nupload)，因此请大家仅将本示例作为学习 PHP SDK 的一个步骤，而不是在产品环境中应用。\n\n## 一个完整的移动应用\n\n我们将详细介绍如何使用 PHP SDK 与其他端配合构建一个类似于微信朋友圈的移动应用。\n\n在这个移动应用里终端用户可以进行如下操作：\n\n 1. 使用预设的帐号密码登录（不支持注册新帐号）\n 2. 查看自己和朋友分享的照片以及描述（不支持评论）\n 3. 上传一张新图片，并添加一段描述。\n\n[Demo截图 __](http://rwxf.qiniug.com/demo-screenshot.jpg)\n\n**总体架构**\n\n对于此类应用，我们推荐的总体架构如下图所示：\n\n\n\n对于此架构有以下关键要点：\n\n 1. AK/SK 只能在业务服务器端使用，如果将 AK 和 SK 同时保存或者传输到移动端会有严重的信息泄露风险。\n 2. AK/SK 是企业帐号信息，业务服务器需要有自己的帐号数据库，对应到每一个终端用户的帐号信息。\n 3. 由于不同的业务都需要存放一些跟文件相关的描述信息，且图片又属于不同的终端用户，因此需要维护文件管理表，以管理文件的描述信息和所有者关系。\n\n基于以上这些关键要点，我们来设计和实现我们的 PHP 版本的业务服务器。\n\n**接口设计**\n\n我们来简单的设计我们的业务服务器接口。\n\n帐号验证：\n\n \n \n POST /login.php HTTP/1.1\n HOST: demos.qiniu.io\n Accept: */*\n Content-Type: application/x-www-form-urlencoded\n \n \n uname=<username>&pwd=<password>\n \n\n获取文件列表：\n\n \n \n POST /files.php HTTP/1.1\n HOST: demos.qiniu.io\n Accept: */*\n Cookie: <cookie>\n Content-Type: application/x-www-form-urlencoded\n \n\n获取上传授权，因为移动端并不知道 AK/SK 信息，客户端在需要上传文件时都需要向业务服务器发起一个获取上传授权的请求：\n\n \n \n POST /uptoken.php HTTP/1.1\n HOST: demos.qiniu.io\n Accept: */*\n Cookie: <cookie>\n Content-Type: application/x-www-form-urlencoded\n \n \n\n回调，移动端会直接上传文件到云存储服务，因此业务服务器不需要提供上传接口，但是需要提供一个供云存储服务在接收到文件后的回调接口。回调接口的响应内容会由云存储服务返回给移动端：\n\n \n \n POST /callback.php HTTP/1.1\n HOST: demos.qiniu.io\n Accept: */*\n Cookie: <cookie>\n Content-Type: application/x-www-form-urlencoded\n \n uid=<uid>&fname=<file_name>&fkey=<file_key>&desc=<description>\n \n\n数据表，业务服务需要一个业务数据库的支撑以管理提到的帐号信息和文件信息。在本示例中我们选用 MySQL 来搭建业务数据库。帐号表：\n\n字段名 | 字段类型 | 字段说明 \n---|---|--- \nid | int | 唯一标识。 \nuid | int | 唯一用户标识。 \nuname | char(128) | 用户名，格式为邮箱如 [email protected] 。 \npassword | char(128) | 加密后的密码。 \nstatus | int | `1`: active \n`0`: disabled \n \n文件信息表：\n\n字段名 | 字段类型 | 字段说明 \n---|---|--- \nid | int | 唯一标识。 \nuid | int | 用户唯一标识。 \nfname | char(512) | 文件的显示名 \nkey | char(512) | 文件对应到云存储服务中的唯一标识。 \ncreateTime | time | 上传时间。 \ndescription | char(2048) | 文件的描述内容。 \n \n相应的 SQL 语句如下：\n\n \n \n create database qspace;\n \n CREATE TABLE users (\n uid INT NOT NULL AUTO_INCREMENT,\n uname VARCHAR(128) NOT NULL,\n password VARCHAR(128) NOT NULL,\n status INT, \n PRIMARY KEY (uid)\n );\n \n CREATE TABLE files_info (\n id INT NOT NULL AUTO_INCREMENT,\n uid INT NOT NULL,\n fname VARCHAR(512) NOT NULL,\n fkey VARCHAR(512) NOT NULL,\n createTime INT, \n description VARCHAR(1024), \n PRIMARY KEY (id),\n FOREIGN KEY (uid) REFERENCES users(uid),\n UNIQUE INDEX (id)\n );\n \n\n**服务实现**\n\n接下来我们一步步的实现以上定义的接口。这些实现主要考虑流程的完整性，因此在安全性上没有做充分的考量，请不要直接使用于产品环境中。\n\n配置文件\n\n我们需要在一个地方存放全局的设置。本示例中我们直接用一个 config.php 文件包含若干全局变量的方式来解决这个问题。\n\n \n \n <?php\n class Config\n {\n const DB_NAME = 'qspace',\n DB_USER = 'root',\n DB_PWD = '****',\n DB_HOST = '<your_db_host>',\n ACCESS_KEY = '<your_access_key>',\n SECRET_KEY = '<your_secret_key>',\n BUCKET_NAME = '<your_bucket_name>';\n }\n \n\n帐号验证\n\n帐号验证的逻辑非常简单，就是将请求中包含的用户信息与数据库表中的信息进行比对，因此不需要涉及 SDK 的功能。\n\n \n \n require_once 'db.php';\n session_start();\n if(!isset($_POST['uname']) && !isset($_POST['pwd']))\n {\n http_response_code(401);\n $resp = array('status' => 'failed', 'msg' => 'please input username & password!');\n echo json_encode($resp);\n return;\n }\n \n $uname = $_POST['uname'];\n $_pwd = $_POST['pwd'];\n \n $salt = 'Qiniu' . $uname;\n $pwd = crypt($_pwd, $salt);\n \n $stmt = $DB->prepare('select * from users where uname = :name');\n $stmt->execute(array('name' => $uname));\n $user = $stmt->fetch();\n if ($user['password'] !== $pwd)\n {\n http_response_code(401);\n $resp = array('status' => 'failed', 'msg' => 'incorrect username or password!');\n echo json_encode($resp);\n return;\n }\n \n $_SESSION['uid'] = $user['uid'];\n $_SESSION['uname'] = $uname;\n \n $resp = array('status' => 'ok', 'uname' => $uname);\n echo json_encode($resp);\n \n\n获取文件列表\n\n同帐号验证功能一样，获取文件列表也只是查询数据库，因此不多做解释。\n\n \n \n <?php\n require_once 'db.php';\n session_start();\n $uid = $_SESSION['uid'];\n if(!isset($uid))\n {\n header('location: login.php');\n return;\n }\n $stmt = $DB->prepare('select * from files_info where uid = :uid');\n $stmt->execute(array('uid' => $uid));\n $files = $stmt->fetchAll();\n \n echo json_encode($files);\n \n\n获取上传授权\n\n客户端在需要上传文件时都需要先向业务服务器发起一个获取上传授权的请求。 SDK 中的 [`Qiniu\\Auth`\n__](http://developer.qiniu.com/php_docs/class-\nQiniu.Auth.html)类提供了`uploadToken($bucket, ...)` 方法，可以非常便利的生成对应的上传授权。\n\n \n \n require_once 'vendor/autoload.php';\n require_once 'db.php';\n require_once 'config.php';\n use Qiniu\\Auth;\n session_start();\n $uid = $_SESSION['uid'];\n if(!isset($uid))\n {\n header('location: login.php');\n return;\n }\n $bucket = Config::BUCKET_NAME;\n $accessKey = Config::ACCESS_KEY;\n $secretKey = Config::SECRET_KEY;\n $auth = new Auth($accessKey, $secretKey);\n \n $policy = array(\n 'callbackUrl' => 'http://172.30.251.210/callback.php',\n 'callbackBody' => '{\"fname\":\"$(fname)\", \"fkey\":\"$(key)\", \"desc\":\"$(x:desc)\", \"uid\":' . $uid . '}'\n );\n \n $upToken = $auth->uploadToken($bucket, null, 3600, $policy);\n \n header('Access-Control-Allow-Origin:*');\n echo $upToken;\n \n\n回调\n\n在收到回调时，通常表示一个文件已经成功上传。回调会包含该文件所对应的描述信息。因此业务服务器在收到回调后，需要将相应的文件信息写入到文件信息表中。\n\n \n \n <?php\n require_once 'db.php';\n require_once 'vendor/autoload.php';\n $_body = file_get_contents('php://input');\n $body = json_decode($_body, true);\n $uid = $body['uid'];\n $fname = $body['fname'];\n $fkey = $body['fkey'];\n $desc = $body['desc'];\n \n $date = new DateTime();\n $ctime = $date->getTimestamp();\n \n $stmt = $DB->prepare('INSERT INTO files_info (uid, fname, fkey, createTime, description) VALUES (:uid, :fname, :fkey, :ctime, :desc);');\n $ok = $stmt->execute(array('uid' => $uid, 'fname' => $fname, 'fkey' => $fkey, 'ctime' => $ctime, 'desc' => $desc));\n \n header('Content-Type: application/json');\n if (!$ok)\n {\n $resp = $DB->errorInfo();\n http_response_code(500);\n echo json_encode($resp);\n return;\n }\n $resp = array('ret' => 'success');\n echo json_encode($resp);\n \n\n**服务监控**\n\n为了确认服务的正常运行，我们还实现了一个简单的监控页面以查看所有上传的图片。该页面假设`admin`的管理员才有权访问。后端代码就是将用户上传的文件从数据库中列取出来。\n\n \n \n require_once 'vendor/autoload.php';\n require_once 'db.php';\n \n if (!$_SESSION['logged'])\n {\n header('login.php');\n }\n \n $id = $_POST['id'];\n if ($id)\n {\n $stmt = $DB->prepare('delete from files_info where id = :id');\n $stmt->execute(array('id' => $id));\n }\n $stmt = $DB->prepare('select * from files_info');\n $stmt->execute();\n $files = $stmt->fetchAll();\n $smarty = new Smarty();\n $smarty->assign('files', $files);\n $smarty->display('file_mgr.tpl');\n \n\n前端页面使用 [Bootstrap __](http://getbootstrap.com/)的控件实现，并使用[Smarty\n__](http://www.smarty.net/)模板技术来循环生成最终页面：\n\n \n \n {foreach from=$files item=file}\n <tr>\n <td><a href=\"{$file[uid]}\">{$file[\"uid\"]}</a></td>\n <td>{$file[\"fname\"]}</td>\n <td>{$file[\"fkey\"]}</td>\n <td>{$file[\"description\"]}</td>\n <td>{$file[\"createTime\"]}</td>\n <td><a class=\"del\" href=\"\" data-fid=\"{$file['id']}\">删除</a></td>\n </tr>\n {/foreach}\n \n\n**移动端实现**\n\n本示例包含一个 Android 客户端的实现。因为本文档的重心是结合例子讲解 PHP SDK 的使用，因此这里就不详细讲解如何实现 Android\n客户端了。您可以下载和安装移动客户端的[安装包\n__](http://devtools.qiniu.com/qiniulab-v1.2.1.apk)，或查看移动客户端的[源代码\n__](https://github.com/qiniudemo/qiniu-lab-android)。\n\n**小结**\n\n您可以在 Android\n手机或者模拟器上安装和运行本示例的移动端应用，上传一张图片，并查看图片列表和描述。这个示例的重点在于讲解一个推荐的产品架构，以及各个子系统如何协同工作。\n\n接下来我们再围绕几个示例遍历SDK提供的其他强大功能。接下来的示例都不会再像这个示例一样提供一个完整的移动互联网产品架构，而是把重点放在功能介绍上。您可以举一反三，快速的在本章介绍的示例上进行修改和加强，就可以快速开发出各种有趣的移动互联网应用。移动端[安装包\n__](http://devtools.qiniu.com/qiniulab-v1.2.1.apk)，或查看移动客户端的[源代码\n__](https://github.com/qiniudemo/qiniu-lab-android)，[admin管理界面\n__](http://demos.qiniu.com/demo/qspace/)。\n\n## 图片处理\n\n我们将围绕一个功能相对完备的示例来讲解图片处理的主要用法，并顺便介绍 PHP SDK 的资源管理功能。\n\n这个示例用户可以上传图片，选择图片处理模式，输入相应的处理参数，然后可以查看处理的结果。用户还可以点选不同的图片以显示图片的鉴黄信息和鉴别广告的信息，\n以及获取图片的基本信息，平均色，exif信息等。\n\n下面我们分步来实现这个示例。前端实现使用了[Bootstrap __](http://getbootstrap.com/)和我们的[js-sdk\n__](https://github.com/qiniu/js-sdk)，后端使用 phpsdk 生成上传的 token 。\n\n**生成上传token**\n\n首先安装我们的 phpsdk，然后引入相应文件并调用接口生成上传token：\n\n \n \n require_once 'vendor/autoload.php';\n require_once 'config.php';\n use Qiniu\\Auth;\n $bucket = Config::BUCKET_NAME;\n $accessKey = Config::ACCESS_KEY;\n $secretKey = Config::SECRET_KEY;\n $auth = new Auth($accessKey, $secretKey);\n $upToken = $auth->uploadToken($bucket);\n $ret = array('uptoken' => $upToken);\n echo json_encode($ret);\n \n\n上传部分相关的 html 代码：\n\n \n \n <div id=\"container\">\n <button id=\"pickfiles\" class=\"btn btn-primary btn-lg btn-block\" type=\"submit\">上传图片</button>\n </div> \n \n\n上传对应的调用 jssdk 相关代码：\n\n \n \n var uploader = Qiniu.uploader({\n runtimes: 'html5,flash,html4', //上传模式,依次退化\n browse_button: 'pickfiles', //上传选择的点选按钮，**必需**\n uptoken_url: 'uptoken.php', //Ajax请求upToken的Url，**强烈建议设置**（服务端提供）\n domain: 'http://rwxf.qiniudn.com/', //bucket 域名，下载资源时用到，**必需**\n container: 'container', //上传区域DOM ID，默认是browser_button的父元素，\n max_file_size: '100mb', //最大文件体积限制\n flash_swf_url: 'plupload/Moxie.swf', //引入flash,相对路径\n max_retries: 3, //上传失败最大重试次数\n dragdrop: true, //开启可拖曳上传\n drop_element: 'container', //拖曳上传区域元素的ID，拖曳文件或文件夹后可触发上传\n chunk_size: '4mb', //分块上传时，每片的体积\n auto_start: true, //选择文件后自动上传，若关闭需要自己绑定事件触发上传\n init: {\n 'UploadProgress': function(up, file) {\n $('#pickfiles').prop('disabled', true).html('图片上传中...');\n },\n 'FileUploaded': function(up, file, info) {\n \n $('#pickfiles').prop('disabled', false).html('上传图片');\n var res = JSON.parse(info);\n imgUrl = up.getOption('domain') + res.key;\n refresh(imgUrl);\n },\n 'Error': function(up, err, errTip) {\n $('#pickfiles').prop('disabled', false).html('上传图片');\n }\n }\n });\n \n\n**图片处理**\n\n图片处理的过程非常简单，就是将我们的图片处理 `fop` 以及对应的参数拼接在图片地址后面即可。基本不需要用到 SDK 的功能，当然你也可以使用我们的\njssdk 进行图片地址和处理参数的拼接。 \n比如一个图片：<http://qiniuphotos.qiniudn.com/gogopher.jpg>[\n__](http://qiniuphotos.qiniudn.com/gogopher.jpg)，现在我们对这个图片进行200x200的等比缩放，然后再进行居中剪裁，可以使用`imageView2`的模式1，最终得到的图片：<http://qiniuphotos.qiniudn.com/gogopher.jpg?imageView2/1/w/200/h/200>[\n__](http://qiniuphotos.qiniudn.com/gogopher.jpg?imageView2/1/w/200/h/200)。\n\n \n更多处理规格请参考[图片基本处理 (imageView2)](https://developer.qiniu.com/dora/api/basic-\nprocessing-images-imageview2)文档。 \n\n**图片信息**\n\n * 图片基本信息，只需要在图片外链后面拼接上 `?imageInfo` ，<http://qiniuphotos.qiniudn.com/gogopher.jpg?imageInfo>[ __](http://qiniuphotos.qiniudn.com/gogopher.jpg?imageInfo)：\n\n \n \n {\n format: \"jpeg\",\n width: 640,\n height: 427,\n colorModel: \"ycbcr\",\n orientation: \"Top-left\"\n }\n \n\n * 图片平均色，只需要在图片的外链后面拼接上 `?imageAve` ，<http://qiniuphotos.qiniudn.com/gogopher.jpg?imageAve>[ __](http://qiniuphotos.qiniudn.com/gogopher.jpg?imageAve)：\n\n \n \n {\n RGB: \"0x85694d\"\n }\n \n\n * 图片 Exif 信息，只需要在图片的外链后面拼接上 `?exif`，<http://qiniuphotos.qiniudn.com/gogopher.jpg?exif>[ __](http://qiniuphotos.qiniudn.com/gogopher.jpg?exif)：\n\n \n \n {\n ApertureValue: {\n val: \"5.00 EV (f/5.7)\",\n type: 5\n },\n ColorSpace: {\n val: \"sRGB\",\n type: 3\n },\n ComponentsConfiguration: {\n val: \"- - - -\",\n type: 7\n },\n ...\n }\n \n \n\n**自定义数据处理功能**\n\n除了我们官方提供的强大图片处理功能外，我们的自定义数据处理平台还提供了强大的第三方数据处理服务。在本例中我们就来尝试一下[图片鉴黄服务(nrop)](https://developer.qiniu.com/dora/api/image-\nas-a-yellow-services-nrop) 。\n\n要使用图片鉴黄 NROP 功能，用户需要先在管理平台上的[第三方数据处理\n__](https://portal.qiniu.com/create)开启本功能。开启后使用方式与一般的数据处理指令完全一致（比如获取 EXIF\n信息的接口），仅需要使用带 nrop 参数的 GET 请求即可，返回的 HTTP 响应内容为一个包含鉴定结果的 JSON 字符串。示例代码如下：\n\n<http://qiniuphotos.qiniudn.com/gogopher.jpg?nrop>[__](http://qiniuphotos.qiniudn.com/gogopher.jpg?nrop)\n\n \n \n {\n statistic: [\n 0,\n 0,\n 1\n ],\n reviewCount: 0,\n fileList: [{\n rate: 0.9946920275688171, // 介于0-1间的浮点数，表示该图像被识别为某个分类的概率值，概率越高、机器越肯定\n label: 2, // 0：色情； 1：性感； 2：正常\n name: \"739a77baf4ff2d5eae5fe56602fc0cbe/gogopher.jpg\",\n review: false //是否需要人工复审该图片，鉴黄服务是否对结果确定(true：不确定，false：确定)\n }],\n nonce: \"0.5508577267173678\",\n timestamp: 1437903830,\n code: 0,\n message: \"success\"\n }\n \n \n\n我们提供的完整示例已经包含了对 NROP 的调用，以及对广告的鉴定，您可以体验一下效果。\n\n**小结**\n\n这个示例结束后，相信你已经比较了解我们的平台是如何支持图片内容的编辑，基本上这些动作都只是一个简单的 GET 请求即可完成，甚至都不需要依赖于\nSDK。您可以查看和下载本示例的[完整源代码\n__](https://github.com/rwifeng/qiniudocs/tree/master/demo/qimage)。\n\n## 音视频处理\n\n用一个示例详细讲解七牛云对音视频和流媒体格式的强大支持。该示例的目标为完成以下动作：\n\n 1. 支持断点续传的大文件上传，因为视频文件通常比较大，难以用单次 POST 请求完成上传；\n 2. 支持上传后异步执行的自动转码动作，生成若干不同规格的目标视频，分别适合在手机和电脑上播放；\n 3. 将文件转换为 HLS 格式存放，以支持边下载边播放的效果；\n 4. 为视频打上一个图片水印；\n 5. 统一从每一个视频文件抽取一个固定时间点的画面作为预览图片；\n 6. 在网页播放器中播放生成的视频文件；\n\n我们选用 [plupload __](http://www.plupload.com/)作为我们的上传控件，并使用[videojs\n__](http://www.videojs.com/)作为我们的网页播放器。其他采用的技术与之前的示例一致，主要是 Bootstrap 和 Smarty\n。因为文件为客户端直传，因此我们也需要提供一个回调服务，以便于接收上传和转码这些异步任务的完成事件。为了简单起见，该示例就不再实现一个独立的业务数据库了，直接从目标存储空间获取文件信息。\n\n**大文件上传**\n\n因为大文件上传必须在浏览器端进行，因此我们就不演示如何用 PHP SDK 做断点续上传了。网页端的大文件上传我们可以用定制版本的 plupload 来支持。 \n具体可以查看我们的[jssdk __](https://github.com/qiniu/js-sdk)。\n\n**上传后自动转码**\n\n我们可以通过设置[上传策略](https://developer.qiniu.com/kodo/manual/1206/put-\npolicy)来通知存储服务在上传完成后自动发起一个异步的任务。上传策略在调用上传接口时作为参数传入。 \n这里的转码过程需要支持转为 HLS 格式，并且在转码后打上视频水印。具体生成上传策略的代码为：\n\n \n \n $bucket = Config::BUCKET_NAME;\n $auth = new Auth(Config::AK, Config::SK);\n \n $wmImg = Qiniu\\base64_urlSafeEncode('http://rwxf.qiniudn.com/logo-s.png');\n $pfopOps = \"avthumb/m3u8/noDomain/1/wmImage/$wmImg\";\n $policy = array(\n 'persistentOps' => $pfopOps,\n 'persistentNotifyUrl' => 'http://<your_notify_url>',\n );\n \n $upToken = $auth->uploadToken($bucket, null, 3600, $policy);\n echo json_encode(array('uptoken' => $upToken));\n \n\n**抽取视频截图**\n\n我们可以从上传视频中截取固定时间点的帧，以作为这些视频的封面图片。视频截图如下所示：\n\n \n \n http://<your_uploaded_video>?vframe/jpg/offset/5\n \n\n**视频浏览与播放**\n\n在完成以上工作后，接下来的工作就简单了。我们可以生成一个列表网页，每个列表项都是一张视频截图，点击视频截图会弹出一个播放面板。因为类似的前端代码已经在本文档展示过，这里就不再多展示一次。\n\n**小结**\n\n视频的示例就到这里完成了。您可以直接查看本示例的[在线演示\n__](http://demos.qiniu.com/demo/qav/index.php)，或下载和查看本示例的[完整源代码\n__](https://github.com/rwifeng/qiniudocs/tree/master/demo/qav)。\n\n需要注意的是，我们这边使用了videojs的开源播放器， 世面上还有其他比较优秀的播放器，具体你可以参考[播放器推荐\n__](https://support.qiniu.com/hc/kb/article/68873)。\n\n另外，对于视频内容，CDN 的选择会是一个影响视频播放是否能够足够流畅的关键因素。在融合 CDN 管理平台会给列出的可用 CDN\n线路标注是否适用于视频加速，请合理选择。\n\n \n\n### **下面将展示 PHP-SDK 中具体功能和演示代码**\n\n# 文件上传\n\n * 上传流程\n * 上传凭证\n * 简单上传凭证\n * 覆盖上传凭证\n * 自定义上传回复凭证\n * 带回调业务服务器的凭证\n * 带数据处理的凭证\n * 带自定义参数的凭证\n * 综合上传凭证\n * 服务器直传\n * 文件上传（表单上传）\n * 字节数组上传（表单上传）\n * 文件分片上传（断点续传）\n * 解析自定义回复内容\n * 业务服务器验证存储服务回调\n * 设置代理\n\n## 上传流程\n\n在七牛云存储中，整个上传流程大致分为以下几步：\n\n 1. 业务服务器颁发[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)给客户端（终端用户）\n 2. 客户端凭借上传凭证上传文件到七牛\n 3. 在七牛获得完整数据后，发起一个 HTTP 请求回调到业务服务器\n 4. 业务服务器保存相关信息，并返回一些信息给七牛\n 5. 七牛原封不动地将这些信息转发给客户端（终端用户）\n\n**注意：**回调到业务服务器的过程是可选的，它取决于业务服务器颁发的上传凭证。如果没有回调，七牛会返回一些标准的信息（例如文件的 hash）给客户端。 \n如果上传发生在业务服务器，以上流程简化为：\n\n 1. 业务服务器生成上传凭证\n 2. 凭借上传凭证上传文件到七牛\n 3. 后续工作，例如保存一些相关信息\n\n## 上传凭证\n\n \n上传凭证实际上是用 AccessKey/SecretKey 进行数字签名的上传策略\nQiniu_RS_PutPolicy，它控制着整个上传流程的行为。具体上传策略参数的解释可见\n[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-token)\n\n \n \n private static $policyFields = array(\n 'callbackUrl',\n 'callbackBody',\n 'callbackHost',\n 'callbackBodyType',\n \n 'returnUrl',\n 'returnBody',\n \n 'endUser',\n 'saveKey',\n 'insertOnly',\n \n 'detectMime',\n 'mimeLimit',\n 'fsizeMin',\n 'fsizeLimit',\n \n 'persistentOps',\n 'persistentNotifyUrl',\n 'persistentPipeline',\n \n 'deleteAfterDays',\n 'fileType',\n 'isPrefixalScope',\n );\n \n\n在构建上传凭证之前，我们首先要定义鉴权对象Auth\n\n \n \n use \\Qiniu\\Auth;\n \n $accessKey = \"QINIU_ACCESS_KEY\"\n $secretKey = \"QINIU_SECRET_KEY\"\n $bucket = \"your bucket name\"\n \n // 初始化Auth状态\n $auth = new Auth($accessKey, $secretKey);\n \n \n\n### **简单上传的凭证**\n\n最简单的上传凭证只需要 `AccessKey`，`SecretKey` 和 `Bucket` 就可以。\n\n \n \n $expires = 3600;\n $policy = null;\n $upToken = $auth->uploadToken($bucket, null, $expires, $policy, true);\n print($upToken . \"\\n\");\n \n\n默认情况下，在不指定上传凭证的有效时间情况下，默认有效期为1个小时。也可以自行指定上传凭证的有效期，例如：\n\n \n \n //自定义凭证有效期（示例2小时，expires单位为秒，为上传凭证的有效时间）\n $expires = 7200;\n $upToken = $auth->uploadToken($bucket, null, $expires, $policy, true);\n print($upToken . \"\\n\");\n \n \n\n### **覆盖上传的凭证**\n\n覆盖上传除了需要`简单上传`所需要的信息之外，还需要想进行覆盖的文件名称，这个文件名称同时可是客户端上传代码中指定的文件名，两者必须一致。\n\n \n \n //覆盖上传\n $expires = 3600;\n $keyToOverwrite = 'qiniu.mp4';\n $upToken = $auth->uploadToken($bucket, $keyToOverwrite, $expires, $policy, true);\n print($upToken . \"\\n\");\n \n\n### **自定义上传回复的凭证**\n\n \n \n $returnBody = '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\"}';\n $policy = array(\n 'returnBody' => $returnBody\n );\n $upToken = $auth->uploadToken($bucket, null, $expires, $policy, true);\n print($upToken . \"\\n\");\n \n\n默认情况下，文件上传好之后，在没有设置`returnBody`或者`回调`相关的参数情况下，七牛返回给上传端的回复格式为`hash`和`key`，例如：\n\n \n \n {\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"key\":\"qiniu.jpg\"}\n \n\n有时候我们希望能自定义这个返回的JSON格式的内容，可以通过设置`returnBody`参数来实现，在`returnBody`中，我们可以使用[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)和[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)。\n\n \n \n //自定义返回值\n $returnBody = '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"name\":\"$(x:name)\"}';\n $policy = array(\n 'returnBody' => $returnBody\n );\n $upToken = $auth->uploadToken($bucket, null, $expires, $policy, true);\n print($upToken . \"\\n\");\n \n \n\n则文件上传到七牛之后，收到的回复内容如下：\n\n \n \n {\"key\":\"qiniu.jpg\",\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"bucket\":\"if-bc\",\"fsize\":39335,\"name\":\"qiniu\"}\n \n\n### **带回调业务服务器的凭证**\n\n上面生成的`自定义上传回复`的上传凭证适用于上传端（无论是客户端还是服务端）和七牛服务器之间进行直接交互的情况下。在客户端上传的场景之下，有时候客户端需要在文件上传到七牛之后，从业务服务器获取相关的信息，这个时候就要用到七牛的上传回调及相关回调参数的设置。\n\n \n \n $policy = array(\n 'callbackUrl' => 'http://api.example.com/qiniu/upload/callback',\n 'callbackBody' => '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\"}',\n 'callbackBodyType' => 'application/json'\n );\n $upToken = $auth->uploadToken($bucket, null, $expires, $policy, true);\n print($upToken . \"\\n\");\n \n\n在使用了上传回调的情况下，客户端收到的回复就是业务服务器响应七牛的JSON格式内容。 \n通常情况下，我们建议使用`application/json`格式来设置`callbackBody`，保持数据格式的统一性。实际情况下，`callbackBody`也支持`application/x-www-\nform-urlencoded`格式来组织内容，这个主要看业务服务器在接收到`callbackBody`的内容时如何解析。例如：\n\n \n \n $policy = array(\n 'callbackUrl' => 'http://api.example.com/qiniu/upload/callback',\n 'callbackBody' => 'key=$(key)&hash=$(etag)&bucket=$(bucket)&fsize=$(fsize)&name=$(x:name)'\n );\n $upToken = $auth->uploadToken($bucket, null, $expires, $policy, true);\n print($upToken . \"\\n\");\n \n \n\n### **带数据处理的凭证**\n\n支持在文件上传到七牛之后，立即对其进行多种指令的数据处理，这个只需要在生成的上传凭证中指定相关的处理参数即可。\n\n \n \n //持久化数据处理的上传凭证\n $saveMp4Entry = \\Qiniu\\base64_urlSafeEncode($bucket . \":avthumb_test_target.mp4\");\n $saveJpgEntry = \\Qiniu\\base64_urlSafeEncode($bucket . \":vframe_test_target.jpg\");\n $avthumbMp4Fop = \"avthumb/mp4|saveas/\" . $saveMp4Entry;\n $vframeJpgFop = \"vframe/jpg/offset/1|saveas/\" . $saveJpgEntry;\n $policy = array(\n 'persistentOps' => $avthumbMp4Fop . \";\" . $vframeJpgFop,\n 'persistentPipeline' => \"video-pipe\",\n 'persistentNotifyUrl' => \"http://api.example.com/qiniu/pfop/notify\",\n );\n $upToken = $auth->uploadToken($bucket, null, $expires, $policy, true);\n print($upToken . \"\\n\");\n \n \n\n队列 pipeline 请参阅[创建私有队列 __](https://portal.qiniu.com/dora/media-\ngate/pipeline)；转码操作具体参数请参阅[音视频转码](https://developer.qiniu.com/dora/api/audio-\nand-video-transcoding-avthumb)；saveas\n请参阅[处理结果另存](https://developer.qiniu.com/dora/api/processing-results-save-\nsaveas)。 \n\n### **带自定义参数的凭证**\n\n支持客户端上传文件的时候定义一些自定义参数，这些参数可以在`returnBody`和`callbackBody`里面和七牛内置支持的魔法变量（即系统变量）通过相同的方式来引用。这些自定义的参数名称必须以`x:`开头。例如客户端上传的时候指定了自定义的参数`x:name`和`x:age`分别是`string`和`int`类型。那么可以通过下面的方式引用：\n\n \n \n returnBody: '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\",\"age\":$(x:age)}'\n \n \n\n或者\n\n \n \n callbackBody: '{\"key\":\"$(key)\",\"hash\":\"$(etag)\",\"fsize\":$(fsize),\"bucket\":\"$(bucket)\",\"name\":\"$(x:name)\",\"age\":$(x:age)}'\n \n \n\n### **综合上传凭证**\n\n上面的生成上传凭证的方法，都是通过设置[上传策略🔗](https://developer.qiniu.com/kodo/manual/1206/put-\npolicy)相关的参数来支持的，这些参数可以通过不同的组合方式来满足不同的业务需求，可以灵活地组织你所需要的上传凭证。\n\n## **服务端直传**\n\n服务端直传是指客户利用七牛服务端SDK从服务端直接上传文件到七牛云，交互的双方一般都在机房里面，所以服务端可以自己生成上传凭证，然后利用SDK中的上传逻辑进行上传，最后从七牛云获取上传的结果，这个过程中由于双方都是业务服务器，所以很少利用到上传回调的功能，而是直接自定义`returnBody`来获取自定义的回复内容。\n\n### **文件上传**\n\n最简单的就是上传本地文件，直接指定文件的完整路径即可上传。 \nphp-sdk会判断文件大小，根据文件大小选择使用表单上传和分片上传。这里只需要调用 `putFile` 方法就可以了。\n\n \n \n // 引入鉴权类\n use Qiniu\\Auth;\n \n // 引入上传类\n use Qiniu\\Storage\\UploadManager;\n \n // 需要填写你的 Access Key 和 Secret Key\n $accessKey =\"your accessKey\";\n $secretKey = \"your secretKey\"\n $bucket = \"your bucket name\";\n \n // 构建鉴权对象\n $auth = new Auth($accessKey, $secretKey);\n \n // 生成上传 Token\n $token = $auth->uploadToken($bucket);\n \n // 要上传文件的本地路径\n $filePath = './php-logo.png';\n \n // 上传到存储后保存的文件名\n $key = 'my-php-logo.png';\n \n // 初始化 UploadManager 对象并进行文件的上传。\n $uploadMgr = new UploadManager();\n \n // 调用 UploadManager 的 putFile 方法进行文件的上传。\n list($ret, $err) = $uploadMgr->putFile($token, $key, $filePath, null, 'application/octet-stream', true, null, 'v2');\n echo \"\\n====> putFile result: \\n\";\n if ($err !== null) {\n var_dump($err);\n } else {\n var_dump($ret);\n }\n \n \n\n### **字节数组上传**\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $auth = new Auth($accessKey, $secretKey);\n $token = $auth->uploadToken($bucket);\n $uploadMgr = new UploadManager();\n \n //----------------------------------------upload demo1 ----------------------------------------\n // 上传字符串到存储\n list($ret, $err) = $uploadMgr->put($token, null, 'content string');\n echo \"\\n====> put result: \\n\";\n if ($err !== null) {\n var_dump($err);\n } else {\n var_dump($ret);\n }\n \n\n### **文件分片上传（断点续传）**\n\n可以选择分片上传版本，推荐上传时指定 version = ‘v2’，表示 分片上传 v2 版，默认分片上传 v1\n版，兼容历史情况。若需深入了解上传方式之间的区别，请参阅上传类型中\n[表单上传](https://developer.qiniu.com/kodo/manual/1272/form-upload) 、[分片上传 v1\n版](https://developer.qiniu.com/kodo/manual/1650/chunked-upload) 和 [分片上传 v2\n版](https://developer.qiniu.com/kodo/6364/multipartupload-interface) 接口说明。\n\n \n \n // 引入鉴权类\n use Qiniu\\Auth;\n \n // 引入上传类\n use Qiniu\\Storage\\UploadManager;\n \n // 需要填写你的 Access Key 和 Secret Key\n $accessKey =\"your accessKey\";\n $secretKey = \"your secretKey\"\n $bucket = \"your bucket name\";\n \n // 构建鉴权对象\n $auth = new Auth($accessKey, $secretKey);\n \n // 生成上传 Token\n $token = $auth->uploadToken($bucket);\n \n // 要上传文件的本地路径\n $filePath = './php-logo.png';\n \n // 上传到存储后保存的文件名\n $key = 'my-php-logo.png';\n \n // 如果指定了断点记录文件，那么下次会从指定的该文件尝试读取上次上传的进度，以实现断点续传\n $resumeFile = 'progress.log';\n \n // 分片上传可指定 version 字段，v2 表示使用分片上传 v2 , v1 表示 分片上传 v1 (默认 v1) , 选择 v2 可自定义分片大小，此处设为 6 MB，默认 4 MB\n $version = 'v2';\n $partSize = 6 * 1024 * 1024;\n \n // 初始化 UploadManager 对象并进行文件的上传。\n $uploadMgr = new UploadManager();\n \n // 调用 UploadManager 的 putFile 方法进行文件的上传。\n list($ret, $err) = $uploadMgr->putFile(\n $token,\n $key,\n $filePath,\n null,\n 'application/octet-stream',\n false,\n $resumeFile,\n $version,\n $partSize\n );\n echo \"\\n====> putFile result: \\n\";\n if ($err !== null) {\n var_dump($err);\n } else {\n var_dump($ret);\n }\n \n \n\n### **解析自定义回复内容**\n\n有些情况下，七牛返回给上传端的内容不是默认的`hash`和`key`形式，这种情况下，可能出现在自定义`returnBody`或者自定义了`callbackBody`的情况下，前者一般是服务端直传的场景，而后者则是接受上传回调的场景，这两种场景之下，都涉及到需要将自定义的回复进行内容解析，一般建议在交互过程中，都采用`JSON`的方式，这样处理起来方法比较一致。\n\n### **业务服务器验证存储服务回调**\n\n在上传策略里面设置了上传回调相关参数的时候，七牛在文件上传到服务器之后，会主动地向`callbackUrl`发送POST请求的回调，回调的内容为`callbackBody`模版所定义的内容，如果这个模版里面引用了[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)或者[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)，那么这些变量会被自动填充对应的值，然后在发送给业务服务器。\n\n业务服务器在收到来自七牛的回调请求的时候，可以根据请求头部的`Authorization`字段来进行验证，查看该请求是否是来自七牛的未经篡改的请求,具体可以参考七牛的[回调鉴权](https://developer.qiniu.com/kodo/kb/1409/seven-\ncattle-callback-and-callback-authentication)。\n\n**注意** ：业务端服务器回调鉴权的Content-Type类型应该与上传策略中指定的callbackBodyType相同，默认为\napplication/x-www-form-urlencoded，当 Content-Type 为 application/x-www-form-\nurlencoded 时，签名内容必须包括请求内容。当 Content-Type 为 application/json 时，签名内容不包括请求内容。\n\n \n \n /**\n <?php\n require_once __DIR__ . '/../autoload.php';\n use Qiniu\\Auth;\n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n $auth = new Auth($accessKey, $secretKey);\n //获取回调的body信息\n $callbackBody = file_get_contents('php://input');\n //回调的contentType\n $contentType = 'application/x-www-form-urlencoded';\n //回调的签名信息，可以验证该回调是否来自存储服务\n $authorization = $_SERVER['HTTP_AUTHORIZATION'];\n //存储服务回调的url，具体可以参考：http://developer.qiniu.com/docs/v6/api/reference/security/put-policy.html\n $url = 'http://172.30.251.210/upload_verify_callback.php';\n $isQiniuCallback = $auth->verifyCallback($contentType, $authorization, $url, $callbackBody);\n if ($isQiniuCallback) {\n $resp = array('ret' => 'success');\n } else {\n $resp = array('ret' => 'failed');\n }\n echo json_encode($resp);\n \n\n### **设置代理**\n\nphp-sdk v7.11.0 起支持通过代理上传数据，只需要在构建`UploadManager`的时候设置`RequestOptions`即可。\n\n \n \n /**\n <?php\n // 引入上传类\n use Qiniu\\Storage\\UploadManager;\n // 引入请求选项类\n use Qiniu\\Http\\RequestOptions;\n \n $reqOpt = new RequestOptions();\n $reqOpt->proxy = 'http://127.0.0.1:8118' // 设置 HTTP 代理\n $reqOpt->proxy = 'socks4://127.0.0.1:1080' // 设置 SOCKS4 代理\n $reqOpt->proxy = 'socks5://127.0.0.1:1080' // 设置 SOCKS5 代理\n $reqOpt->proxy_user_password = '<username>:<password>' // 设置代理鉴权\n $uploadMgr = new UploadManager(null, $reqOpt);\n \n\n# 下载文件\n\n * 公开空间\n * 私有空间\n\n文件下载分为公开空间的文件下载和私有空间的文件下载。 \n\n### 公开空间\n\n \n每个 bucket 都会绑定一个或多个域名 (domain)。如果这个 bucket 是公开的，那么该 bucket 中的所有文件可以通过一个公开的下载\nurl 访问：\n\n \n \n http://<domain>/<key>\n \n\n其中 domain 是 bucket 对应的域名。七牛云存储为每一个 bucket 提供一个默认域名。默认域名可以到[七牛开发者平台\n__](https://portal.qiniu.com/)中的存储空间查询。\n\n假设某个 bucket 既绑定了七牛的二级域名，如：hello.qiniudn.com，也绑定了自定义域名（需要备案），如：hello.com。那么该\nbucket 中 key 为 test.mp4 的文件可以通过 `http://hello.qiniudn.com/qiniu.mp4` 或\n`http://hello.com/qiniu.mp4` 中任意一个 url 进行访问。\n\n## 下载私有文件\n\n如果某个 bucket 是私有的，那么这个 bucket 中的所有文件只能通过一个临时有效的 downloadUrl 访问：\n\n \n \n http://<domain>/<key>?e=<deadline>&token=<dntoken>\n \n\n其中 token\n是由业务服务器签发的一个临时[下载凭证](https://developer.qiniu.com/kodo/manual/1202/download-\ntoken)，deadline 是其有效期。下载凭证不需要单独生成，php-SDK 提供了生成完整\n\n \n \n use Qiniu\\Auth;\n \n $accessKey =\"your accessKey\";\n $secretKey = \"your secretKey\"\n \n // 构建Auth对象\n $auth = new Auth($accessKey, $secretKey);\n \n // 私有空间中的外链 http://<domain>/<file_key>\n $baseUrl = 'http://if-pri.qiniudn.com/qiniu.png?imageView2/1/h/500';\n // 对链接进行签名\n $signedUrl = $auth->privateDownloadUrl($baseUrl);\n \n echo $signedUrl;\n \n \n\n生成 downloadUrl 后，服务端下发 downloadUrl 给客户端。客户端收到 downloadUrl 后，和公有资源类似，直接用任意的\nHTTP 客户端就可以下载该资源了。需要注意的是，在 downloadUrl 失效却还没有完成下载时，需要重新向服务器申请授权。\n\n# 资源管理\n\n资源管理包括的主要功能有： \n资源管理包括对存储在七牛云存储上的文件进行查看、删除、复制和移动处理。同时七牛云存储也支持对文件进行相应的批量操作。\n\n * 获取文件信息\n * 修改文件MimeType\n * 修改文件存储类型\n * 移动或重命名文件\n * 复制文件副本\n * 删除空间中的文件\n * 设置或更新文件生存时间\n * 获取指定前缀文件列表\n * 抓取网络资源到空间\n * 更新镜像存储空间中文件内容\n * 资源管理批量操作\n * 批量获取文件信息\n * 批量修改文件类型\n * 批量删除文件\n * 批量复制文件\n * 批量移动或重命名文件\n * 批量更新文件的有效期\n * 批量更新文件存储类型\n * 设置代理\n\n## 获取文件信息\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n $key = \"qiniu.mp4\";\n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n list($fileInfo, $err) = $bucketManager->stat($bucket, $key);\n if ($err) {\n print_r($err);\n } else {\n print_r($fileInfo);\n }\n \n \n\n## 修改文件MimeType\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n $key = 'qiniu.mp4';\n $newMime = 'video/x-mp4';\n \n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n $err = $bucketManager->changeMime($bucket, $key, $newMime);\n if ($err) {\n print_r($err);\n }\n \n\n## 修改文件存储类型\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $key = \"qiniu.mp4\";\n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n $fileType = 1; // 0 表示普通存储，1 表示低频存储，2 表示归档存储，3 表示深度归档存储，4 表示归档直读存储\n \n $err = $bucketManager->changeType($bucket, $key, $fileType);\n if ($err) {\n print_r($err);\n }\n \n\n## 移动或重命名文件\n\n移动操作本身支持移动文件到相同，不同空间中，在移动的同时也可以支持文件重命名。唯一的限制条件是，移动的源空间和目标空间必须在同一个机房。\n\n源空间 | 目标空间 | 源文件名 | 目标文件名 | 描述 \n---|---|---|---|--- \nBucketA | BucketA | KeyA | KeyB | 相当于同空间文件重命名 \nBucketA | BucketB | KeyA | KeyA | 移动文件到BucketB，文件名一致 \nBucketA | BucketB | KeyA | KeyB | 移动文件到BucketB，文件名变成KeyB \n \n`move`操作支持强制覆盖选项，即如果目标文件已存在，可以设置强制覆盖选项`force`来覆盖那个文件的内容。\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n $key = \"qiniu.mp4\";\n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n $srcBucket = $bucket;\n $destBucket = $bucket;\n $srcKey = $key . \"_copy\";\n $destKey = $key . \"_move\";\n $err = $bucketManager->move($srcBucket, $srcKey, $destBucket, $destKey, true);\n if ($err) {\n print_r($err);\n }\n \n\n## 复制文件副本\n\n文件的复制和文件移动其实操作一样，主要的区别是移动后源文件不存在了，而复制的结果是源文件还存在，只是多了一个新的文件副本。\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n $key = \"qiniu.mp4\";\n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n $srcBucket = $bucket;\n $destBucket = $bucket;\n $srcKey = $key;\n $destKey = $key . \"_copy\";\n $err = $bucketManager->copy($srcBucket, $srcKey, $destBucket, $destKey, true);\n if ($err) {\n print_r($err);\n }\n \n\n## 删除空间中的文件\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $key = \"qiniu.mp4_copy\";\n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n $err = $bucketManager->delete($bucket, $key);\n if ($err) {\n print_r($err);\n }\n \n\n## 设置或更新文件的生存时间\n\n可以给已经存在于空间中的文件设置文件生存时间，或者更新已设置了生存时间但尚未被删除的文件的新的生存时间。\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $key = 'qiniu.mp4';\n $days = 10;\n \n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n $err = $bucketManager->deleteAfterDays($bucket, $key, $days);\n if ($err) {\n print_r($err);\n }\n \n\n## 获取指定空间的文件列表\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n $auth = new Auth($accessKey, $secretKey);\n $bucketManager = new BucketManager($auth);\n \n // 要列取文件的公共前缀\n $prefix = '';\n \n // 上次列举返回的位置标记，作为本次列举的起点信息。\n $marker = '';\n \n // 本次列举的条目数\n $limit = 100;\n \n $delimiter = '/';\n \n // 列举文件\n list($ret, $err) = $bucketManager->listFiles($bucket, $prefix, $marker, $limit, $delimiter);\n if ($err !== null) {\n echo \"\\n====> list file err: \\n\";\n var_dump($err);\n } else {\n if (array_key_exists('marker', $ret)) {\n echo \"Marker:\" . $ret[\"marker\"] . \"\\n\";\n }\n echo \"\\nList Iterms====>\\n\";\n //var_dump($ret['items']);\n }\n \n\n## 抓取网络资源到空间\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n $auth = new Auth($accessKey, $secretKey);\n $bucketManager = new BucketManager($auth);\n \n $url = 'http://devtools.qiniu.com/qiniu.png';\n $key = time() . '.png';\n \n // 指定抓取的文件保存名称\n list($ret, $err) = $bucketManager->fetch($url, $bucket, $key);\n echo \"=====> fetch $url to bucket: $bucket key: $key\\n\";\n if ($err !== null) {\n var_dump($err);\n } else {\n print_r($ret);\n }\n \n // 不指定key时，以文件内容的hash作为文件名\n $key = null;\n list($ret, $err) = $bucketManager->fetch($url, $bucket, $key);\n echo \"=====> fetch $url to bucket: $bucket key: $(etag)\\n\";\n if ($err !== null) {\n var_dump($err);\n } else {\n print_r($ret);\n }\n \n\n## 更新镜像空间中存储的文件内容\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $key = \"qiniu.mp4\";\n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n $err = $bucketManager->prefetch($bucket, $key);\n if ($err) {\n print_r($err);\n }\n \n \n\n## 资源管理批量操作\n\n### **批量获取文件信息**\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n //每次最多不能超过1000个\n $keys = array(\n 'qiniu.mp4',\n 'qiniu.png',\n 'qiniu.jpg'\n );\n \n $ops = $bucketManager->buildBatchStat($bucket, $keys);\n list($ret, $err) = $bucketManager->batch($ops);\n if ($err) {\n print_r($err);\n } else {\n print_r($ret);\n }\n \n\n### **批量修改文件类型**\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n //每次最多不能超过1000个\n $keys = array(\n 'qiniu.mp4',\n 'qiniu.png',\n 'qiniu.jpg'\n );\n \n $keyTypePairs = array();\n //type=0表示普通存储，type=1表示低频存储\n foreach ($keys as $key) {\n $keyTypePairs[$key] = 1;\n }\n \n $ops = $bucketManager->buildBatchChangeType($bucket, $keyTypePairs);\n list($ret, $err) = $bucketManager->batch($ops);\n if ($err) {\n print_r($err);\n } else {\n print_r($ret);\n }\n \n \n\n### **批量删除文件**\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n //每次最多不能超过1000个\n $keys = array(\n 'qiniu.mp4',\n 'qiniu.png',\n 'qiniu.jpg'\n );\n \n $ops = $bucketManager->buildBatchDelete($bucket, $keys);\n list($ret, $err) = $bucketManager->batch($ops);\n if ($err) {\n print_r($err);\n } else {\n print_r($ret);\n }\n \n \n\n### **批量复制文件**\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n //每次最多不能超过1000个\n $keys = array(\n 'qiniu.mp4',\n 'qiniu.png',\n 'qiniu.jpg'\n );\n \n $keyPairs = array();\n foreach ($keys as $key) {\n $keyPairs[$key] = $key . \"_copy\";\n }\n $srcBucket = $bucket;\n $destBucket = $bucket;\n \n $ops = $bucketManager->buildBatchCopy($srcBucket, $keyPairs, $destBucket, true);\n list($ret, $err) = $bucketManager->batch($ops);\n if ($err) {\n print_r($err);\n } else {\n print_r($ret);\n }\n \n\n### **批量移动或重命名文件**\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n //每次最多不能超过1000个\n $keys = array(\n 'qiniu.mp4',\n 'qiniu.png',\n 'qiniu.jpg'\n );\n \n $keyPairs = array();\n foreach ($keys as $key) {\n $keyPairs[$key . \"_copy\"] = $key . \"_move\";\n }\n \n $srcBucket = $bucket;\n $destBucket = $bucket;\n \n $ops = $bucketManager->buildBatchMove($srcBucket, $keyPairs, $destBucket, true);\n list($ret, $err) = $bucketManager->batch($ops);\n if ($err) {\n print_r($err);\n } else {\n print_r($ret);\n }\n \n \n\n### **批量更新文件的有效期**\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n //每次最多不能超过1000个\n $keys = array(\n 'qiniu.mp4',\n 'qiniu.png',\n 'qiniu.jpg'\n );\n \n $keyDayPairs = array();\n //day=0表示永久存储\n foreach ($keys as $key) {\n $keyDayPairs[$key] = 0;\n }\n \n $ops = $bucketManager->buildBatchDeleteAfterDays($bucket, $keyDayPairs);\n list($ret, $err) = $bucketManager->batch($ops);\n if ($err) {\n print_r($err);\n } else {\n print_r($ret);\n }\n \n \n\n### **批量更新文件存储类型**\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $auth = new Auth($accessKey, $secretKey);\n $config = new \\Qiniu\\Config();\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config);\n \n //每次最多不能超过1000个\n $keys = array(\n 'qiniu.mp4',\n 'qiniu.png',\n 'qiniu.jpg'\n );\n \n $keyTypePairs = array();\n //type=0表示普通存储，type=1表示低频存储\n foreach ($keys as $key) {\n $keyTypePairs[$key] = 1;\n }\n \n $ops = $bucketManager->buildBatchChangeType($bucket, $keyTypePairs);\n list($ret, $err) = $bucketManager->batch($ops);\n if ($err) {\n print_r($err);\n } else {\n print_r($ret);\n }\n \n \n\n## **设置代理**\n\nphp-sdk v7.11.0\n起支持通过代理管理资源，只需要在构建`BucketManager`的时候设置`$proxy`和`$proxy_user_password`即可。\n\n \n \n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config, 'http://127.0.0.1:8118', null, '<username>:<password>'); // 设置 HTTP 代理\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config, 'socks4://127.0.0.1:1080', null, '<username>:<password>'); // 设置 SOCKS4 代理\n $bucketManager = new \\Qiniu\\Storage\\BucketManager($auth, $config, 'socks5://127.0.0.1:1080', null, '<username>:<password>'); // 设置 SOCKS5 代理\n \n\n# 持久化数据处理\n\n## 发送数据处理请求\n\n对于已经保存到空间的文件，可以通过发送持久化的数据处理指令来进行处理，这些指令支持七牛官方提供的指令，也包括客户自己开发的自定义数据处理的指令。数据处理的结果还可以通过七牛主动通知的方式告知业务服务器。\n\n \n \n use Qiniu\\Auth;\n use Qiniu\\Processing\\PersistentFop;\n \n //对已经上传到存储的视频发起异步转码操作\n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n $bucket = getenv('QINIU_TEST_BUCKET');\n \n $auth = new Auth($accessKey, $secretKey);\n \n //要转码的文件所在的空间和文件名。\n $key = 'qiniu.mp4';\n \n //转码是使用的队列名称。 https://portal.qiniu.com/mps/pipeline\n $pipeline = 'sdktest';\n $force = false;\n \n //转码完成后通知到你的业务服务器。\n $notifyUrl = 'http://375dec79.ngrok.com/notify.php';\n $config = new \\Qiniu\\Config();\n //$config->useHTTPS=true;\n \n $pfop = new PersistentFop($auth, $config);\n \n //要进行转码的转码操作。 http://developer.qiniu.com/docs/v6/api/reference/fop/av/avthumb.html\n $fops = \"avthumb/mp4/s/640x360/vb/1.4m|saveas/\" . \\Qiniu\\base64_urlSafeEncode($bucket . \":qiniu_640x360.mp4\");\n \n list($id, $err) = $pfop->execute($bucket, $key, $fops, $pipeline, $notifyUrl, $force);\n echo \"\\n====> pfop avthumb result: \\n\";\n if ($err != null) {\n var_dump($err);\n } else {\n echo \"PersistentFop Id: $id\\n\";\n }\n \n //查询转码的进度和状态\n list($ret, $err) = $pfop->status($id);\n echo \"\\n====> pfop avthumb status: \\n\";\n if ($err != null) {\n var_dump($err);\n } else {\n var_dump($ret);\n }\n \n \n \n\n# CDN相关功能\n\n * 文件刷新\n * 目录刷新\n * 文件预取操作\n * 获取域名流量\n * 获取域名带宽\n * 获取日志下载链接\n * 构建时间戳防盗链访问链接\n\n## 文件刷新\n\n \n \n use \\Qiniu\\Cdn\\CdnManager;\n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n \n $auth = new Qiniu\\Auth($accessKey, $secretKey);\n \n //待刷新的文件列表和目录，文件列表最多一次100个，目录最多一次10个\n //参考文档：http://developer.qiniu.com/article/fusion/api/refresh.html\n $urls = array(\n \"http://phpsdk.qiniudn.com/qiniu.jpg\",\n \"http://phpsdk.qiniudn.com/qiniu2.jpg\",\n );\n \n //刷新目录需要联系七牛技术支持开通账户权限\n $dirs = array(\n \"http://phpsdk.qiniudn.com/test/\"\n );\n \n $cdnManager = new CdnManager($auth);\n \n // 目前客户默认没有目录刷新权限，刷新会有400038报错，参考：https://developer.qiniu.com/fusion/api/1229/cache-refresh\n // 需要刷新目录请工单联系技术支持 https://support.qiniu.com/tickets/category\n list($refreshResult, $refreshErr) = $cdnManager->refreshUrlsAndDirs($urls, $dirs);\n if ($refreshErr != null) {\n var_dump($refreshErr);\n } else {\n echo \"refresh request sent\\n\";\n print_r($refreshResult);\n }\n \n //如果只有刷新链接或者目录的需求，可以分布使用\n \n list($refreshResult, $refreshErr) = $cdnManager->refreshUrls($urls);\n if ($refreshErr != null) {\n var_dump($refreshErr);\n } else {\n echo \"refresh request sent\\n\";\n print_r($refreshResult);\n }\n \n list($refreshResult, $refreshErr) = $cdnManager->refreshDirs($dirs);\n if ($refreshErr != null) {\n var_dump($refreshErr);\n } else {\n echo \"refresh request sent\\n\";\n print_r($refreshResult);\n }\n \n \n\n## 文件预取\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n \n $auth = new Qiniu\\Auth($accessKey, $secretKey);\n \n //待预取的文件列表，文件列表最多一次100个，目录最多一次10个\n //参考文档：http://developer.qiniu.com/article/fusion/api/prefetch.html\n $urls = array(\n \"http://phpsdk.qiniudn.com/qiniu.jpg\",\n \"http://phpsdk.qiniudn.com/qiniu2.jpg\",\n );\n \n $cdnManager = new CdnManager($auth);\n \n list($refreshResult, $refreshErr) = $cdnManager->prefetchUrls($urls);\n if ($prefetchErr != null) {\n var_dump($prefetchErr);\n } else {\n echo \"prefetch request sent\\n\";\n print_r($prefetchResult);\n }\n \n\n## 获取域名流量\n\n具体获取域名流量带宽参数详解可以参考 [流量带宽](https://developer.qiniu.com/fusion/api/1230/traffic-\nbandwidth)\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n \n $auth = new Qiniu\\Auth($accessKey, $secretKey);\n $cdnManager = new CdnManager($auth);\n \n //参考文档：http://developer.qiniu.com/article/fusion/api/traffic-bandwidth.html\n \n $domains = array(\n \"javasdk.qiniudn.com\",\n \"phpsdk.qiniudn.com\"\n );\n \n $startDate = \"2017-08-20\";\n $endDate = \"2017-08-21\";\n \n //5min or hour or day\n $granularity = \"day\";\n \n \n\n## 获取域名带宽\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n \n $auth = new Qiniu\\Auth($accessKey, $secretKey);\n $cdnManager = new CdnManager($auth);\n \n //获取带宽数据\n list($bandwidthData, $getBandwidthErr) = $cdnManager->getBandwidthData(\n $domains,\n $startDate,\n $endDate,\n $granularity\n );\n \n if ($getBandwidthErr != null) {\n var_dump($getBandwidthErr);\n } else {\n echo \"get bandwidth data success\\n\";\n print_r($bandwidthData);\n }\n \n \n\n## 获取日志下载链接\n\n具体日志下载链接参数详解可以参考 [日志下载](https://developer.qiniu.com/fusion/api/1226/download-\nthe-log)\n\n \n \n $accessKey = getenv('QINIU_ACCESS_KEY');\n $secretKey = getenv('QINIU_SECRET_KEY');\n \n $auth = new Qiniu\\Auth($accessKey, $secretKey);\n $cdnManager = new CdnManager($auth);\n \n $domains = array(\n \"javasdk.qiniudn.com\",\n \"phpsdk.qiniudn.com\"\n );\n \n $logDate = '2017-08-20';\n \n //获取日志下载链接\n //参考文档：http://developer.qiniu.com/article/fusion/api/log.html\n \n list($logListData, $getLogErr) = $cdnManager->getCdnLogList($domains, $logDate);\n if ($getLogErr != null) {\n var_dump($getLogErr);\n } else {\n echo \"get cdn log list success\\n\";\n print_r($logListData);\n }\n \n \n \n\n## 构建时间戳防盗链访问链接\n\n具体算法可以参考：[时间戳防盗链](https://developer.qiniu.com/fusion/kb/timestamp-hotlinking-\nprevention)\n\n \n \n use \\Qiniu\\Cdn\\CdnManager;\n \n //创建时间戳防盗链\n //时间戳防盗链密钥，后台获取\n $encryptKey = 'your_domain_timestamp_antileech_encryptkey';\n \n //带访问协议的域名\n $url1 = 'http://phpsdk.qiniuts.com/24.jpg?avinfo';\n $url2 = 'http://phpsdk.qiniuts.com/24.jpg';\n \n //有效期时间（单位秒）\n $durationInSeconds = 3600;\n \n $signedUrl = CdnManager::createTimestampAntiLeechUrl($url1, $encryptKey, $durationInSeconds);\n print($signedUrl);\n \n \n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n * [融合CDN API 参考](https://developer.qiniu.com/fusion)\n * [官方数据处理 API 参考](https://developer.qiniu.com/dora)\n\n# 常见问题\n\n * PHP-SDK的callback保留了请求的错误信息，回复信息和头部信息，遇到问题时，可以都打印出来提交给我们排查问题。\n * API 的使用，可以参考我们为大家精心准备的[使用实例 __](https://github.com/qiniu/php-sdk/tree/master/examples)。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](https://support.qiniu.com/tickets/new)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储PHP SDK历史文档"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > [PHP\nSDK](https://developer.qiniu.com/kodo/sdk/1241/php) > PHP SDK历史文档\n\n# PHP SDK历史文档\n\n最近更新时间: 2017-01-23 10:32:48\n\n此 SDK 适用于 PHP 5.1.0 及其以上版本。\n\nSDK源码地址：<https://github.com/qiniu/php-sdk/tags>\n\n# 安装\n\n**获取Access Key 和 Secret Key**\n\n要接入七牛云存储，您需要拥有一对有效的 Access Key 和 Secret Key 用来进行签名认证。可以通过如下步骤获得：\n\n 1. [开通七牛开发者帐号](https://portal.qiniu.com/signup)\n 2. 登录七牛开发者自助平台，查看 [Access Key 和 Secret Key](https://portal.qiniu.com/user/key)\n\n# 空间资源管理\n\n## 查看单个文件属性信息\n\n示例代码如下：\n\n \n \n require_once(\"qiniu/rs.php\");\n \n $bucket = \"phpsdk\";\n $key = \"pic.jpg\";\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \t\n Qiniu_SetKeys($accessKey, $secretKey);\n $client = new Qiniu_MacHttpClient(null);\n \n list($ret, $err) = Qiniu_RS_Stat($client, $bucket, $key);\n echo \"Qiniu_RS_Stat result: \\n\";\n if ($err !== null) {\n \tvar_dump($err);\n } else {\n \tvar_dump($ret);\n }\n \n\n## 复制单个文件\n\n示例代码如下：\n\n \n \n require_once(\"qiniu/rs.php\");\n \n $bucket = \"phpsdk\";\n $key = \"pic.jpg\";\n $key1 = \"file_name1\";\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \t\n Qiniu_SetKeys($accessKey, $secretKey);\n $client = new Qiniu_MacHttpClient(null);\n \t\n $err = Qiniu_RS_Copy($client, $bucket, $key, $bucket, $key1);\n echo \"====> Qiniu_RS_Copy result: \\n\";\n if ($err !== null) {\n \tvar_dump($err);\n } else {\n \techo \"Success!\";\n }\n \n\n## 移动单个文件\n\n示例代码如下：\n\n \n \n require_once(\"qiniu/rs.php\");\n \n $bucket = \"phpsdk\";\n $key = \"pic.jpg\";\n $key1 = \"file_name1\";\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \t\n Qiniu_SetKeys($accessKey, $secretKey);\n $client = new Qiniu_MacHttpClient(null);\n \t\n $err = Qiniu_RS_Move($client, $bucket, $key, $bucket, $key1);\n echo \"====> Qiniu_RS_Move result: \\n\";\n if ($err !== null) {\n \tvar_dump($err);\n } else {\n \techo \"Success!\";\n }\n \n\n## 删除单个文件\n\n示例代码如下：\n\n \n \n require_once(\"qiniu/rs.php\");\n \n $bucket = \"phpsdk\";\n $key1 = \"file_name1\";\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \n Qiniu_SetKeys($accessKey, $secretKey);\n $client = new Qiniu_MacHttpClient(null);\n \n $err = Qiniu_RS_Delete($client, $bucket, $key1);\n echo \"====> Qiniu_RS_Delete result: \\n\";\n if ($err !== null) {\n var_dump($err);\n } else {\n echo \"Success!\";\n }\n \n\n# 上传下载接口\n\n## 文件上传\n\n为了尽可能地改善终端用户的上传体验，七牛云存储首创了客户端直传功能。一般云存储的上传流程是：\n\n \n \n 客户端（终端用户） => 业务服务器 => 云存储服务\n \n\n这样多了一次上传的流程，和本地存储相比，会相对慢一些。但七牛引入了客户端直传，将整个上传过程调整为：\n\n \n \n 客户端（终端用户） => 七牛 => 业务服务器\n \n\n客户端（终端用户）直接上传到七牛的服务器，通过DNS智能解析，七牛会选择到离终端用户最近的ISP服务商节点，速度会比本地存储快很多。文件上传成功以后，七牛的服务器使用回调功能，只需要将非常少的数据（比如Key）传给应用服务器，应用服务器进行保存即可。\n\n**上传流程**\n\n在七牛云存储中，整个上传流程大体分为这样几步：\n\n 1. 业务服务器颁发上传凭证给客户端（终端用户）\n 2. 客户端凭借上传凭证上传文件到七牛\n 3. 在七牛获得完整数据后，发起一个 HTTP 请求回调到业务服务器\n 4. 业务服务器保存相关信息，并返回一些信息给七牛\n 5. 七牛原封不动地将这些信息转发给客户端（终端用户）\n\n**注意：** 回调到业务服务器的过程是可选的，它取决于业务服务器颁发的上传凭证。\n\n如果没有回调，七牛会返回一些标准的信息（比如文件的 hash）给客户端。如果上传发生在业务服务器，以上流程可以自然简化为：\n\n 1. 业务服务器生成 uptoken（不设置回调，自己回调到自己这里没有意义）\n 2. 凭借上传凭证上传文件到七牛\n 3. 善后工作，比如保存相关的一些信息\n\n服务端生成 上传凭证代码如下：\n\n \n \n require_once(\"qiniu/rs.php\");\n \n $bucket = 'phpsdk';\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \n Qiniu_SetKeys($accessKey, $secretKey);\n $putPolicy = new Qiniu_RS_PutPolicy($bucket);\n $upToken = $putPolicy->Token(null);\n \n\n上传文件到七牛（通常是客户端完成，但也可以发生在服务端）：\n\n**上传字符串**\n\n \n \n require_once(\"qiniu/io.php\");\n require_once(\"qiniu/rs.php\");\n \t\n $bucket = \"phpsdk\";\n $key1 = \"file_name1\";\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \t\n Qiniu_SetKeys($accessKey, $secretKey);\n $putPolicy = new Qiniu_RS_PutPolicy($bucket);\n $upToken = $putPolicy->Token(null);\n list($ret, $err) = Qiniu_Put($upToken, $key1, \"Qiniu Storage!\", null);\n echo \"====> Qiniu_Put result: \\n\";\n if ($err !== null) {\n \tvar_dump($err);\n } else {\n \tvar_dump($ret);\n }\n \n\n**上传本地文件**\n\n \n \n require_once(\"qiniu/io.php\");\n require_once(\"qiniu/rs.php\");\n \t\n $bucket = \"phpsdk\";\n $key1 = \"file_name1\";\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \t\n Qiniu_SetKeys($accessKey, $secretKey);\n $putPolicy = new Qiniu_RS_PutPolicy($bucket);\n $upToken = $putPolicy->Token(null);\n $putExtra = new Qiniu_PutExtra();\n $putExtra->Crc32 = 1;\n list($ret, $err) = Qiniu_PutFile($upToken, $key1, __file__, $putExtra);\n echo \"====> Qiniu_PutFile result: \\n\";\n if ($err !== null) {\n \tvar_dump($err);\n } else {\n \tvar_dump($ret);\n }\n \n\n## 上传策略\n\n上传凭证实际上是用 AccessKey/SecretKey\n进行数字签名的上传策略(`Qiniu_RS_PutPolicy`)，它控制则整个上传流程的行为。让我们快速过一遍你都能够决策啥：\n\n \n \n class Qiniu_RS_PutPolicy\n {\n \tpublic $Scope;\t\t\t\t// 必选项。可以是 bucketName 或者 bucketName:key\n \tpublic $CallbackUrl;\t\t// 可选\n \tpublic $CallbackBody;\t\t// 可选\n \tpublic $ReturnUrl;\t\t\t// 可选， 更贴切的名字是 redirectUrl。\n \tpublic $ReturnBody;\t\t\t// 可选\n \tpublic $AsyncOps;\t\t\t// 可选\n \tpublic $EndUser;\t\t\t// 可选\n \tpublic $Expires;\t\t\t// 可选。默认是 3600 秒\n \tpublic $PersistentOps;\t\t// 可选。\n \tpublic $PersistentNotifyUrl;\t// 如果设置了PersistentOps，必须同时设置此项。\n }\n \n\n * `scope` 限定客户端的权限。如果 `scope` 是 bucket，则客户端只能新增文件到指定的 bucket，不能修改文件。如果 `scope` 为 bucket:key，则客户端可以修改指定的文件。**注意： key必须采用utf8编码，如使用非utf8编码访问七牛云存储将反馈错误**\n * `callbackUrl` 设定业务服务器的回调地址，这样业务服务器才能感知到上传行为的发生。\n * `callbackBody` 设定业务服务器的回调信息。文件上传成功后，七牛向业务服务器的callbackUrl发送的POST请求携带的数据。支持 [魔法变量](https://developer.qiniu.com/kodo/manual/vars#magicvar) 和 [自定义变量](https://developer.qiniu.com/kodo/manual/vars#xvar)。\n * `returnUrl` 设置用于浏览器端文件上传成功后，浏览器执行303跳转的URL，一般为 HTML Form 上传时使用。文件上传成功后浏览器会自动跳转到 `returnUrl?upload_ret=returnBody`。\n * `returnBody` 可调整返回给客户端的数据包，支持魔法变量和自定义变量。`returnBody` 只在没有 `callbackUrl` 时有效（否则直接返回 `callbackUrl` 返回的结果）。不同情形下默认返回的 `returnBody` 并不相同。在一般情况下返回的是文件内容的 `hash`，也就是下载该文件时的 `etag`；但指定 `returnUrl` 时默认的 `returnBody` 会带上更多的信息。\n * `asyncOps` 可指定上传完成后，需要自动执行哪些数据处理。这是因为有些数据处理操作（比如音视频转码）比较慢，如果不进行预转可能第一次访问的时候效果不理想，预转可以很大程度改善这一点。 \n\n * `persistentOps` 可指定音视频文件上传完成后，需要进行的转码持久化操作。asyncOps的处理结果保存在缓存当中，有可能失效。而persistentOps的处理结果以文件形式保存在bucket中，体验更佳。\n * `persistentNotifyUrl` 音视频转码持久化完成后，七牛的服务器会向用户发送处理结果通知。这里指定的url就是用于接收通知的接口。设置了`persistentOps`,则需要同时设置此字段。\n\n关于上传策略更完整的说明，请参考上传凭证。\n\n## 文件下载\n\n七牛云存储上的资源下载分为 公有资源下载 和 私有资源下载 。\n\n私有（private）是 Bucket（空间）的一个属性，一个私有 Bucket 中的资源为私有资源，私有资源不可匿名下载。\n\n新创建的空间（Bucket）缺省为私有，也可以将某个 Bucket 设为公有，公有 Bucket 中的资源为公有资源，公有资源可以匿名下载。\n\n**公有资源下载** 如果在给bucket绑定了域名的话，可以通过以下地址访问。\n\n \n \n [GET] http://<domain>/<key>\n \n\n示例代码：\n\n \n \n $key = 'pic.jpg';\n $domain = '7j1xlg.com2.z0.glb.qiniucdn.com';\n //$baseUrl 就是您要访问资源的地址\n $baseUrl = Qiniu_RS_MakeBaseUrl($domain, $key);\n \n\n其中<domain>是bucket所对应的域名。七牛云存储为每一个bucket提供一个默认域名。默认域名可以到[七牛开发者平台](https://portal.qiniu.com/)中，空间设置的域名设置一节查询。用户也可以将自有的域名绑定到bucket上，通过自有域名访问七牛云存储。\n\n**注意：** key必须采用utf8编码，如使用非utf8编码访问七牛云存储将反馈错误\n\n**私有资源下载** 私有资源必须通过临时下载授权凭证(downloadToken)下载，如下：\n\n \n \n [GET] http://<domain>/<key>?e=<deadline>&token=<downloadToken>\n \n\n**注意：** 尖括号不是必需，代表替换项。\n\n私有下载链接可以使用 SDK 提供的如下方法生成：\n\n \n \n require_once(\"qiniu/rs.php\");\n \n $key = 'pic.jpg';\n $domain = '7j1xlg.com2.z0.glb.qiniucdn.com';\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \n Qiniu_SetKeys($accessKey, $secretKey); \n $baseUrl = Qiniu_RS_MakeBaseUrl($domain, $key);\n $getPolicy = new Qiniu_RS_GetPolicy();\n $privateUrl = $getPolicy->MakeRequest($baseUrl, null);\n echo \"====> getPolicy result: \\n\";\n echo $privateUrl . \"\\n\";\n \n\n# 数据处理接口\n\n七牛支持在云端对图像, 视频, 音频等富媒体进行个性化处理\n\n## 图像\n\n**查看图像属性**\n\n \n \n require_once(\"qiniu/rs.php\");\n require_once(\"qiniu/fop.php\");\n \n $key = 'pic.jpg';\n $domain = '7j1xlg.com2.z0.glb.qiniucdn.com';\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \t\n Qiniu_SetKeys($accessKey, $secretKey);\t\n //生成baseUrl\n $baseUrl = Qiniu_RS_MakeBaseUrl($domain, $key);\n \n //生成fopUrl\n $imgInfo = new Qiniu_ImageInfo;\n $imgInfoUrl = $imgInfo->MakeRequest($baseUrl);\n \t\n //对fopUrl 进行签名，生成privateUrl。 公有bucket 此步可以省去。\n $getPolicy = new Qiniu_RS_GetPolicy();\n $imgInfoPrivateUrl = $getPolicy->MakeRequest($imgInfoUrl, null);\n echo \"====> imageInfo privateUrl: \\n\";\n echo $imgInfoPrivateUrl . \"\\n\";\n \n\n将`$imgInfoPrivateUrl`粘贴到浏览器地址栏中就可以查看该图像的信息了。\n\n**查看图片EXIF信息**\n\n \n \n require_once(\"qiniu/rs.php\");\n require_once(\"qiniu/fop.php\");\n \n $key = 'pic.jpg';\n $domain = '7j1xlg.com2.z0.glb.qiniucdn.com';\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \t\n Qiniu_SetKeys($accessKey, $secretKey);\t\n //生成baseUrl\n $baseUrl = Qiniu_RS_MakeBaseUrl($domain, $key);\n \t\n //生成fopUrl\n $imgExif = new Qiniu_Exif;\n $imgExifUrl = $imgExif->MakeRequest($baseUrl);\n \t\n //对fopUrl 进行签名，生成privateUrl。 公有bucket 此步可以省去。\n $getPolicy = new Qiniu_RS_GetPolicy();\n $imgExifPrivateUrl = $getPolicy->MakeRequest($imgExifUrl, null);\n echo \"====> imageView privateUrl: \\n\";\n echo $imgExifPrivateUrl . \"\\n\";\n \n\n**生成图片预览**\n\n \n \n require_once(\"qiniu/rs.php\");\n require_once(\"qiniu/fop.php\");\n \n $key = 'pic.jpg';\n $domain = '7j1xlg.com2.z0.glb.qiniucdn.com';\n $accessKey = '<YOUR_APP_ACCESS_KEY>';\n $secretKey = '<YOUR_APP_SECRET_KEY>';\n \t\n Qiniu_SetKeys($accessKey, $secretKey);\t\n //生成baseUrl\n $baseUrl = Qiniu_RS_MakeBaseUrl($domain, $key);\n \t\n //生成fopUrl\n $imgView = new Qiniu_ImageView;\n $imgView->Mode = 1;\n $imgView->Width = 60;\n $imgView->Height = 120;\n $imgViewUrl = $imgView->MakeRequest($baseUrl);\n \t\n //对fopUrl 进行签名，生成privateUrl。 公有bucket 此步可以省去。\n $getPolicy = new Qiniu_RS_GetPolicy();\n $imgViewPrivateUrl = $getPolicy->MakeRequest($imgViewUrl, null);\n echo \"====> imageView privateUrl: \\n\";\n echo $imgViewPrivateUrl . \"\\n\";\n \n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Python SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > Python SDK\n\n# Python SDK\n\n最近更新时间: 2024-01-02 10:58:07\n\n从 v5.0.0 版本开始，我们对 SDK 的内容进行了精简。所有管理操作，比如：创建/删除 bucket、为 bucket\n绑定域名、设置数据处理的样式分隔符、新增数据处理样式等都去除了，统一建议到[七牛开发者平台\n__](https://portal.qiniu.com/)来完成 。另外，此前服务端还有自己独有的上传 API，现在也推荐统一成基于客户端上传的工作方式。\n\n此 Python SDK 适用于 2.7 和 3.3及以上版本\n\n * [Python SDK 下载地址 __](https://github.com/qiniu/python-sdk/releases)\n * [Python SDK 源码地址 __](https://github.com/qiniu/python-sdk)\n\n# 安装\n\n * 直接安装:\n\n \n \n pip install qiniu\n 或\n easy_install qiniu\n \n\n * 源码安装：\n\n \n \n #从Python SDK 下载地址下载源码\n tar xvzf python-sdk-$VERSION.tar.gz\n cd python-sdk-$VERSION\n python setup.py install\n \n\n# 初始化\n\n在使用SDK 前，您需要一对有效的 AccessKey 和 SecretKey 签名授权。 \n可以通过如下步骤获得：\n\n 1. 点击[注册 __](https://portal.qiniu.com/signup)开通 七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n获取Access Key 和 Secret Key 后，调用如下两行代码进行初始化对接：\n\n \n \n from qiniu import Auth\n \n q = Auth(access_key, secret_key)\n \n\n \n# 上传相关 \\- 上传流程 \\- 上传带回调 \\- 上传并预持久化数据处理 \\- 生成上传token\n\n \n\n## 上传流程\n\n为了尽可能地改善终端用户的上传体验，七牛云存储首创了客户端直传功能。更多信息请参阅[业务流程](https://developer.qiniu.com/kodo/manual/1205/programming-\nmodel)。\n\nSDK 内置两种上传方式：表单上传和分片上传，并根据具体情况，内部做了自动切换。表单上传使用一个 HTTP POST\n请求完成文件的上传，因此比较适合较小的文件和较好的网络环境。相比而言，分片上传更能适应不稳定的网络环境，也比较适合上传比较大的文件（例如数百 MB\n或更大）。\n\n若需深入了解上传方式之间的区别，请参阅上传类型中\n[表单上传](https://developer.qiniu.com/kodo/manual/1272/form-upload) 、[分片上传 v1\n版](https://developer.qiniu.com/kodo/manual/1650/chunked-upload) 和 [分片上传 v2\n版](https://developer.qiniu.com/kodo/6364/multipartupload-interface) 接口说明。\n可以选择分片上传版本，推荐 `version = 'v2'`，表示 [分片上传 v2\n版](https://developer.qiniu.com/kodo/multipartupload)，默认 `version = 'v1'`，表示\n[分片上传 v1 版](https://developer.qiniu.com/kodo/chunked-upload)，兼容历史情况，详见\nput_file 或 put_stream 方法的 [API 文档 __](https://github.com/qiniu/python-\nsdk/blob/master/qiniu/services/storage/uploader.py)。\n\n上传代码：\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n \n from qiniu import Auth, put_file, etag\n import qiniu.config\n \n #需要填写你的 Access Key 和 Secret Key\n access_key = 'Access_Key'\n secret_key = 'Secret_Key'\n \n #构建鉴权对象\n q = Auth(access_key, secret_key)\n \n #要上传的空间\n bucket_name = 'Bucket_Name'\n \n #上传后保存的文件名\n key = 'my-python-logo.png'\n \n #生成上传 Token，可以指定过期时间等\n token = q.upload_token(bucket_name, key, 3600)\n \n #要上传文件的本地路径\n localfile = './sync/bbb.jpg'\n \n ret, info = put_file(token, key, localfile, version='v2') \n print(info)\n assert ret['key'] == key\n assert ret['hash'] == etag(localfile)\n \n\n \n\n## 上传&回调\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n \n from qiniu import Auth, put_file, etag\n import qiniu.config\n \n access_key = 'Access_Key'\n secret_key = 'Secret_Key'\n \n q = Auth(access_key, secret_key)\n \n bucket_name = 'Bucket_Name'\n \n key = 'my-python-logo.png'\n \n #上传文件到存储后， 存储服务将文件名和文件大小回调给业务服务器。\n policy={\n 'callbackUrl':'http://your.domain.com/callback.php',\n 'callbackBody':'filename=$(fname)&filesize=$(fsize)'\n }\n \n token = q.upload_token(bucket_name, key, 3600, policy)\n \n localfile = './sync/bbb.jpg'\n \n ret, info = put_file(token, key, localfile, version='v2') \n print(info)\n assert ret['key'] == key\n assert ret['hash'] == etag(localfile)\n \n \n\n \n\n## 上传&预转持续化\n\n以视频转码为例：\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n \n from qiniu import Auth, put_file, etag, urlsafe_base64_encode\n import qiniu.config\n \n access_key = 'Access_Key'\n secret_key = 'Secret_Key'\n \n q = Auth(access_key, secret_key)\n \n bucket_name = 'Bucket_Name'\n \n key = 'my-python-logo.png'\n \n #设置转码参数\n fops = 'avthumb/mp4/s/640x360/vb/1.25m'\n \n #转码是使用的队列名称\n pipeline = 'abc'\n \n #可以对转码后的文件进行使用saveas参数自定义命名，当然也可以不指定文件会默认命名并保存在当前空间\n saveas_key = urlsafe_base64_encode('目标Bucket_Name:自定义文件key')\n fops = fops+'|saveas/'+saveas_key\n \n #在上传策略中指定\n policy={\n 'persistentOps':fops,\n 'persistentPipeline':pipeline\n }\n \n token = q.upload_token(bucket_name, key, 3600, policy)\n \n localfile = './sync/bbb.jpg'\n \n ret, info = put_file(token, key, localfile, version='v2') \n print(info)\n assert ret['key'] == key\n assert ret['hash'] == etag(localfile)\n \n \n\n队列pipeline 请参阅[创建私有队列 __](https://portal.qiniu.com/dora/media-\ngate/pipeline)；转码操作 具体参数请参阅[音视频转码](https://developer.qiniu.com/dora/api/audio-\nand-video-transcoding-avthumb)；saveas\n请参阅[处理结果另存](https://developer.qiniu.com/dora/api/processing-results-save-\nsaveas)。\n\n**Tips** ：上面的Demo只是针对视频转码功能，如果您需要使用比如音视频切片、视频截图、视频拼接等功能只需要修改上面 fops 后面的参数即可，如：\n_fops = vframe/jpg/offset/1/w/480/h/360/rotate/90_ 就表示视频截图了。\n\n可以看到上传成功后的行为主要是由[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-\ntoken)中的 上传策略 来指定。其中 上传策略 可以指定的行为不止这些，具体请参阅\n[上传策略](https://developer.qiniu.com/kodo/manual/1206/put-policy) 。\n\n \n\n## 生成上传token\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n \n from qiniu import Auth\n \n #需要填写你的 Access Key 和 Secret Key\n access_key = ''\n secret_key = ''\n \n #构建鉴权对象\n q = Auth(access_key, secret_key)\n \n #要上传的空间\n bucket_name = ''\n \n #上传后保存的文件名\n key = ''\n \n #生成上传 Token，可以指定过期时间等\n \n # 上传策略示例\n # https://developer.qiniu.com/kodo/manual/1206/put-policy\n policy = {\n # 'callbackUrl':'https://requestb.in/1c7q2d31',\n # 'callbackBody':'filename=$(fname)&filesize=$(fsize)'\n # 'persistentOps':'imageView2/1/w/200/h/200'\n }\n \n #3600为token过期时间，秒为单位。3600等于一小时\n token = q.upload_token(bucket_name, key, 3600, policy)\n \n print(token)\n \n\n \n\n \n\n# 数据处理\n\n * 触发持久化操作 \n \n\n## 触发持久化操作\n\n以视频转码为例：\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n from qiniu import Auth, PersistentFop, build_op, op_save, urlsafe_base64_encode\n \n #对已经上传到存储的视频发起异步转码操作 \n access_key = 'Access_Key'\n secret_key = 'Secret_Key'\n q = Auth(access_key, secret_key)\n \n #要转码的文件所在的空间和文件名。\n bucket = 'Bucket_Name'\n key = '1.mp4'\n \n #转码是使用的队列名称。\n pipeline = 'mpsdemo'\n \n #要进行转码的转码操作。\n fops = 'avthumb/mp4/s/640x360/vb/1.25m'\n \n #可以对转码后的文件进行使用saveas参数自定义命名，当然也可以不指定文件会默认命名并保存在当前空间\n saveas_key = urlsafe_base64_encode('目标Bucket_Name:自定义文件key')\n fops = fops+'|saveas/'+saveas_key\n \n pfop = PersistentFop(q, bucket, pipeline)\n ops = []\n ops.append(fops)\n ret, info = pfop.execute(key, ops, 1)\n print(info)\n assert ret['persistentId'] is not None\n \n \n\n**Tips** ：上面的Demo只是针对视频转码功能，如果您需要使用比如音视频切片、视频截图、视频拼接等功能只需要修改上面 fops 后面的参数即可，如：\n_fops = vframe/jpg/offset/1/w/480/h/360/rotate/90_ 就表示视频截图了。\n\n但这个只是将转码这个耗时的操作提交到队列中，要想知道转码操作现在的状态， 需要根据返回的 persitentId 进行查询，[查询接口\n__](https://developer.qiniu.com/dora/manual/1294/persistent-processing-status-\nquery-prefop)。如果您不方便持续轮询每个异步处理的进度和状态，\n七牛可以异步处理完成后通知您们的业务服务器。这样就需要您在视频转码的例子中，初始化 PersistentFop 时添加上 notifyUrl ，\n来通知您们的业务服务器。\n\n \n\n# 下载相关\n\n * 生成时间戳防盗链\n * 私有空间下载文件 \n \n\n## 生成时间戳防盗链\n\n \n \n # -*- coding: utf-8 -*-\n \n \"\"\"\n 获取一个配置时间戳防盗链的url\n \"\"\"\n \n from qiniu.services.cdn.manager import create_timestamp_anti_leech_url\n import time\n \n host = 'http://a.example.com'\n \n # 配置时间戳时指定的key\n encrypt_key = ''\n \n # 资源路径\n file_name = 'a/b/c/example.jpeg'\n \n # 查询字符串,不需要加?\n query_string = ''\n \n # 截止日期的时间戳,秒为单位，3600为当前时间一小时之后过期\n deadline = int(time.time())+3600\n \n \n timestamp_url = create_timestamp_anti_leech_url(host, file_name, query_string, encrypt_key, deadline)\n \n print(timestamp_url)\n \n\n \n\n## 私有空间下载\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n import requests\n \n from qiniu import Auth\n \n access_key = 'AK'\n secret_key = 'SK'\n \n q = Auth(access_key, secret_key)\n \n #有两种方式构造base_url的形式\n base_url = 'http://%s/%s' % (bucket_domain, key)\n \n #或者直接输入url的方式下载\n base_url = 'http://domain/key'\n \n #可以设置token过期时间\n private_url = q.private_download_url(base_url, expires=3600)\n \n print(private_url)\n r = requests.get(private_url)\n assert r.status_code == 200\n \n\n \n\n# 资源管理\n\n资源管理包括的主要功能有：\n\n * 获取文件信息\n * 修改文件MimeType\n * 修改文件存储类型\n * 移动或重命名文件\n * 复制文件副本\n * 删除空间中的文件\n * 设置或更新文件生存时间\n * 获取指定前缀文件列表\n * 抓取网络资源到空间\n * 更新镜像存储空间中文件内容\n * 资源管理批量操作\n * 批量获取文件信息\n * 批量删除文件\n * 批量复制文件\n * 批量移动\n * 批量重命名 \n \n\n## 获取文件信息\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n from qiniu import Auth\n from qiniu import BucketManager\n \n access_key = 'Access_Key'\n secret_key = 'Secret_Key'\n \n #初始化Auth状态\n q = Auth(access_key, secret_key)\n \n #初始化BucketManager\n bucket = BucketManager(q)\n \n #你要测试的空间， 并且这个key在你空间中存在\n bucket_name = 'Bucket_Name'\n key = 'python-logo.png'\n \n #获取文件的状态信息\n ret, info = bucket.stat(bucket_name, key)\n print(info)\n assert 'hash' in ret\n \n\n \n\n## 获取指定前缀文件列表\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n from qiniu import Auth\n from qiniu import BucketManager\n \n access_key = '...'\n secret_key = '...'\n \n q = Auth(access_key, secret_key)\n bucket = BucketManager(q)\n \n bucket_name = 'Bucket_Name'\n # 前缀\n prefix = None\n # 列举条目\n limit = 10\n # 列举出除'/'的所有文件以及以'/'为分隔的所有前缀\n delimiter = None\n # 标记\n marker = None\n \n ret, eof, info = bucket.list(bucket_name, prefix, marker, limit, delimiter)\n \n print(info)\n \n assert len(ret.get('items')) is not None\n \n\n \n\n## 抓取网络资源到空间\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n \n from qiniu import Auth\n from qiniu import BucketManager\n \n access_key = '...'\n secret_key = '...'\n \n bucket_name = 'Bucket_Name'\n \n q = Auth(access_key, secret_key)\n \n bucket = BucketManager(q)\n \n url = 'http://7xr875.com1.z0.glb.clouddn.com/xxx.jpg'\n \n key = 'xxx.jpg'\n \n ret, info = bucket.fetch(url, bucket_name, key)\n print(info)\n assert ret['key'] == key\n \n\n \n\n## 抓取镜像源文件到空间\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n \n from qiniu import Auth\n from qiniu import BucketManager\n \n access_key = '...'\n secret_key = '...'\n \n \n bucket_name = 'Bucket_Name'\n \n q = Auth(access_key, secret_key)\n \n bucket = BucketManager(q)\n \n # 要拉取的文件名\n key = 'test.jpg'\n \n ret, info = bucket.prefetch(bucket_name, key)\n print(info)\n assert ret['key'] == key\n \n\n \n\n## 移动单个文件\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n from qiniu import Auth\n from qiniu import BucketManager\n \n access_key = 'Access_Key'\n secret_key = 'Secret_Key'\n \n #初始化Auth状态\n q = Auth(access_key, secret_key)\n \n #初始化BucketManager\n bucket = BucketManager(q)\n \n #你要测试的空间， 并且这个key在你空间中存在\n bucket_name = 'Bucket_Name'\n key = 'python-logo.png'\n \n #将文件从文件key 移动到文件key2，可以实现文件的重命名 可以在不同bucket移动\n key2 = 'python-logo2.png'\n \n ret, info = bucket.move(bucket_name, key, bucket_name, key2)\n print(info)\n assert ret == {}\n \n\n \n\n## 复制单个文件\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n from qiniu import Auth\n from qiniu import BucketManager\n \n access_key = 'Access_Key'\n secret_key = 'Secret_Key'\n \n #初始化Auth状态\n q = Auth(access_key, secret_key)\n \n #初始化BucketManager\n bucket = BucketManager(q)\n \n #你要测试的空间， 并且这个key在你空间中存在\n bucket_name = 'Bucket_Name'\n key = 'python-logo.png'\n \n #将文件从文件key 复制到文件key2。 可以在不同bucket复制\n key2 = 'python-logo2.png'\n \n ret, info = bucket.copy(bucket_name, key, bucket_name, key2)\n print(info)\n assert ret == {}\n \n\n \n\n## 删除单个文件\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n from qiniu import Auth\n from qiniu import BucketManager\n \n access_key = 'Access_Key'\n secret_key = 'Secret_Key'\n \n #初始化Auth状态\n q = Auth(access_key, secret_key)\n \n #初始化BucketManager\n bucket = BucketManager(q)\n \n #你要测试的空间， 并且这个key在你空间中存在\n bucket_name = 'Bucket_Name'\n key = 'python-logo.png'\n \n #删除bucket_name 中的文件 key\n ret, info = bucket.delete(bucket_name, key)\n print(info)\n assert ret == {}\n \n \n\n \n\n## 设置或更新文件生存时间\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n \n from qiniu import Auth\n from qiniu import BucketManager\n \n access_key = '...'\n secret_key = '...'\n \n #初始化Auth状态\n q = Auth(access_key, secret_key)\n \n #初始化BucketManager\n bucket = BucketManager(q)\n \n #你要测试的空间， 并且这个key在你空间中存在\n bucket_name = 'Bucket_Name'\n key = 'python-test.png'\n \n #您要更新的生命周期\n days = '5'\n \n ret, info = bucket.delete_after_days(bucket_name, key, days)\n print(info)\n \n\n \n\n## 修改文件存储类型\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n \n from qiniu import Auth\n from qiniu import BucketManager\n \n access_key = '...'\n secret_key = '...'\n \n q = Auth(access_key, secret_key)\n \n bucket = BucketManager(q)\n \n bucket_name = 'Bucket_Name'\n \n key = '...'\n \n ret, info = bucket.change_type(bucket_name, key, 1) # 0 是标准存储，1 表示低频存储，2 表示归档存储，3 表示深度归档存储，4 表示归档直读存储\n \n print(info)\n \n\n \n\n## 修改资源元信息\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n \n from qiniu import Auth\n from qiniu import BucketManager\n \n access_key = '...'\n secret_key = '...'\n \n q = Auth(access_key, secret_key)\n \n bucket = BucketManager(q)\n \n bucket_name = 'Bucket_Name'\n \n key = '...'\n \n # 将一个文件的元信息修改为jpg\n ret, info = bucket.change_mime(bucket_name, key, 'image/jpg')\n print(info)\n \n\n \n\n## 批量操作\n\n \n \n # -*- coding: utf-8 -*-\n # flake8: noqa\n \n from qiniu import Auth\n from qiniu import BucketManager,build_batch_rename\n from qiniu import build_batch_copy\n from qiniu import build_batch_move\n \n access_key = '...'\n secret_key = '...'\n \n # 初始化Auth状态\n q = Auth(access_key, secret_key)\n \n # 初始化BucketManager\n bucket = BucketManager(q)\n keys = {'123.jpg':'123.jpg'}\n \n # ops = build_batch_copy(bucket_name, keys, 'teest',force='true')\n # ops = build_batch_move(bucket_name, keys, 'teest', force='true')\n ops = build_batch_rename(bucket_name, keys,force='true')\n \n ret, info = bucket.batch(ops)\n print(ret)\n print(info)\n assert ret == {}\n \n \n\n \n\n## 批量查询文件信息\n\n \n \n # -*- coding: utf-8 -*-\n \"\"\"\n 批量查询文件信息\n \n https://developer.qiniu.com/kodo/api/1250/batch\n \"\"\"\n \n \n from qiniu import build_batch_stat, Auth, BucketManager\n \n access_key = ''\n \n secret_key = ''\n \n q = Auth(access_key, secret_key)\n \n bucket = BucketManager(q)\n \n bucket_name = ''\n \n # 需要查询的文件名\n keys = ['1.gif', '2.txt', '3.png', '4.html']\n \n ops = build_batch_stat(bucket_name, keys)\n ret, info = bucket.batch(ops)\n print(info)\n \n \n\n \n\n## 批量重命名文件\n\n \n \n # -*- coding: utf-8 -*-\n \"\"\"\n 批量重命名文件\n \n https://developer.qiniu.com/kodo/api/1250/batch\n \"\"\"\n \n \n from qiniu import build_batch_rename, Auth, BucketManager\n \n access_key = ''\n \n secret_key = ''\n \n \n q = Auth(access_key, secret_key)\n \n bucket = BucketManager(q)\n \n bucket_name = ''\n \n \n # force为true时强制同名覆盖, 字典的键为原文件，值为目标文件\n ops = build_batch_rename(bucket_name, {'src_key1': 'target_key1', 'src_key2': 'target_key2'}, force='true')\n ret, info = bucket.batch(ops)\n print(info)\n \n\n \n\n## 批量移动文件\n\n \n \n # -*- coding: utf-8 -*-\n \"\"\"\n 批量移动文件\n \n https://developer.qiniu.com/kodo/api/1250/batch\n \"\"\"\n \n \n from qiniu import build_batch_move, Auth, BucketManager\n \n access_key = ''\n \n secret_key = ''\n \n \n q = Auth(access_key, secret_key)\n \n bucket = BucketManager(q)\n \n src_bucket_name = ''\n \n target_bucket_name = ''\n \n # force为true时强制同名覆盖, 字典的键为原文件，值为目标文件\n ops = build_batch_move(src_bucket_name, {'src_key1': 'target_key1', 'src_key2': 'target_key2'}, target_bucket_name, force='true')\n ret, info = bucket.batch(ops)\n print(info)\n \n\n \n\n## 批量删除文件\n\n \n \n # -*- coding: utf-8 -*-\n \"\"\"\n 批量删除文件\n \n https://developer.qiniu.com/kodo/api/1250/batch\n \"\"\"\n \n \n from qiniu import build_batch_delete, Auth, BucketManager\n \n access_key = ''\n \n secret_key = ''\n \n q = Auth(access_key, secret_key)\n \n bucket = BucketManager(q)\n \n bucket_name = ''\n \n keys = ['1.gif', '2.txt', '3.png', '4.html']\n \n ops = build_batch_delete(bucket_name, keys)\n ret, info = bucket.batch(ops)\n print(info)\n \n\n \n\n## 批量复制文件\n\n \n \n # -*- coding: utf-8 -*-\n \"\"\"\n 批量拷贝文件\n \n https://developer.qiniu.com/kodo/api/1250/batch\n \"\"\"\n \n \n from qiniu import build_batch_copy, Auth, BucketManager\n \n access_key = ''\n \n secret_key = ''\n \n q = Auth(access_key, secret_key)\n \n bucket = BucketManager(q)\n \n src_bucket_name = ''\n \n target_bucket_name = ''\n \n # force为true时强制同名覆盖, 字典的键为原文件，值为目标文件\n ops = build_batch_copy(src_bucket_name, {'src_key1': 'target_key1', 'src_key2': 'target_key2'}, target_bucket_name, force='true')\n ret, info = bucket.batch(ops)\n print(info)\n \n\n# CDN相关\n\n * 文件刷新\n * 目录刷新\n * 文件预取操作\n * 获取日志文件链接\n * 获取指定时间段域名流量\n * 获取指定时间段域名带宽\n\n \n\n### 刷新节点资源\n\n \n \n # -*- coding: utf-8 -*-\n import qiniu\n from qiniu import CdnManager\n \n \n \n # 账户ak，sk\n access_key = '...'\n secret_key = '...'\n \n auth = qiniu.Auth(access_key=access_key, secret_key=secret_key)\n cdn_manager = CdnManager(auth)\n \n # 需要刷新的文件链接\n urls = [\n 'http://aaa.example.com/a.gif',\n 'http://bbb.example.com/b.jpg'\n ]\n \n # 刷新链接\n refresh_url_result = cdn_manager.refresh_urls(urls)\n print(refresh_url_result)\n \n\n \n\n### 刷新整个目录下的节点资源\n\n \n \n # -*- coding: utf-8 -*-\n import qiniu\n from qiniu import CdnManager\n \n \n \n # 账户ak，sk\n access_key = '...'\n secret_key = '...'\n \n auth = qiniu.Auth(access_key=access_key, secret_key=secret_key)\n cdn_manager = CdnManager(auth)\n \n # 需要刷新的目录链接\n dirs = [\n 'http://aaa.example.com/doc/img/',\n 'http://bbb.example.com/doc/video/'\n ]\n \n # 刷新链接\n refresh_dir_result = cdn_manager.refresh_dirs(dirs)\n \n\n \n\n### 预取资源到cdn结点\n\n \n \n # -*- coding: utf-8 -*-\n \"\"\"\n 预取资源到cdn节点\n \n https://developer.qiniu.com/fusion/api/1227/file-prefetching\n \"\"\"\n \n import qiniu\n from qiniu import CdnManager\n \n \n # 账户ak，sk\n access_key = '...'\n secret_key = '...'\n \n auth = qiniu.Auth(access_key=access_key, secret_key=secret_key)\n cdn_manager = CdnManager(auth)\n \n # 需要刷新的文件链接\n urls = [\n 'http://aaa.example.com/doc/img/',\n 'http://bbb.example.com/doc/video/'\n ]\n \n # 刷新链接\n refresh_dir_result = cdn_manager.prefetch_urls(urls)\n \n\n \n\n### 获取指定域名指定时间内的日志链接\n\n \n \n # -*- coding: utf-8 -*-\n \"\"\"\n 获取指定域名指定时间内的日志链接\n \"\"\"\n import qiniu\n from qiniu import CdnManager\n \n \n # 账户ak，sk\n access_key = ''\n secret_key = ''\n \n auth = qiniu.Auth(access_key=access_key, secret_key=secret_key)\n cdn_manager = CdnManager(auth)\n \n log_date = '2017-07-20'\n \n urls = [\n 'a.example.com',\n 'b.example.com'\n ]\n ret, info = cdn_manager.get_log_list_data(urls, log_date)\n \n print(ret)\n print(info)\n \n\n \n\n## 获取指定域名指定时间段内的流量\n\n \n \n # -*- coding: utf-8 -*-\n \n import qiniu\n from qiniu import CdnManager\n \n \n # 账户ak，sk\n access_key = ''\n secret_key = ''\n \n auth = qiniu.Auth(access_key=access_key, secret_key=secret_key)\n cdn_manager = CdnManager(auth)\n \n startDate = '2017-07-20'\n \n endDate = '2017-08-20'\n \n granularity = 'day'\n \n urls = [\n 'a.example.com',\n 'b.example.com'\n ]\n \n # 获得指定域名流量\n ret, info = cdn_manager.get_flux_data(urls, startDate, endDate, granularity)\n \n print(ret)\n print(info)\n \n\n \n\n## 获取指定域名指定时间段内的带宽\n\n \n \n # -*- coding: utf-8 -*-\n \n import qiniu\n from qiniu import CdnManager\n \n \n # 账户ak，sk\n access_key = ''\n secret_key = ''\n \n auth = qiniu.Auth(access_key=access_key, secret_key=secret_key)\n cdn_manager = CdnManager(auth)\n \n startDate = '2017-07-20'\n \n endDate = '2017-08-20'\n \n granularity = 'day'\n \n urls = [\n 'a.example.com',\n 'b.example.com'\n ]\n \n ret, info = cdn_manager.get_bandwidth_data(urls, startDate, endDate, granularity)\n \n print(ret)\n print(info)\n \n\n# API参考手册\n\n * [对象存储API参考手册](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n * [数据处理API参考手册](https://developer.qiniu.com/dora)\n\n# 常见问题\n\n * 第二个参数 info 保留了请求响应的信息，失败情况下 ret 为 none ，将 info 打印出来，提交给我们。\n * API 的使用 demo 可以参考 [单元测试 __](https://github.com/qiniu/python-sdk/blob/master/test_qiniu.py)。\n * 如果碰到`ImportError: No module named requests.auth` 请安装 `requests` 。\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎到我们的技术论坛参与讨论。\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](https://support.qiniu.com/tickets/new)\\- 如果您的问题不适合在论坛讨论或得不到回答，您也可以提交一个工单，技术支持人员会尽快回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Ruby SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > Ruby SDK\n\n# Ruby SDK\n\n最近更新时间: 2023-04-04 11:42:05\n\n此 Ruby SDK 适用于 Ruby 2.1.x，2.2.x，2.3.x，JRuby 9.x 版本。\n\n * [Ruby SDK 下载地址 __](https://github.com/qiniu/ruby-sdk/releases)\n * [Ruby SDK 源码地址 __](https://github.com/qiniu/ruby-sdk)\n\n# 安装\n\n在您 Ruby 应用程序的 `Gemfile` 文件中，添加如下一行代码：\n\n \n \n gem 'qiniu', '~> 6.9.1'\n \n\n然后，在应用程序所在的目录下，运行 `bundle` 安装依赖包：\n\n \n \n $ bundle\n \n\n或者，可以使用 Ruby 的包管理器`gem`进行安装：\n\n \n \n $ gem install qiniu\n \n\n**初始化**\n\n在使用SDK 前，您需要一对有效的 AccessKey 和 SecretKey 签名授权。\n\n可以通过如下步骤获得：\n\n 1. 点击[注册 __](https://portal.qiniu.com/signup)开通 七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n**注意：**用户应当妥善保存 SecretKey ，一旦发生泄露，请立刻到开发者平台更新。\n\n在使用Ruby SDK之前，需要初始化环境，并且设置 AccessKey 和 SecretKey：\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n\n如果您使用的是 [Ruby on Rails\n__](http://rubyonrails.org/)框架，我们建议您在应用初始化启动的过程中，调用上述方法即可，操作如下：\n\n 1. 在应用初始化脚本加载的目录中新建一个文件： _YOUR_RAILS_APP/config/initializers/qiniu_sdk.rb_\n\n 2. 编辑 _YOUR_RAILS_APP/config/initializers/qiniu_sdk.rb_ 文件内容如下：\n\n \n \n require 'qiniu'\n \n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n\n这样，您就可以在您的 `RAILS_APP` 中使用七牛云存储 Ruby SDK 提供的其他任意方法了。\n\n# 文件上传\n\n## 上传流程\n\n为了尽可能地改善终端用户的上传体验，七牛云存储首创了客户端直传功能。更多信息请参阅[业务流程](https://developer.qiniu.com/kodo/manual/1205/programming-\nmodel)。\n\n**上传代码：**\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n # 构建鉴权对象\n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n # 要上传的空间\n bucket = 'Bucket_Name'\n \n # 上传后保存的文件名\n key = 'my-ruby-logo.png'\n \n # 构建上传策略，上传策略的更多参数请参照 http://developer.qiniu.com/article/developer/security/put-policy.html\n put_policy = Qiniu::Auth::PutPolicy.new(\n bucket, # 存储空间\n key, # 指定上传的资源名，如果传入 nil，就表示不指定资源名，将使用默认的资源名\n 3600 # token 过期时间，默认为 3600 秒，即 1 小时\n )\n \n # 生成上传 Token\n uptoken = Qiniu::Auth.generate_uptoken(put_policy)\n \n # 要上传文件的本地路径\n filePath = './ruby-logo.png'\n \n # 调用 upload_with_token_2 方法上传\n code, result, response_headers = Qiniu::Storage.upload_with_token_2(\n uptoken,\n filePath,\n key,\n nil, # 可以接受一个 Hash 作为自定义变量，请参照 http://developer.qiniu.com/article/kodo/kodo-developer/up/vars.html#xvar\n bucket: bucket\n )\n \n #打印上传返回的信息\n puts code\n puts result\n \n\n## 上传 & 回调\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n # 构建鉴权对象\n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n bucket = 'Bucket_Name'\n \n key = 'my-ruby-logo.png'\n \n put_policy = Qiniu::Auth::PutPolicy.new(\n bucket, # 存储空间\n key, # 指定上传的资源名，如果传入 nil，就表示不指定资源名，将使用默认的资源名\n 3600 # token 过期时间，默认为 3600 秒，即 1 小时\n )\n \n # 构建回调策略，这里上传文件后， 将文件名和文件大小回调给业务服务器.\n callback_url = 'http://your.domain.com/callback'\n callback_body = 'filename=$(fname)&filesize=$(fsize)' # 魔法变量的使用请参照 http://developer.qiniu.com/article/kodo/kodo-developer/up/vars.html#magicvar\n \n put_policy.callback_url= callback_url\n put_policy.callback_body= callback_body\n \n # 生成上传 Token\n uptoken = Qiniu::Auth.generate_uptoken(put_policy)\n \n # 要上传文件的本地路径\n filePath = './ruby-logo.png'\n \n # 调用 upload_with_token_2 方法上传\n code, result, response_headers = Qiniu::Storage.upload_with_token_2(\n uptoken,\n filePath,\n key,\n nil, # 可以接受一个 Hash 作为自定义变量，请参照 http://developer.qiniu.com/article/kodo/kodo-developer/up/vars.html#xvar\n bucket: bucket\n )\n \n #打印上传返回的信息\n puts code\n puts result\n \n \n\n## 上传 & 预转持续化\n\n以视频转码为例：\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n # 构建鉴权对象\n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n bucket = 'Bucket_Name'\n \n key = 'my-ruby-logo.png'\n \n put_policy = Qiniu::Auth::PutPolicy.new(\n bucket, # 存储空间\n key, # 指定上传的资源名，如果传入 nil，就表示不指定资源名，将使用默认的资源名\n 3600 # token 过期时间，默认为 3600 秒，即 1 小时\n )\n \n # 转码时使用的队列名称。\n pipeline = 'abc' # 设定自己账号下的队列名称\n \n # 要进行的转码操作。\n fops = \"avthumb/mp4/s/640x360/vb/1.25m\"\n \n # 可以对转码后的文件进行使用 saveas 参数自定义资源名，当然也可以不指定会默认命名并保存在上传文件所在的存储空间。\n saveas_key = Qiniu::Utils.urlsafe_base64_encode('<目标 Bucket_Name>:<自定义资源名>')\n fops = fops+'|saveas/'+saveas_key\n \n put_policy.persistent_ops = fops\n put_policy.persistent_pipeline = pipeline\n \n # 生成上传 Token\n uptoken = Qiniu::Auth.generate_uptoken(put_policy)\n \n # 要上传文件的本地路径\n filePath = './ruby-logo.png'\n \n # 调用upload_with_token_2方法上传\n code, result, response_headers = Qiniu::Storage.upload_with_token_2(\n uptoken,\n filePath,\n key,\n nil, # 可以接受一个 Hash 作为自定义变量，请参照 http://developer.qiniu.com/article/kodo/kodo-developer/up/vars.html#xvar\n bucket: bucket\n )\n \n #打印上传返回的信息\n puts code\n puts result\n \n\n队列 pipeline 请参阅[创建私有队列 __](https://portal.qiniu.com/dora/media-\ngate/pipeline)；转码操作 具体参数请参阅[音视频转码](https://developer.qiniu.com/dora/api/audio-\nand-video-transcoding-avthumb)；saveas\n请参阅[处理结果另存](https://developer.qiniu.com/dora/api/processing-results-save-\nsaveas)。\n\n**Tips：**上面的Demo只是针对视频转码功能，如果您需要使用比如音视频切片、视频截图、视频拼接等功能只需要修改上面 fops 后面的参数即可，如：\n_fops = “vframe/jpg/offset/1/w/480/h/360/rotate/90”_ 就表示视频截图了。\n\n可以看到上传成功后的行为主要是由[上传凭证](https://developer.qiniu.com/kodo/manual/1208/upload-\ntoken)中的 **上传策略** 来指定。其中 **上传策略** 可以指定的行为不止这些，具体请参阅\n[上传策略](https://developer.qiniu.com/kodo/manual/1206/put-policy) 。\n\n# 文件下载\n\n生成下载链接：\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n # 构建私有空间的链接\n primitive_url = 'http://domain/key'\n download_url = Qiniu::Auth.authorize_download_url(primitive_url)\n puts download_url\n \n\n# 空间资源管理\n\n## 获取文件信息\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n # 要测试的存储空间，并且这个资源名在存储空间中存在\n bucket = 'Bucket_Name'\n key = 'ruby-logo.png'\n \n # 获取文件信息\n code, result, response_headers = Qiniu::Storage.stat(\n bucket, # 存储空间\n key # 资源名\n )\n puts code\n puts result\n puts response_headers\n \n\n## 移动单个文件\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n # 要移动的存储空间，并且这个资源名在存储空间中存在\n bucket = 'Bucket_Name'\n key = 'ruby-logo.png'\n \n # 移动到的目标存储空间名和目标资源名\n dst_bucket = 'dst_bucket'\n dst_key = 'dst_key'\n \n # 移动文件\n code, result, response_headers = Qiniu::Storage.move(\n bucket, # 原存储空间\n key, # 原资源名\n dst_bucket, # 目标存储空间\n dst_key # 目标资源名\n )\n puts code\n puts result\n puts response_headers\n \n\n## 复制单个文件\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n # 要复制的存储空间，并且这个资源名在存储空间中存在\n bucket = 'Bucket_Name'\n key = 'ruby-logo.png'\n \n # 复制到的目标存储空间名和目标资源名\n dst_bucket = 'dst_bucket'\n dst_key = 'dst_key'\n \n # 复制文件\n code, result, response_headers = Qiniu::Storage.copy(\n bucket, # 原存储空间\n key, # 原资源名\n dst_bucket, # 目标存储空间\n dst_key # 目标资源名\n )\n puts code\n puts result\n puts response_headers\n \n \n\n## 删除单个文件\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n # 要删除的存储空间，并且这个资源名在存储空间中存在\n bucket = 'Bucket_Name'\n key = 'ruby-logo.png'\n \n # 删除资源\n code, result, response_headers = Qiniu::Storage.delete(\n bucket, # 存储空间\n key # 资源名\n )\n \n puts code\n puts result\n puts response_headers\n \n\n## 列举文件条目\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n # 要列举的存储空间名\n bucket = 'Bucket_Name'\n \n # 调用 list 接口，参数可以参考 http://developer.qiniu.com/code/v6/api/kodo-api/rs/list.html#list-specification\n code, result, response_headers, s, d = Qiniu::Storage.list(Qiniu::Storage::ListPolicy.new(\n bucket, # 存储空间\n 100, # 列举的条目数\n 'photo/', # 指定前缀\n '' # 指定目录分隔符\n ))\n \n # 打印出返回的状态码和信息\n puts code\n puts result\n puts response_headers\n \n\n## 抓取文件\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n # 需要抓取操作保存到的空间名\n bucket = 'Bucket_Name'\n \n # 抓取的 URL，需要外网可以访问到\n target_url = 'https://oerugfbxb.qnssl.com/wp-content/themes/Earthshaker-1/images/logo.png'\n \n # 抓取后保存的资源名\n key = 'qiniu.png'\n \n # 调用fetch方法\n code, result, response_headers = Qiniu::Storage.fetch(\n bucket,\n target_url,\n key\n )\n \n # 打印返回的状态码以及信息\n puts code\n puts result\n puts response_headers\n \n\n# 触发持久化操作\n\n以视频转码为例：\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n require 'qiniu/utils'\n \n # 构建鉴权对象\n Qiniu.establish_connection! access_key: '<YOUR_APP_ACCESS_KEY>',\n secret_key: '<YOUR_APP_SECRET_KEY>'\n \n # 要转码的文件所在的存储空间和资源名。\n bucket = 'Bucket_Name'\n key = '1.mp4'\n \n # 转码时使用的队列名称。\n pipeline = 'abc' # 设定自己账号下的队列名称\n \n # 要进行的转码操作。\n fops = \"avthumb/mp4/s/640x360/vb/1.25m\"\n \n # 可以对转码后的文件进行使用 saveas 参数自定义资源名，当然也可以不指定会默认命名并保存在原文件所在的存储空间。\n saveas_key = Qiniu::Utils.urlsafe_base64_encode('<目标 Bucket_Name>:<自定义资源名>')\n fops = fops+'|saveas/'+saveas_key\n \n pfops = Qiniu::Fop::Persistance::PfopPolicy.new(\n bucket, # 存储空间\n key, # 指定上传的资源名，如果传入 nil，就表示不指定资源名，将使用默认的资源名\n fops,\n 'http://www.baidu.com/notify' # 处理结果通知接收 URL\n )\n pfops.pipeline = pipeline\n \n code, result, response_headers = Qiniu::Fop::Persistance.pfop(pfops)\n puts code\n puts result\n puts response_headers\n \n\n**Tips：**上面的Demo只是针对视频转码功能，如果您需要使用比如音视频切片、视频截图、视频拼接等功能只需要修改上面 fops 后面的参数即可，如：\n_fops = “vframe/jpg/offset/1/w/480/h/360/rotate/90”_ 就表示视频截图了。\n\n但这个只是将转码这个耗时的操作提交到队列中，要想知道转码操作现在的状态，需要根据返回的 **persitentId**\n进行查询。如果您不方便持续轮询每个异步处理的进度和状态，七牛可以异步处理完成后通知您们的业务服务器。这样就需要您在视频转码的例子中, 初始化\n**PersistentFop** 时添加上 **notifyUrl** , 来通知您们的业务服务器。\n\n# 错误处理\n\n如果遇到错误，请将各个方法返回的 code、result、response_headers 以如下格式输出，并将输出结果 [提交工单\n__](https://support.qiniu.com/tickets/category)给我们 。\n\n \n \n #!/usr/bin/env ruby\n \n require 'qiniu'\n \n # 已在某处调用某个SDK方法\n \n puts code.inspect\n puts result.inspect\n puts response_headers.inspect\n \n\n# API参考手册\n\n * [对象存储API参考手册](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n * [数据处理API参考手册](https://developer.qiniu.com/dora)\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎到我们的技术论坛参与讨论。\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](https://support.qiniu.com/tickets/new)\\- 如果您的问题不适合在论坛讨论或得不到回答，您也可以提交一个工单，技术支持人员会尽快回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2014 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Rust SDK"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > SDK 下载 > Rust SDK\n\n# Rust SDK\n\n最近更新时间: 2022-09-30 16:42:29\n\n### Rust SDK 使用指南\n\nRust SDK 基于七牛云 API 参考手册构建。使用此 SDK\n构建您的网络应用程序，能让您以非常便捷地方式将数据安全地存储到七牛云上。无论您的网络应用是一个网站程序，还是包括从云端（服务端程序）到终端（手持设备应用）的架构的服务或应用，通过七牛云存储及其\nSDK，都能让您应用程序的终端用户高速上传和下载，同时也让您的服务端更加轻盈。\n\nRust SDK 属于服务端 SDK 之一，包含以下特性：\n\n * 通过提供多个不同的 Crate，为不同层次的开发都提供了方便易用的编程接口。\n * 同时提供阻塞 IO 接口和基于 Async/Await 的异步 IO 接口。\n * 提供大量的可供二次开发的 Trait，方便灵活定制，例如 HTTP 客户端提供了 `ureq`，`reqwest` 和 `isahc` 三种不同的库实现，也可以基于 `qiniu-http` 自行定制开发接入其他 HTTP 客户端实现；又例如 DNS 客户端提供了 `libc`，`c-ares`，`trust-dns` 三种不同的库实现，也可以基于 [Resolver __](https://docs.rs/qiniu-http-client/latest/qiniu_http_client/trait.Resolver.html)自行定制开发接入其他 DNS 客户端实现。\n\n# 开源\n\n * [Rust SDK 项目地址 __](https://github.com/qiniu/rust-sdk)\n * [Rust SDK 发布地址 __](https://github.com/qiniu/rust-sdk/releases)\n\n# 安装\n\nQiniu SDK for Rust 包含以下 Crates:\n\nCrate 链接 | 文档 | 描述 \n---|---|--- \n[__](https://crates.io/crates/qiniu-etag)|\n[__](https://docs.rs/qiniu-etag)| Etag 算法库，实现七牛 Etag 算法 \n[__](https://crates.io/crates/qiniu-credential)|\n[__](https://docs.rs/qiniu-credential)| 七牛认证库，实现七牛认证接口以及签名相关算法 \n[__](https://crates.io/crates/qiniu-upload-token)|\n[__](https://docs.rs/qiniu-upload-token)|\n七牛上传凭证，实现七牛上传策略和上传凭证接口以及相关算法 \n[__](https://crates.io/crates/qiniu-http)|\n[__](https://docs.rs/qiniu-http)| 七牛客户端 HTTP 接口，为不同的 HTTP\n客户端实现提供相同的基础接口 \n[__](https://crates.io/crates/qiniu-ureq)|\n[__](https://docs.rs/qiniu-ureq)| 基于 [Ureq\n__](https://docs.rs/ureq)库实现七牛客户端 HTTP 接口，对于使用`qiniu-http-request`，`qiniu-\napis`，`qiniu-objects-manager` 或 `qiniu-upload-manager` 的用户，可以直接启用 `ureq`\n功能，将默认使用该 HTTP 客户端实现。需要注意的是，如果需要使用异步接口，则不能选择 `ureq` \n[__](https://crates.io/crates/qiniu-isahc)|\n[__](https://docs.rs/qiniu-isahc)| 基于 [Isahc\n__](https://docs.rs/isahc)库实现七牛客户端 HTTP 接口，对于使用`qiniu-http-request`，`qiniu-\napis`，`qiniu-objects-manager` 或 `qiniu-upload-manager` 的用户，可以直接启用 `isahc`\n功能，将默认使用该 HTTP 客户端实现 \n[__](https://crates.io/crates/qiniu-reqwest)|\n[__](https://docs.rs/qiniu-reqwest)| 基于 [Reqwest\n__](https://docs.rs/reqwest)库实现七牛客户端 HTTP 接口，对于使用`qiniu-http-request`，`qiniu-\napis`，`qiniu-objects-manager` 或 `qiniu-upload-manager` 的用户，可以直接启用 `reqwest`\n功能，将默认使用该 HTTP 客户端实现 \n[__](https://crates.io/crates/qiniu-http-client)|\n[__](https://docs.rs/qiniu-http-client)| 基于 [qiniu-http\n__](https://docs.rs/qiniu-http)提供具有重试功能的 HTTP 客户端 \n[__](https://crates.io/crates/qiniu-apis)|\n[__](https://docs.rs/qiniu-apis)| 实现七牛 API 调用客户端接口 \n[__](https://crates.io/crates/qiniu-objects-manager)|\n[__](https://docs.rs/qiniu-objects-manager)| 实现七牛对象相关管理接口，包含对象的列举和操作 \n[__](https://crates.io/crates/qiniu-upload-manager)|\n[__](https://docs.rs/qiniu-upload-manager)| 实现七牛对象上传功能 \n[__](https://crates.io/crates/qiniu-sdk)|\n[__](https://docs.rs/qiniu-sdk)| 七牛 SDK 入口 \n \n# 鉴权\n\nRust SDK 的所有的功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的`Access Key`和`Secret\nKey`，这对密钥可以通过如下步骤获得：\n\n 1. 点击[注册🔗 __](https://portal.qiniu.com/signup)开通 七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里🔗 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n以下所有代码示例都以 `qiniu-sdk` 作为入口。\n\n# 文件上传\n\n * 上传流程\n * 客户端上传凭证\n * 简单上传凭证\n * 覆盖上传凭证\n * 自定义上传回复凭证\n * 带回调业务服务器的凭证\n * 带自定义参数的凭证\n * 综合上传凭证\n * 服务器直传\n * 文件上传\n * 字节数组上传 / 数据流上传\n * 自定义参数上传\n\n### 上传流程\n\n文件上传分为客户端上传（主要是指网页端和移动端等面向终端用户的场景）和服务端上传两种场景，具体可以参考文档[业务流程](https://developer.qiniu.com/kodo/manual/1205/programming-\nmodel)。\n\n服务端 SDK 在上传方面主要提供两种功能，一种是生成客户端上传所需要的上传凭证，另外一种是直接上传文件到云端。\n\n### 客户端上传凭证（需要依赖 `qiniu-sdk` 启用 `upload-token` 功能）\n\n客户端（移动端或者 Web 端）上传文件的时候，需要从客户自己的业务服务器获取上传凭证，而这些上传凭证是通过服务端的 SDK\n来生成的，然后通过客户自己的业务 API 分发给客户端使用。根据上传的业务需求不同，Rust SDK支持丰富的上传凭证生成方式。\n\n#### 简单上传的凭证\n\n最简单的上传凭证只需要 `access key`，`secret key` 和 `bucket` 就可以，并指定上传凭证的有效期。\n\n \n \n use qiniu_sdk::upload_token::{UploadPolicy, credential::Credential, prelude::*};\n use std::time::Duration;\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let credential = Credential::new(access_key, secret_key);\n let upload_token = UploadPolicy::new_for_bucket(bucket_name, Duration::from_secs(3600))\n .build_token(credential, Default::default())?;\n println!(\"{}\", upload_token);\n \n\n#### 覆盖上传的凭证\n\n覆盖上传除了需要简单上传所需要的信息之外，还需要想进行覆盖的对象名称 `object\nname`，这个对象名称同时是客户端上传代码中指定的对象名称，两者必须一致。\n\n \n \n use qiniu_sdk::upload_token::{UploadPolicy, credential::Credential, prelude::*};\n use std::time::Duration;\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let upload_token = UploadPolicy::new_for_object(bucket_name, object_name, Duration::from_secs(3600))\n .build_token(credential, Default::default())?;\n println!(\"{}\", upload_token);\n \n\n#### 自定义上传回复的凭证\n\n默认情况下，文件上传到存储之后，在没有设置 `return_body` 或者`回调`相关的参数情况下，七牛返回给上传端的回复格式为 `hash` 和\n`key`，例如：\n\n \n \n {\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"key\":\"qiniu.jpg\"}\n \n\n有时候我们希望能自定义这个返回的 JSON 格式的内容，可以通过设置 `return_body` 参数来实现，在 `return_body`\n中，我们可以使用七牛支持的[魔法变量](https://developer.qiniu.com/kodo/manual/1235/vars#magicvar)和[自定义变量](https://developer.qiniu.com/kodo/manual/1235/vars#xvar)。\n\n \n \n use qiniu_sdk::upload_token::{UploadPolicy, credential::Credential, prelude::*};\n use std::time::Duration;\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let upload_token = UploadPolicy::new_for_object(bucket_name, object_name, Duration::from_secs(3600))\n .return_body(\"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"bucket\\\":\\\"$(bucket)\\\",\\\"fsize\\\":$(fsize)}\")\n .build_token(credential, Default::default())?;\n println!(\"{}\", upload_token);\n \n\n则文件上传到七牛之后，收到的回复内容如下：\n\n \n \n {\"key\":\"qiniu.jpg\",\"hash\":\"Ftgm-CkWePC9fzMBTRNmPMhGBcSV\",\"bucket\":\"if-bc\",\"fsize\":39335}\n \n\n#### 带回调业务服务器的凭证\n\n上面生成的自定义上传回复的上传凭证适用于上传端（无论是客户端还是服务端）和七牛服务器之间进行直接交互的情况下。在客户端上传的场景之下，有时候客户端需要在文件上传到七牛之后，从业务服务器获取相关的信息，这个时候就要用到七牛的上传回调及相关回调参数的设置。\n\n \n \n use qiniu_sdk::upload_token::{UploadPolicy, credential::Credential, prelude::*};\n use std::time::Duration;\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let upload_token = UploadPolicy::new_for_object(bucket_name, object_name, Duration::from_secs(3600))\n .callback(&[\"http://api.example.com/qiniu/upload/callback\"], \"\", \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"bucket\\\":\\\"$(bucket)\\\",\\\"fsize\\\":$(fsize)}\", \"application/json\")\n .build_token(credential, Default::default())?;\n println!(\"{}\", upload_token);\n \n\n在使用了上传回调的情况下，客户端收到的回复就是业务服务器响应七牛的 JSON 格式内容。 \n通常情况下，我们建议使用 `application/json` 格式来设置\n`callback_body`，保持数据格式的统一性。实际情况下，`callback_body` 也支持 `application/x-www-form-\nurlencoded` 格式来组织内容，这个主要看业务服务器在接收到 `callback_body` 的内容时如何解析。例如：\n\n \n \n use qiniu_sdk::upload_token::{UploadPolicy, credential::Credential, prelude::*};\n use std::time::Duration;\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let upload_token = UploadPolicy::new_for_object(bucket_name, object_name, Duration::from_secs(3600))\n .callback(&[\"http://api.example.com/qiniu/upload/callback\"], \"\", \"key=$(key)&hash=$(etag)&bucket=$(bucket)&fsize=$(fsize)\", \"\")\n .build_token(credential, Default::default())?;\n println!(\"{}\", upload_token);\n \n\n#### 带自定义参数的凭证\n\n存储服务支持客户端上传文件的时候定义一些自定义参数，这些参数可以在 `returnBody` 和 `callbackBody`\n里面和七牛内置支持的魔法变量（即系统变量）通过相同的方式来引用。这些自定义的参数名称必须以 `x:` 开头。例如客户端上传的时候指定了自定义的参数\n`x:user` 和 `x:age` 分别是 `String` 和 `usize` 类型。那么可以通过下面的方式引用：\n\n \n \n upload_policy_builder.return_body(\"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"bucket\\\":\\\"$(bucket)\\\",\\\"fsize\\\":$(fsize),\\\"user\\\":\\\"$(x:user)\\\",\\\"age\\\",$(x:age)}\");\n \n\n或者\n\n \n \n upload_policy_builder.callback(&[\"http://api.example.com/qiniu/upload/callback\"], \"\", \"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"bucket\\\":\\\"$(bucket)\\\",\\\"fsize\\\":$(fsize),\\\"user\\\":\\\"$(x:user)\\\",\\\"age\\\",$(x:age)}\", \"application/json\")\n \n\n#### 综合上传凭证\n\n上面的生成上传凭证的方法，都是通过设置[上传策略🔗](https://developer.qiniu.com/kodo/manual/1206/put-\npolicy)相关的参数来支持的，这些参数可以通过不同的组合方式来满足不同的业务需求，可以灵活地组织你所需要的上传凭证。\n\n### 服务端直传（需要依赖 `qiniu-sdk` 启用 `upload` 功能）\n\n服务端直传是指客户利用七牛服务端 SDK 从服务端直接上传文件到七牛云，交互的双方一般都在机房里面，所以服务端可以自己生成上传凭证，然后利用 SDK\n中的上传逻辑进行上传，最后从七牛云获取上传的结果，这个过程中由于双方都是业务服务器，所以很少利用到上传回调的功能，而是直接自定义 `return_body`\n来获取自定义的回复内容。\n\n#### 文件上传\n\n最简单的就是上传本地文件，直接指定文件的完整路径即可上传。\n\n \n \n use qiniu_sdk::upload::{\n apis::credential::Credential, AutoUploader, AutoUploaderObjectParams, UploadManager,\n UploadTokenSigner,\n };\n use std::{time::Duration};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let upload_manager = UploadManager::builder(UploadTokenSigner::new_credential_provider(\n credential,\n bucket_name,\n Duration::from_secs(3600),\n ))\n .build();\n let uploader: AutoUploader = upload_manager.auto_uploader();\n \n let params = AutoUploaderObjectParams::builder().object_name(object_name).file_name(object_name).build();\n uploader.upload_path(\"/home/qiniu/test.png\", params)?;\n \n\n在这个场景下，`AutoUploader`\n会自动根据文件尺寸判定是否启用断点续上传，如果文件较大，上传了一部分时因各种原因从而中断，再重新执行相同的代码时，SDK\n会尝试找到先前没有完成的上传任务，从而继续进行上传。\n\n#### 字节数组上传 / 数据流上传\n\n可以支持将内存中的字节数组或实现了 `std::io::Read` 的实例上传到空间中。\n\n \n \n use qiniu_sdk::upload::{\n apis::credential::Credential, AutoUploader, AutoUploaderObjectParams, UploadManager,\n UploadTokenSigner,\n };\n use std::{io::Cursor, time::Duration};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let upload_manager = UploadManager::builder(UploadTokenSigner::new_credential_provider(\n credential,\n bucket_name,\n Duration::from_secs(3600),\n ))\n .build();\n let uploader: AutoUploader = upload_manager.auto_uploader();\n \n let params = AutoUploaderObjectParams::builder().object_name(object_name).file_name(object_name).build();\n uploader.upload_reader(Cursor::new(\"hello qiniu cloud\"), params)?;\n \n\n#### 自定义参数上传\n\n \n \n use qiniu_sdk::upload::{\n apis::credential::Credential, AutoUploader, AutoUploaderObjectParams, UploadManager, UploadTokenSigner,\n };\n use std::{io::Cursor, time::Duration};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let upload_manager = UploadManager::builder(\n UploadTokenSigner::new_credential_provider_builder(credential, bucket_name, Duration::from_secs(3600))\n .on_policy_generated(|builder| {\n builder\n .return_body(\"{\\\"key\\\":\\\"$(key)\\\",\\\"hash\\\":\\\"$(etag)\\\",\\\"fname\\\":\\\"$(x:fname)\\\",\\\"age\\\",$(x:age)}\");\n })\n .build(),\n )\n .build();\n let uploader: AutoUploader = upload_manager.auto_uploader();\n \n let params = AutoUploaderObjectParams::builder()\n .object_name(object_name)\n .file_name(object_name)\n .insert_custom_var(\"fname\", \"123.jpg\")\n .insert_custom_var(\"age\", \"20\")\n .build();\n uploader.upload_path(\"/home/qiniu/test.mp4\", params)?;\n \n\n# 下载文件\n\n * 公开空间\n * 私有空间\n\n文件下载分为公开空间的文件下载和私有空间的文件下载。\n\n### 公开空间\n\n对于公开空间，其访问的链接主要是将空间绑定的域名拼接上空间里面的文件名即可访问，标准情况下需要在拼接链接之前，将文件名进行 `urlencode`\n以兼容不同的字符。如果有其他访问处理需求，在文件名之后继续拼接即可。这个过程实际上不需要使用七牛 SDK 也可以完成。\n\n \n \n use http::Uri;\n \n let object_name = \"公司/存储/qiniu.jpg\";\n let domain = \"devtools.qiniu.com\";\n let mut path = \"/\".to_string();\n url_escape::encode_path_to_string(object_name, &mut path);\n let url = Uri::builder()\n .scheme(\"http\")\n .authority(domain)\n .path_and_query(path)\n .build()?;\n println!(\"{}\", url);\n \n\n### 私有空间（需要依赖 `qiniu-sdk` 启用 `credential` 功能）\n\n对于私有空间，首先需要按照公开空间的文件访问方式构建对应的公开空间访问链接，然后再对这个链接进行私有授权签名。\n\n \n \n use qiniu_sdk::credential::Credential;\n use http::Uri;\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let object_name = \"公司/存储/qiniu.jpg\";\n let domain = \"devtools.qiniu.com\";\n let mut path = \"/\".to_string();\n url_escape::encode_path_to_string(object_name, &mut path);\n let url = Uri::builder()\n .scheme(\"http\")\n .authority(domain)\n .path_and_query(path)\n .build()?;\n let credential = Credential::new(access_key, secret_key);\n let url = credential.sign_download_url(url, Duration::from_secs(3600));\n println!(\"{}\", url);\n \n\n# 资源管理（需要依赖 `qiniu-sdk` 启用 `objects` 功能）\n\n资源管理包括的主要功能有：\n\n * 获取文件信息\n * 修改文件类型\n * 移动或重命名文件\n * 复制文件副本\n * 删除空间中的文件\n * 设置或更新文件生存时间\n * 获取空间文件列表\n * 资源管理批量操作\n * 批量获取文件信息\n * 批量修改文件类型\n * 批量删除文件\n * 批量移动或重命名文件\n * 批量复制文件\n * 批量解冻归档存储类型文件\n\n#### 获取文件信息\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n \n let response = bucket.stat_object(object_name).call()?;\n let entry = response.into_body();\n println!(\"{}\", entry.get_hash_as_str());\n println!(\"{}\", entry.get_size_as_u64());\n println!(\"{}\", entry.get_mime_type_as_str());\n println!(\"{}\", entry.get_put_time_as_u64());\n \n\n#### 修改文件类型\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n \n bucket\n .modify_object_metadata(object_name, mime::APPLICATION_JSON)\n .call()?;\n \n\n#### 移动或重命名文件\n\n移动操作本身支持移动文件到相同，不同空间中，在移动的同时也可以支持文件重命名。唯一的限制条件是，移动的源空间和目标空间必须在同一个机房。\n\n`move_object_to` 操作支持强制覆盖选项，即如果目标文件已存在，可以设置强制覆盖参数 `is_force(true)` 来覆盖那个文件的内容。\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let to_bucket_name = \"to bucket name\";\n let to_object_name = \"new object name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n \n bucket\n .move_object_to(object_name, to_bucket_name, to_object_name);\n .call()?;\n \n\n#### 复制文件副本\n\n文件的复制和文件移动其实操作一样，主要的区别是移动后源文件不存在了，而复制的结果是源文件还存在，只是多了一个新的文件副本。\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let to_bucket_name = \"to bucket name\";\n let to_object_name = \"new object name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n \n bucket\n .copy_object_to(object_name, to_bucket_name, to_object_name);\n .call()?;\n \n\n#### 删除空间中的文件\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n \n bucket\n .delete_object(object_name);\n .call()?;\n \n\n#### 设置或更新文件的生存时间\n\n可以给已经存在于空间中的文件设置文件生存时间，或者更新已设置了生存时间但尚未被删除的文件的新的生存时间。\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, AfterDays, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let object_name = \"object name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n \n bucket\n .modify_object_life_cycle(object_name)\n .delete_after_days(AfterDays::new(10)) // 过期天数，该文件将于 10 天后删除\n .call()?;\n \n\n#### 获取空间文件列表\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n \n let mut iter = bucket.list().iter();\n while let Some(entry) = iter.next() {\n let entry = entry?;\n println!(\n \"{}\\n hash: {}\\n size: {}\\n mime type: {}\",\n entry.get_key_as_str(),\n entry.get_hash_as_str(),\n entry.get_size_as_u64(),\n entry.get_mime_type_as_str(),\n );\n }\n \n\n## 资源管理批量操作\n\n#### 批量获取文件信息\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n let mut ops = bucket.batch_ops();\n ops.add_operation(bucket.stat_object(\"qiniu.jpg\"));\n ops.add_operation(bucket.stat_object(\"qiniu.mp4\"));\n ops.add_operation(bucket.stat_object(\"qiniu.png\"));\n \n let mut iter = ops.call();\n while let Some(result) = iter.next() {\n match result {\n Ok(entry) => {\n println!(\n \"hash: {:?}\\n size: {:?}\\n mime type: {:?}\",\n entry.get_hash_as_str(),\n entry.get_size_as_u64(),\n entry.get_mime_type_as_str(),\n );\n }\n Err(err) => {\n println!(\"{:?}\", err);\n }\n }\n }\n \n\n#### 批量修改文件类型\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n let mut ops = bucket.batch_ops();\n ops.add_operation(bucket.modify_object_metadata(\"qiniu.jpg\", mime::IMAGE_JPEG));\n ops.add_operation(bucket.modify_object_metadata(\"qiniu.png\", mime::IMAGE_PNG));\n ops.add_operation(bucket.modify_object_metadata(\"qiniu.mp4\", \"video/mp4\".parse()?));\n \n let mut iter = ops.call();\n while let Some(result) = iter.next() {\n match result {\n Ok(_) => {\n println!(\"Ok\");\n }\n Err(err) => {\n println!(\"{:?}\", err);\n }\n }\n }\n \n\n#### 批量删除文件\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n let mut ops = bucket.batch_ops();\n ops.add_operation(bucket.delete_object(\"qiniu.jpg\"));\n ops.add_operation(bucket.delete_object(\"qiniu.png\"));\n ops.add_operation(bucket.delete_object(\"qiniu.mp4\"));\n \n let mut iter = ops.call();\n while let Some(result) = iter.next() {\n match result {\n Ok(_) => {\n println!(\"Ok\");\n }\n Err(err) => {\n println!(\"{:?}\", err);\n }\n }\n }\n \n\n#### 批量移动或重命名文件\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n let mut ops = bucket.batch_ops();\n ops.add_operation(bucket.move_object_to(\"qiniu.jpg\", bucket_name, \"qiniu.jpg.move\"));\n ops.add_operation(bucket.move_object_to(\"qiniu.png\", bucket_name, \"qiniu.png.move\"));\n ops.add_operation(bucket.move_object_to(\"qiniu.mp4\", bucket_name, \"qiniu.mp4.move\"));\n \n let mut iter = ops.call();\n while let Some(result) = iter.next() {\n match result {\n Ok(_) => {\n println!(\"Ok\");\n }\n Err(err) => {\n println!(\"{:?}\", err);\n }\n }\n }\n \n\n#### 批量复制文件\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n let mut ops = bucket.batch_ops();\n ops.add_operation(bucket.copy_object_to(\"qiniu.jpg\", bucket_name, \"qiniu.jpg.move\"));\n ops.add_operation(bucket.copy_object_to(\"qiniu.png\", bucket_name, \"qiniu.png.move\"));\n ops.add_operation(bucket.copy_object_to(\"qiniu.mp4\", bucket_name, \"qiniu.mp4.move\"));\n \n let mut iter = ops.call();\n while let Some(result) = iter.next() {\n match result {\n Ok(_) => {\n println!(\"Ok\");\n }\n Err(err) => {\n println!(\"{:?}\", err);\n }\n }\n }\n \n\n#### 批量解冻归档存储类型文件\n\n \n \n use qiniu_sdk::objects::{apis::credential::Credential, ObjectsManager};\n \n let access_key = \"access key\";\n let secret_key = \"secret key\";\n let bucket_name = \"bucket name\";\n let credential = Credential::new(access_key, secret_key);\n let object_manager = ObjectsManager::builder(credential).build();\n let bucket = object_manager.bucket(bucket_name);\n let mut ops = bucket.batch_ops();\n ops.add_operation(bucket.restore_archived_object(\"qiniu.jpg\", 7));\n ops.add_operation(bucket.restore_archived_object(\"qiniu.png\", 7));\n ops.add_operation(bucket.restore_archived_object(\"qiniu.mp4\", 7));\n \n let mut iter = ops.call();\n while let Some(result) = iter.next() {\n match result {\n Ok(_) => {\n println!(\"Ok\");\n }\n Err(err) => {\n println!(\"{:?}\", err);\n }\n }\n }\n \n\n# API 参考\n\n * [存储 API 参考](https://developer.qiniu.com/kodo/api/3939/overview-of-the-api)\n\n# 最低支持的 Rust 版本（MSRV）\n\n * 1.60.0 Stable\n\n# 相关资源\n\n如果您有任何关于我们文档或产品的建议和想法，欢迎您通过以下方式与我们互动讨论：\n\n * [技术论坛 __](http://segmentfault.com/qiniu)\\- 在这里您可以和其他开发者愉快的讨论如何更好的使用七牛云服务\n * [提交工单 __](https://support.qiniu.com/tickets/new)\\- 如果您的问题不适合在论坛讨论或希望及时解决，您也可以提交一个工单，我们的技术支持人员会第一时间回复您\n * [博客 __](http://blog.qiniu.com)\\- 这里会持续更新发布市场活动和技术分享文章\n * [微博 __](http://weibo.com/qiniutek)\n * [常见问题 __](https://support.qiniu.com/question)\n\n# 贡献代码\n\n 1. Fork\n\n 2. 创建您的特性分支 git checkout -b my-new-feature\n\n 3. 提交您的改动 git commit -am ‘Added some feature’\n\n 4. 将您的修改记录提交到远程 git 仓库 git push origin my-new-feature\n\n 5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request\n\n# 许可证\n\nCopyright © 2022 qiniu.com\n\n基于 MIT 协议发布:\n\n * [www.opensource.org/licenses/MIT __](http://www.opensource.org/licenses/MIT)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储图形化工具 Kodo Browser"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 实用工具 > 图形化工具 Kodo Browser\n\n# 图形化工具 Kodo Browser\n\n最近更新时间: 2024-06-28 18:52:05\n\nKodo Browser 是七牛对象存储提供的图形化管理工具，支持用户通过可视化页面进行上传、下载等操作。\n\nGithub [代码地址 __](https://github.com/qiniu/kodo-browser)\n\n# 下载\n\n支持平台 | 链接 \n---|--- \nWindows x86 | [下载 __](https://kodo-toolbox-new.qiniu.com/kodobrowser/client/kodo-browser-Windows-x86-v2.3.1.zip) \nWindows x64 | [下载 __](https://kodo-toolbox-new.qiniu.com/kodobrowser/client/kodo-browser-Windows-x64-v2.3.1.zip) \nMac OS | [下载 __](https://kodo-toolbox-new.qiniu.com/kodobrowser/client/kodo-browser-Mac%20OS-v2.3.1.zip) \nLinux x64 | [下载 __](https://kodo-toolbox-new.qiniu.com/kodobrowser/client/kodo-browser-Linux-x64-v2.3.1.zip) \n \n[查看更新日志/下载历史版本 __](https://github.com/qiniu/kodo-browser/releases)\n\n# 登录\n\n安装后，点击 Kodo Browser\n图标进入登录页面；默认是登录、管理公有云存储资源，Endpoint也可以选择「自定义（私有云）」，登录、管理私有云存储资源。\n\n\n\n * AccessKeyId/AccessKeySecret：通过[七牛控制台个人中心 __](https://portal.qiniu.com/user/key)获取 AK/SK\n\n登录私有云环境时，需要先在登录页面配置区域信息；Endpoint选择「自定义（私有云）」后，点击右侧设置图标即可打开配置页面\n\n\n\n * 自定义 Endpoint 未配置时，禁止登录私有云环境。支持开启区域设置，配置区域 Endpoint。\n * 自 1.0.10 版本开始，支持 IAM 用户登录使用 Kodo Browser。\n\n## **记住密钥**\n\n可以勾选「记住密钥」，记录登录成功的 AccessKeyId/AccessKeySecret 信息，以便于下一次的快速登录。\n\n**注意：请不要在临时使用的电脑上勾选记住密钥！**\n\n\n\n点击「AK 历史」，可以选择之前已验证通过的 AccessKeyId/AccessKeySecret 对来做登录。已添加的 AK 历史记录可以被删除。\n\n\n\n * 登录私有云环境时，需保证当前的私有云环境区域配置信息与 AccessKeyId/AccessKeySecret 相匹配。\n\n## **切换账号**\n\n客户端允许在不退出登录的情况下，直接切换账号。\n\n\n\n * 点击客户端右上角的账户小图标\n * 点击切换账号，在 AK 历史弹窗中选择要切换的 AK 点击「使用」\n * 客户端就会尝试以所选择的账号重新登录，并定位到首页展示\n\n## **使用分享链接登录**\n\n点击「使用分享链接登录」，支持使用 Kodo Browser 或 Kodo 控制台生成的目录分享链接和链接提取码登录、进而访问已授权文件列表。\n\n\n\n * 输入分享链接，支持由 Kodo Browser 或 Kodo 控制台获取目录分享链接\n * 输入提取码，为6位由数字或字母组成\n * 点击「登录」，即可查看被授权访问的文件列表\n\n# 功能说明\n\n## **Bucket 操作**\n\n自1.0.13 版本开始，客户端支持公有云的授权空间管理。\n\n### **创建 Bucket**\n\n * 在 Kodo browser 首页点击【新建 Bucket】\n * 输入 Bucket 信息 \n * 名称：由 3 ~ 63 个字符组成 ，可包含小写字母、数字和短划线，且必须以小写字母或者数字开头和结尾\n * 区域：选择 Bucket 所在区域\n * ACL 权限：暂不支持设置，默认创建公开 Bucket\n * 点击【确定】\n\n\n\n### **删除 Bucket**\n\n在 Bucket 列表中选中指定的 Bucket，点击【更多】-【删除】即可。\n\n\n\n### **编辑 Bucket 备注**\n\n在 Bucket 列表中选中指定的 Bucket，点击【更多】-【编辑备注】即可。\n\n\n\n## **Object 操作**\n\n\n\n### **创建目录**\n\n * 在 Bucket 列表中点击对应的 Bucket，进入 Bucket 内对象列表\n * 点击【创建目录】\n * 输入目录名称，点击【确定】\n\n\n\n### **上传文件/目录**\n\n * 在指定的 Bucket 或目录内，点击【上传】\n * 选择需要上传的文件或目录即可\n\n\n\n * 上传文件/目录，支持拖拽操作。**注意，Windows 系统下做目录上传时，需要采用拖拽操作。**\n * 上传文件时，可以指定要保存的存储类型。客户端默认禁止上传同名文件，但是可以在上传确认界面中开启「覆盖上传」，在本次上传中执行覆盖上传、变更同名文件。\n\n\n\n * 客户端默认允许上传空目录，但是可以在上传任务管理器中设置「是否允许空目录上传」；图标为蓝色时表示「允许空目录上传」。\n\n\n\n### **下载文件/目录**\n\n * 在指定的 Bucket 或目录内，选中需要下载的文件或目录\n * 点击【下载】，并选择下载目录即可\n * 如本地下载目录中包含同名文件，将会在原文件名后添加后缀保存\n\n\n\n * 客户端下载同名文件时，默认会在文件名最后添加数字编号；但是可以在上传任务管理器中设置「是否开启覆盖下载」模式，在下载同名文件时覆盖所选路径下已存在的文件；图标为蓝色时表示「开启覆盖下载」。\n\n\n\n * 客户端默认使用空间源站域名做文件预览和下载，也支持选用空间已绑定的cdn域名来预览和下载文件。\n\n\n\n**注意**\n\n默认不使用自有域名下载公有云存储的文件时，**会产生一定的外网流出流量** ，**可能会产生流量计费** 。 \n使用空间已绑定的cdn域名下载公有云存储的文件时，**则会产生CDN回源流量** 。\n\n### **复制文件/目录**\n\n * 在指定的 Bucket 或目录内，选中需要复制的文件或目录\n * 点击【复制】\n * 进入需要粘贴文件的 Bucket 或目录，点击【粘贴】\n\n\n\n * 当原 Bucket 与目标 Bucket 一致，需要重命名文件，否则会提示【已有同名文件，是否覆盖？】，此时可根据您的需求选择【确定】或【取消】\n * 当原 Bucket 与目标 Bucket 不一致，会覆盖目标 Bucket 中的同名原文件\n\n\n\n * 不支持跨区域复制\n\n### **移动文件/目录**\n\n * 在指定的 Bucket 或目录内，选中需要移动的文件或目录\n * 点击【更多】-【移动】\n * 进入需要粘贴文件的 Bucket 或目录，点击【粘贴】\n\n\n\n * 当原 Bucket 与目标 Bucket 一致，需要重命名文件，否则会提示【已有同名文件，是否覆盖？】，此时可根据您的需求选择【确定】或【取消】\n * 当原 Bucket 与目标 Bucket 不一致，会覆盖目标 Bucket 中的同名原文件\n\n\n\n * 不支持跨区域移动\n\n### **重命名文件/目录**\n\n * 在指定的 Bucket 或目录内，选中需要重命名的文件或目录\n * 点击【重命名】\n * 输入文件名称：禁止以 `/` 开头或结尾，禁止输入连续的 `/`。当文件名在 Bucket 中已存在，会提示【已有同名文件，是否覆盖？】，此时可根据您的需求选择【确定】或【取消】\n * 点击【确定】\n\n\n\n### **删除文件/目录**\n\n * 在指定的 Bucket 或目录内，选中需要删除的文件或目录\n * 点击【删除】并【确定】\n\n\n\n * 支持单个文件/目录的删除，也支持批量删除\n\n### **解冻归档存储和深度归档存储文件**\n\n归档存储和深度归档存储类型的文件，鼠标悬停在文件「名称」上时，可以查看解冻状态。\n\n\n\n在文件列表视图的「操作」列中点击解冻图标，可以解冻归档存储和深度归档存储类型的文件。\n\n\n\n * 设置解冻天数：1~7。\n * 点击【确定】\n * 成功提交解冻请求后，文件会切换为「解冻中」的状态。\n * 归档存储 1~5 分钟解冻完成，深度归档存储 5~12 小时解冻完成。当文件变为「已解冻」状态时，文件的内容才可以被正常访问。\n\n\n\n### **修改文件存储类型**\n\n文件列表中会展示文件的存储类型信息。[不同存储类型的差别 __](https://developer.qiniu.com/kodo/3956/kodo-\ncategory)\n\n\n\n在列表视图的「操作」列中点击修改存储类型的图标，可以修改文件的存储类型。\n\n\n\n * 归档存储和深度归档存储类型的文件需要先解冻为可读取状态，才能进行类型转换。\n * 低频存储、归档直读存储、归档存储和深度归档存储类型，Object 最小计量 64KB。\n * 从低频存储类型转换为其他类型时，如果该 Object 保存时间少于 30 天，将按照 30 天来计费。\n * 从归档直读存储类型转换为其他类型时，如果该 Object 保存时间少于 60 天，将按照 60 天来计费。\n * 从归档存储类型转换为其他类型时，如果该 Object 保存时间少于 60 天，将按照 60 天来计费。\n * 从深度归档存储类型转换为其他类型时，如果该 Object 保存时间少于 180 天，将按照 180 天来计费。\n\n### **预览文件**\n\n在列表视图中双击文件名，或在矩阵视图中双击文件即可预览。目前支持 txt 和大部分图片文件的预览。\n\n\n\n**注意：归档存储和深度归档存储文件，必须先解冻才能预览。**\n\n\n\n### **获取外链**\n\n在文件列表视图的「操作」列中点击外链图标，或在文件的预览界面点击「获取外链」，都能方便地生成并复制文件外链。\n\n\n\n默认不使用自有域名时，文件外链必须设置有效期，有效期范围1-604800s，默认600。\n\n\n\n * 设置外链有效期\n * 外链生成，【点击复制】文件外链即拷贝到剪切板\n\n客户端支持选用空间已绑定的自定义 cdn 域名或自定义源站域名来生成外链。使用自定义域名时，\n\n * 空间是公开的，生成永久有效外链，无需设置有效期\n * 空间是私有的，必须设置外链有效期，有效期最长 1 年，默认 600s\n\n\n\n**注意**\n\n不使用自有域名（使用空间的源站域名）或使用自定义源站域名生成外链，经由外链访问公有云存储的文件时，**会产生一定的外网流出流量**\n，**可能会产生流量计费** 。 \n使用空间的cdn域名生成外链，经由外链访问公有云存储的文件时，**产生的是 CDN 回源流量** 。 \n归档存储和深度归档存储文件，可以直接获取外链，但是文件访问前需要先解冻。\n\n### **批量导出外链**\n\n在文件列表视图中勾选多个文件，点击批量操作区域的「导出外链」，可以一次性将多个文件的外链以 csv 文件保存到本地。 \n勾选目录时，会把目录下所有文件的外链导出，而目录本身则不会导出外链。\n\n\n\n客户端支持选用空间已绑定的自定义 cdn 域名或自定义源站域名来生成外链：\n\n * 不使用自有域名时，文件外链必须设置有效期，有效期范围1-604800s，默认600s\n * 使用自定义域名时，空间是公开的，无需设置外链有效期；空间是私有的，则必须设置有效期，有效期最长 1 年，默认 600s\n\n\n\n * 设置外链有效期\n * 点击【生成并导出】\n * 客户端会弹出本地目录选择框，选择外链文件要保存的路径\n * 确认后，客户端将把所有文件外链以 csv 格式保存至所选路径下。csv 文件命名举例：kodo-browser-download-links-20200317110450.csv \n * 使用时建议以文本编辑工具打开csv文件\n * 文件名有中文字符时，使用 Excel 打开csv文件需要选择编码方式：打开新的空白sheet ——> 数据 ——> 从文本 ——> 选择已下载的 csv 文件，点击获取数据 ——> 选择文件原始格式或编码为：Unicode(UTF-8) ——> 设置数据分隔，点击完成，导入的中文字符即可正常显示\n\n### **分享目录**\n\n在文件列表目录栏的「操作」列中点击分享图标\n\n\n\n * 设置分享链接有效期，支持自定义范围 900 - 7200 秒或快速选择15分钟、30分钟、1小时、2小时\n * 定义提取码，必须为 6 位，只能由字母数字组成；支持自定义或点击「随机生成」自动生成\n * 点击「提交」获取分享链接，点击「复制链接与提取码」按钮进行复制\n * 将链接和提取码分发给他人，即可通过链接访问该目录下的文件。支持通过浏览器或 Kodo Browser 打开分享链接。\n\n\n\n## **管理外部路径**\n\n经由 Bucket Policy 授予权限的空间或目录，需要添加为「外部路径」，才能在客户端中使用和管理。\n\n### **开启外部路径功能**\n\n点击【设置】进入设置页面\n\n * 外部路径：勾选时，表示启用外部路径功能；不勾选时，客户端不显示「外部路径」菜单。外部路径功能，默认不启用。\n\n\n\n### **管理外部路径**\n\n外部路径功能启用后，界面会出现「外部路径」的菜单\n\n\n\n点击「添加外部路径」打开弹窗\n\n\n\n * 输入外部路径名：可以是被授权的空间或目录，需要由授权者提供。\n * 选择外部路径的区域\n * 点击确定，添加完成\n\n添加好的外部路径，只要有相应的权限，支持的操作与自己创建的空间一致。\n\n选中某个已添加的外部路径，点击「更多」的「删除」，可以把这个外部路径移除。\n\n\n\n * 此操作为客户端的配置移除，并没有真正删除对应的空间或目录。客户端不支持删除通过 Bucket Policy 授予权限的空间或目录。\n\n## **其他操作**\n\n### **断点上传设置**\n\n点击【设置】进入设置页面\n\n * 断点上传：勾选时表示开启断点上传功能；不勾选时，「断点上传」相关设置不生效\n * 断点上传文件阈值：当开启断点上传且文件大小大于此阈值时，自动使用可恢复的分片上传，范围：10MB~1000MB\n * 断点上传文件大小：分片大小，范围 1MB~100MB\n * 断点上传分片并发数：同时进行上传的分配文件数，范围 1~5\n * 最大上传任务数：同时上传的任务数，不仅限于断点上传模式；超过任务数量会进入队列，等待前面的任务完成，范围 1~10 \n\n\n### **上传限速**\n\n客户端支持设置单个文件的上传限速(单个上传任务的限速)，结合「最大上传任务数」的设置，实现客户端上传的整体限速控制。\n\n * 上传限速：勾选时表示开启限速控制；不勾选时，「单个文件上传限速」的设置不生效\n * 单个文件上传限速：单个文件上传的带宽限制值，范围 1KB/s - 100MB/s\n\n\n\n### **断点下载设置**\n\n * 断点下载：勾选时表示开启断点下载功能；不勾选时，「断点下载」相关设置不生效\n * 断点下载文件阈值：当开启断点下载且文件大小大于此阈值时，自动使用可恢复的分片下载，范围 10M~1000MB\n * 断点下载文件大小：分片大小，范围 8M~100MB\n * 最大下载任务数：同时下载的任务数，不仅限于断点下载模式；超过任务数量会进入队列，等待前面的任务完成，范围 1~10\n\n\n\n### **下载限速**\n\n客户端支持设置单个文件的下载限速(单个下载任务的限速)，结合「最大下载任务数」的设置，实现客户端下载的整体限速控制。\n\n * 下载限速：勾选时表示开启限速控制；不勾选时，「单个文件下载限速」的设置不生效\n * 单个文件下载限速：单个文件下载的带宽限制值，范围 1KB/s - 100MB/s\n\n\n\n### **文件列表分步加载**\n\n客户端默认会把当前路径下的所有文件/目录全部列举出来，文件数量特别多的时候，等待时间会比较久，可以设置开启文件列表的分页加载模式。\n\n * 文件列表分页加载：勾选时表示分页加载文件列表，而不是一次性列举出来所有的文件列表。\n\n\n\n开启分页加载后，文件列表滑动到底部会触发列举下一页的文件列表。\n\n * 自定义列举条目数：客户端支持自定义每次列举文件时的加载条目数，默认是 100。只有当「分页加载」模式开启时，此设置才生效。\n\n\n\n### **书签**\n\n客户端支持书签功能。\n\n\n\n * 在对应的界面访问路由下，点击五角星图标，可以将页面保存为书签\n * 点击「书签管理」，可以查看、使用和删除已保存的书签\n\n\n\n * 点击已保存的书签URL，客户端会跳转到对应的页面\n * 不再需要使用的书签，可以点击删除\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储命令行工具 Qshell"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 实用工具 > 命令行工具 Qshell\n\n# 命令行工具 Qshell\n\n最近更新时间: 2024-01-15 15:02:44\n\n# 简介\n\nQshell\n是利用七牛文档上公开的API实现的一个方便开发者测试和使用七牛API服务的命令行工具。该工具设计和开发的主要目的就是帮助开发者快速解决问题。目前该工具融合了七牛存储，CDN，以及其他的一些七牛服务中经常使用到的方法对应的便捷命令，比如b64decode，就是用来解码七牛的URL安全的Base64编码用的，所以这是一个面向开发者的工具，任何新的被认为适合加到该工具中的命令需求，都可以在[ISSUE列表\n__](https://github.com/qiniu/qshell/issues)里面提出来，我们会尽快评估实现，以帮助大家更好地使用七牛服务。\n\nGithub [代码地址 __](https://github.com/qiniu/qshell)\n\n# 下载\n\n该工具使用 Go 语言编写而成，当然为了方便不熟悉 Go\n或者急于使用工具来解决问题的开发者，我们提供了预先编译好的各主流操作系统平台的二进制文件供大家下载使用，由于平台的多样性，我们把这些二进制打包放到一个文件里面，请大家根据下面的说明各自需要选择支持合适平台来使用。\n\n> 更新日志 [查看\n> __](https://github.com/qiniu/qshell/blob/master/CHANGELOG.md)，`强烈建议使用 v2.8.0\n> 及以上版本`.\n\n支持平台 | 链接 \n---|--- \nWindows X86 | [下载 __](https://kodo-toolbox-new.qiniu.com/qshell-v2.13.0-windows-386.zip) \nWindows amd64 | [下载 __](https://kodo-toolbox-new.qiniu.com/qshell-v2.13.0-windows-amd64.zip) \nWindows arm | [下载 __](https://kodo-toolbox-new.qiniu.com/qshell-v2.13.0-windows-arm.zip) \nLinux X86 | [下载 __](https://kodo-toolbox-new.qiniu.com/qshell-v2.13.0-linux-386.tar.gz) \nLinux amd64 | [下载 __](https://kodo-toolbox-new.qiniu.com/qshell-v2.13.0-linux-amd64.tar.gz) \nLinux arm | [下载 __](https://kodo-toolbox-new.qiniu.com/qshell-v2.13.0-linux-arm.tar.gz) \nLinux arm64 | [下载 __](https://kodo-toolbox-new.qiniu.com/qshell-v2.13.0-linux-arm64.tar.gz) \nMac OS amd64 | [下载 __](https://kodo-toolbox-new.qiniu.com/qshell-v2.13.0-darwin-amd64.tar.gz) \nMac OS arm64 | [下载 __](https://kodo-toolbox-new.qiniu.com/qshell-v2.13.0-darwin-arm64.tar.gz) \n \n# 安装\n\n该工具由于是命令行工具，所以只需要从上面的下载链接下载后即可执行使用。\n\n**Linux和Mac平台**\n\n（1）权限 \n如果在Linux或者Mac系统上遇到`Permission Denied`的错误，请使用命令`chmod +x\nqshell`来为文件添加可执行权限。这里的`qshell`是上面文件重命名之后的简写。\n\n（2）任何位置运行 \n对于Linux或者Mac，如果希望能够在任何位置都可以执行，那么可以把`qshell`所在的目录加入到环境变量`$PATH`中去。假设`qshell`命令被解压到路径`/home/jemy/tools`目录下面，那么我们可以把如下的命令写入到你所使用的bash所对应的配置文件中，如果是`/bin/bash`，那么就是`~/.bashrc`文件，如果是`/bin/zsh`，那么就是`~/.zshrc`文件中。写入的内容为：\n\n \n \n export PATH=$PATH:/home/jemy/tools\n \n\n保存完毕之后，可以通过两种方式立即生效，其一为输入`source ~/.zshrc`或者`source\n~/.bashrc`来使配置立即生效，或者完全关闭命令行，然后重新打开一个即可，接下来就可以在任何位置使用`qshell`命令了。\n\n**Windows平台**\n\n（1）闪退问题 \n本工具是一个命令行工具，在Windows下面请先打开命令行终端，然后输入工具名称执行，不要双击打开，否则会出现闪退现象。\n\n（2）任何位置运行 \n如果你希望可以在任意目录下使用`qshell`，请将`qshell`工具可执行文件所在目录添加到系统的环境变量中。由于Windows系统是图形界面，所以方便一点。假设`qshell.exe`命令被解压到路径`E:\\jemy\\tools`目录下面，那么我们把这个目录放到系统的环境变量`PATH`里面。\n\n\n\n（3）文本编码问题\n\n当使用 qupload 等需要配置文件的命令时，不要使用 Notepad++ 等编辑器来编写配置文件，在本地右键默认新建一个文本文档来进行编写。\n\n（4） Windows 平台文件路径和字符\n\nWindows 平台下的文件路径需要写为`\\\\`的写法，如`C:\\\\Users\\\\li\\\\Downloads`。\n\n在使用命令和配置文件时，需要使用 `“”` 双引号,不能使用单引号。\n\n# 密钥设置\n\n该工具有两类命令，一类需要鉴权，另一类不需要。\n\n需要鉴权的命令都需要依赖七牛账号下的 `AccessKey` 和 `SecretKey`。所以这类命令运行之前，需要使用 `account` 命令来设置下\n`AccessKey` ，`SecretKey` 。\n\n \n \n $ qshell account ak sk name\n \n\n其中name表示该账号的名称, 如果ak, sk, name首字母是\"-\", 需要使用如下的方式添加账号, 这样避免把该项识别成命令行选项:\n\n \n \n $ qshell account -- ak sk name\n \n\n可以连续使用qshell account 添加账号ak, sk, name信息，qshell会保存这些账号的信息， 可以使用qshell\nuser命令列举账号信息，在各个账号之间切换, 删除账号等\n\n# 账户管理\n\n使用qshell user 子命令可以用来管理记录的多账户信息。\n\n 1. qshell user ls可以列举账户下所有的账户信息\n 2. qshell user cu 可以用来切换账户\n 3. qshell user cu 不携带的话会切换到最近的上个账户；比如我在A账户做完操作后，使用qshell user cu B到了B 账户，那么使用qshell user cu可以切回到A账户.\n\n# 开启命令的自动补全\n\n**linux上，使用bash**\n\n在centos上，需要安装bash-completion包，默认该包没有安装\n\n \n \n $ yum install bash-completion -y\n \n \n\n给当前的bash加入自动补全， 运行命令\n\n \n \n $ source <(qshell completion bash)\n \n \n\n也可以把这个配置加入bash的启动文件中，这样到bash启动的时候，会自动加载qshell的补全配置：\n\n \n \n $ echo \"source <(qshell completion bash)\" >> ~/.bashrc\n \n\n**Mac上，使用zsh** \n把如下代码加入zsh的启动文件中~/.zshrc\n\n \n \n if [ $commands[qshell] ]; then\n source <(qshell completion zsh)\n fi\n \n\n# 命令选项\n\n该工具还有一些有用的选项参数如下：\n\n参数 | 描述 \n---|--- \n–doc | 查看命令使用手册 \n-d | 设置是否输出 DEBUG 日志，如果指定这个选项，则输出 DEBUG 级别的日志 \n-D | 设置是否输出更加详细的 DEBUG 日志，如果指定这个选项，则输出详细的 DEBUG 级别的日志 \n-h | 打印命令列表帮助信息，遇到参数忘记的情况下，可以使用该命令 \n-v | 打印工具版本，反馈问题的时候，请提前告知工具对应版本号 \n-C | qshell配置文件, 其配置格式请看下一节 \n-L | 使用当前工作路径作为qshell的配置目录 \n \n# 配置文件\n\n 1. 配置文件格式支持 json，用户可按需进行配置，配置文件分两层：\n\n * 全局配置：需要在家目录下创建文件名为 .qshell.json 的 json 文件，此配置对 qshell 中的所有账号生效（qshell 当前账号可以通过 qshell user cu 命令进行切换）。\n * 账号配置：在 qshell 用户目录下（ ${家目录}/.qshell/users/${qshell 账号名}/ ）创建文件名为 .qshell.json 的 json 文件，此配置仅对当前目录所属的 qshell 账号生效；账号配置优先级大于全局配置。\n\n 2. 配置文件可以配置 use_https 和 host 相关信息：\n\n * use_https：qshell 请求是否使用 https。\n * host 配置：如 io host, up host, uc host, api host, rs host, rsf host；除 uc host 外，其他 host 要么不配置，要么全配置。 \n * 公有云可以不配置 host；\n * 私有云：如果私有云支持 uc 查询 bucket 所在区域信息（/query api），那么仅配置 uc host 即可；如果不支持则必须配置所有 host。\n\n注： \nqshell 某些命令的配置和文件的配置会有重合，此时优先级如下：\n\n \n \n qshell 命令配置 > 账号配置 > 全局配置\n \n\n通过 -C/-L 选项指定配置文件，实际是指定账号配置。\n\n配置例子：\n\n默认官方的列举空间的文件使用的是rs.qiniu.com域名，如果因为某种原因，比如私有存储，需要替换使用rs-\ntest.qiniu.com这个域名的话，那么只需要 \n在家目录下创建文件名字为.qshell.json的配置文件，文件内容为\n\n \n \n {\n \"hosts\": {\n \"rs\": \"rs-test.qiniu.com\"\n }\n }\n \n\n如果想要更改io host为io-test.qiniu.com的话，只需要继续在上面的hosts中添加，如下：\n\n \n \n {\n \"hosts\": {\n \"rs\": \"rs-test.qiniu.com\",\n \"io\": \"io-test.qiniu.com\"\n }\n }\n \n\n同理如果全部修改的话\n\n \n \n {\n \"hosts\": {\n \"rs\": \"rs-test.qiniu.com\",\n \"io\": \"io-test.qiniu.com\",\n \"api\": \"\",\n \"rsf\": \"\"\n }\n }\n \n\n# 命令列表\n\n * `v2.7.0 及以上版本，命令列表及命令使用文档说明，可直接使用 qshell 自助查看。`\n * `qshell -h，显示支持命令列表`\n * `qshell <子命令> --doc 查看详细命令使用说明`\n * 以下列表内使用文档链接适用于 v2.3.0 —— v2.6.3 版本\n * 查看工具版本号请使用命令 qshell -v\n\n## 账号设置命令\n\n命令 | 类别 | 描述 | 详细 \n---|---|---|--- \naccount | 账号 | 设置或显示当前用户的`AccessKey`和`SecretKey` | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/account.md) \nuser | 账号 | 列举账号信息，在各个账号之间切换, 删除账号 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/user.md) \n \n## 存储相关命令\n\n命令 | 类别 | 描述 | 详细 \n---|---|---|--- \nmkbucket | 创建 | 创建存储空间 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/mkbucket.md) \nbucket | 查看 | 查看存储空间信息 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/bucket.md) \nbatchdelete | 删除 | 批量删除七牛空间中的文件，可以直接根据`listbucket`的结果来删除 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchdelete.md) \ndelete | 删除 | 删除七牛空间中的一个文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/delete.md) \nbatchchgm | 修改 | 批量修改七牛空间中文件的MimeType | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchchgm.md) \nchgm | 修改 | 修改七牛空间中的一个文件的MimeType | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/chgm.md) \nbatchchtype | 修改 | 批量修改七牛空间中的文件的存储类型 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchchtype.md) \nchtype | 修改 | 修改七牛空间中的一个文件的存储类型 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/chtype.md) \nbatchexpire | 修改 | 批量修改七牛空间中的文件的生存时间,注意:`取消`生存时间设置`只有2.10及以上版本`支持 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchexpire.md) \nexpire | 修改 | 修改七牛空间中的一个文件的生存时间 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/expire.md) \nbatchcopy | 拷贝 | 批量复制七牛空间中的文件到另一个空间 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchcopy.md) \ncopy | 拷贝 | 复制七牛空间中的一个文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/copy.md) \nbatchmove | 移动 | 批量移动七牛空间中的文件到另一个空间 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchmove.md) \nmove | 移动 | 移动或重命名七牛空间中的一个文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/move.md) \nbatchrename | 重命名 | 批量重命名七牛空间中的文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchrename.md) \nrename | 重命名 | 重命名七牛空间中的文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/rename.md) \nbatchrestorear | 解冻 | 批量解冻七牛空间中的归档/深度归档存储类型文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchrestorear.md) \nrestorear | 解冻 | 解冻七牛空间中的归档/深度归档存储类型文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/restorear.md) \nbatchstat | 查询 | 批量查询七牛空间中文件的基本信息 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchstat.md) \nstat | 查询 | 查询七牛空间中一个文件的基本信息 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/stat.md) \nbatchchlifecycle | 修改 | 批量修改七牛空间中文件的生命周期 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchchlifecycle.md) \nchlifecycle | 修改 | 修改七牛空间中一个文件的生命周期 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/chlifecycle.md) \nbuckets | 查询 | 获取当前账号下所有的空间名称 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/buckets.md) \ndomains | 查询 | 获取指定空间的所有关联域名 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/domains.md) \nlistbucket | 列举 | 列举七牛空间里面的所有文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/listbucket.md) \nlistbucket2 | 列举 | 列举七牛空间里面的所有文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/listbucket2.md) \nfput | 上传 | 以文件表单的方式上传一个文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/fput.md) \nrput | 上传 | 以分片上传的方式上传一个文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/rput.md) \nqupload | 上传 | 同步数据到七牛空间， 带同步进度信息，和数据上传完整性检查（配置式） | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/qupload.md) \nqupload2 | 上传 | 同步数据到七牛空间， 带同步进度信息，和数据上传完整性检查（命令式） | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/qupload2.md) \nqdownload | 下载 | 从七牛空间同步数据到本地，支持只同步某些前缀的文件，支持增量同步 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/qdownload.md) \nqdownload2 | 下载 | 从七牛空间同步数据到本地，支持只同步某些前缀的文件，支持增量同步（命令式） | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/qdownload2.md) \nget | 下载 | 下载存储空间中的文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/get.md) \nfetch | 抓取 | 从Internet上抓取一个资源并存储到七牛空间中 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/fetch.md) \nbatchfetch | 抓取 | 从Internet批量抓取资源到七牛空间中 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchfetch.md) \nsync | 抓取 | 从Internet上抓取一个资源并存储到七牛空间中，适合大文件的场合 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/sync.md) \nabfetch | 抓取 | 异步抓取网络资源到七牛存储空间 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/abfetch.md) \nm3u8delete | m3u8 | 根据流媒体播放列表文件删除七牛空间中的流媒体切片 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/m3u8delete.md) \nm3u8replace | m3u8 | 修改流媒体播放列表文件中的切片引用域名 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/m3u8replace.md) \nbatchsign | 其他 | 批量根据资源的公开外链生成资源的私有外链 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/batchsign.md) \ndircache | 其他 | 输出本地指定路径下所有的文件列表 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/dircache.md) \nprivateurl | 其他 | 生成私有空间资源的访问外链 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/privateurl.md) \n \n \n \n\n## CDN 相关的命令\n\n命令 | 描述 | 详细 \n---|---|--- \ncdnrefresh | 批量刷新cdn的访问外链或目录 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/cdnrefresh.md) \ncdnprefetch | 批量预取cdn的访问外链 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/cdnprefetch.md) \n \n \n \n\n## 工具类命令\n\n命令 | 描述 | 详细 \n---|---|--- \nb64encode | base64编码工具，可选是否使用UrlSafe方式，默认UrlSafe | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/b64encode.md) \nb64decode | base64解码工具，可选是否使用UrlSafe方式，默认UrlSafe | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/b64decode.md) \nurlencode | url编码工具 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/urlencode.md) \nurldecode | url解码工具 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/urldecode.md) \nts2d | 将timestamp(单位秒)转为UTC+8:00中国日期，主要用来检查上传策略的deadline参数 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/ts2d.md) \ntms2d | 将timestamp(单位毫秒)转为UTC+8:00中国日期 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/tms2d.md) \ntns2d | 将timestamp(单位100纳秒)转为UTC+8:00中国日期 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/tns2d.md) \nd2ts | 将日期转为timestamp(单位秒) | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/d2ts.md) \nip | 根据淘宝的公开API查询ip地址的地理位置 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/ip.md) \nunzip | 解压zip文件，支持UTF-8编码和GBK编码 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/unzip.md) \nreqid | 七牛自定义头部X-Reqid解码工具 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/reqid.md) \nqetag | 根据七牛的qetag算法来计算文件的hash | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/qetag.md) \nsaveas | 实时处理的saveas链接快捷生成工具 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/saveas.md) \n \n \n \n\n## 音视频处理相关命令\n\n命令 | 类别 | 描述 | 详细 \n---|---|---|--- \npfop | 提交 | 提交异步音视频处理请求 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/pfop.md) \nprefop | 查询 | 查询七牛数据处理的结果 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/prefop.md) \n \n \n \n\n## 签名类命令\n\n命令 | 类别 | 描述 | 详细 \n---|---|---|--- \ntoken | 其他 | 计算upToken, Qbox token, Qiniu Token | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/token.md) \n \n \n \n\n## 第三方存储类工具\n\n命令 | 类别 | 描述 | 详细 \n---|---|---|--- \nalilistbucket | 列举 | 列举阿里OSS空间里面的所有文件 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/alilistbucket.md) \nawslist | 列举 | 列举亚马逊的存储空间 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/awslist.md) \nawsfetch | 抓取 | 从亚马逊存储迁移数据到七牛存储 | [文档 __](http://github.com/qiniu/qshell/blob/master/docs/awsfetch.md) \n \n \n \n\n# 问题反馈\n\n如果您有任何问题，请写在[ISSUE列表 __](https://github.com/qiniu/qshell/issues)里面，我们会尽快回复您。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储数据迁移工具 Kodoimport"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 实用工具 > 数据迁移工具 Kodoimport\n\n# 数据迁移工具 Kodoimport\n\n最近更新时间: 2024-06-25 16:14:19\n\n * 1\\. 简介\n * 1.1 下载\n * 1.2 文档\n * 1.3 kodoimport-cli\n * 1.4 角色\n * 1.4.1 Job\n * 1.4.2 Scheduler\n * 1.4.3 Worker\n * 1.4.4 Executor\n * 注意事项\n * 2\\. 安装\n * 2.1 二进制程序\n * 2.2 Docker\n * 2.3 Kubernetes\n * 3\\. 启动\n * 3.1 二进制程序启动\n * 3.1.1 单机模式\n * 3.1.2 多机模式\n * 3.2 Docker 启动\n * 3.2.1 单机模式\n * 3.2.2 多机模式\n * 3.3 kodoimport 启动参数\n * 4\\. 创建数据迁移 Job\n\n# 1\\. 简介\n\nkodoimport 为七牛云的数据迁移工具，和 kodoimport-cli 搭配使用，支持以下源的迁移：\n\n * 本地源\n * HTTP 源\n * 七牛源\n * S3 源\n * OSS 源\n\n迁移工具支持以下功能：\n\n * 支持单机模式和分布式模式。单机模式部署简单使用方便，但是单机模式迁移能力有限，如果有大规模数据迁移需求分布式模式更为合适\n * 支持流量控制\n * 支持迁移特定前缀的文件\n * 支持为迁移目标设置特定前缀\n * 支持并行数据下载和上传\n * 支持数据校验\n * 支持增量迁移\n * 支持同时配置多个迁移 Job\n\nkodoimport 启动后会创建迁移服务、文档服务等，等待创建迁移的 Job 进行相关的迁移工作；\n\n## 1.1 下载\n\n支持平台 | 下载链接 \n---|--- \nWindows x64 | [下载 __](https://kodo-toolbox-new.qiniu.com/kodoimport-v2.4.0-20240621-windows-amd64.tar.gz) \nMacos amd64 | [下载 __](https://kodo-toolbox-new.qiniu.com/kodoimport-v2.4.0-20240621-darwin-amd64.tar.gz) \nMacos arm64 | [下载 __](https://kodo-toolbox-new.qiniu.com/kodoimport-v2.4.0-20240621-darwin-arm64.tar.gz) \nLinux amd64 | [下载 __](https://kodo-toolbox-new.qiniu.com/kodoimport-v2.4.0-20240621-linux-amd64.tar.gz) \nLinux arm64 | [下载 __](https://kodo-toolbox-new.qiniu.com/kodoimport-v2.4.0-20240621-linux-arm64.tar.gz) \n \n## 1.2 文档\n\nkodoimport 内置了文档，你可以直接在本机上启动 kodoimport 并根据面板 Docs URL\n中提示的链接在浏览器中使用文档，也可以在迁移设备上启动 \nkodoimport 然后通过本机浏览器进行访问（本机网络必须能访问到设备，如果本机和迁移设备不在一个网络，可通过 vpn、docker 端口映射、k8s \n外网访问等方式解决）；\n\n默认情况下：文档仅允许本机访问，你可以通过修改 kodoimport 的启动选项 --web-address 以允许其他电脑访问。 \neg:\n\n \n \n kodoimport --web-address \"0.0.0.0:7900\"\n \n \n \n kodoimport 启动后面板如下：\n \n ========================================================= \n Welcome to kodoimport !\n If you are using kodoimport running docker or kubernetes, \n adjust the IP below to the host IP.\n \n \tVersion : Unknown\n \tScheduler Addr: 127.0.0.1:8001\n \tDocs URL: http://127.0.0.1:7900/docs\n \tStat URL: http://127.0.0.1:7900/stat\n \tKodoimport Path: /Users/test/.kodoimport/kodoimport\n \tWorkspace : /Users/test/.kodoimport\n \n \tBasic Auth:\n \t\t UserName: \n \t\t Password: \n =========================================================\n \n\n## 1.3 kodoimport-cli\n\nkodoimport-cli 为 kodoimport 迁移服务的交互工具，包含获取服务状态信息以及 Job\n的创建、暂停、删除、重试等功能，具体可参考文档服务中相关文档。\n\n## 1.4 角色\n\n### 1.4.1 Job\n\nJob 为一组相同源到相同七牛存储的任务集合。比如：七牛 BucketA 到七牛 BucketB 的迁移，每个文件的迁移为一个迁移任务。\n\n### 1.4.2 Scheduler\n\nScheduler 为迁移的调度器，负责将 Job 中的任务下发给 Worker 进行执行。所有的 Job 信息均存储在 Scheduler \n端，并会被持久化到本地工作目录中。\n\n`工作目录` 可在 kodoimport 启动时配置，目录中存放着日志、Job 相关信息等，默认为：`${当前用户家目录}/.kodoimport`。\n\n`工作目录` 结构如下：\n\n \n \n ├── log // 日志\n │ ├── access // kodoimport-cli 请求日志\n │ │ ├── log2024031214.txt\n │ │ └── 2024031410.txt\n │ └── system // kodoimport Scheduler 和 Worker 运行日志\n │ ├── 2024031214.txt\n │ └── 2024031410.log\n └── server\n ├── qiniu-bash // JobID 为 qiniu-bash 的 Job 的工作目录\n │ ├── 00000-round // 第 0 轮迁移的状态信息保存目录\n │ │ ├── 700-result.txt // 执行结果，700 为状态码具体错误信息见内部 Task 信息；\n │ │ └── cache // 状态信息\n │ │ └── info_cache.db\n │ │ ├── 000001.log\n │ │ ├── CURRENT\n │ │ ├── LOCK\n │ │ ├── LOG\n │ │ └── MANIFEST-000000\n │ └── cache\n └── qiniu-bash.conf // JobID 为 qiniu-bash 的 Job 的配置文件\n \n\n### 1.4.3 Worker\n\n任务执行体，会从 Scheduler 获取任务并执行，同一台设备上进配置一个 Worker 即可。如果此台设备上也需要配置 Scheduler，可使用将 \nMode 设置为 0，同时构建 Scheduler 和 Worker，其他设备的 Worker 也可接入此 Scheduler 中。\n\n`工作目录` 可在 kodoimport 启动时配置，目录中存放着日志等信息，默认为：`${当前用户家目录}/.kodoimport`。\n\n### 1.4.4 Executor\n\n任务执行的最小单元，Worker 上有多少个并发就会有多少个 Executor，一般不用关心此概念。\n\n## 注意事项\n\n**空间要求：**\n\n项目 | 大小 | 备注 \n---|---|--- \n内存 | Schdueler: 2G \nWorker: Executor 数（默认：20） * 分片上传的块大小（默认：4M） | 查看分片上传的块大小：kodoimport-cli job.config dst.uploadPartSizeMB \n硬盘 | 1千万文件：4Gi ~ 10Gi。 | 迁移后的结果信息会被存储，成功被迁移的文件存储信息较少，失败的存储信息较多；可以按待文件数量进行评估 \n \n# 2\\. 安装\n\n## 2.1 二进制程序\n\n在下面网站中下载相应版本：[kodoimport __](https://developer.qiniu.com/kodo/6435/kodoimport)\n\n## 2.2 Docker\n\n \n \n # 获取 Docker 镜像\n docker pull kodoproduct/kodoimport:latest\n \n\n## 2.3 Kubernetes\n\n参考 kodoimport Kubernetes\n配置文件：[kodoimport.yaml](https://developer.qiniu.com/kodo/6435/kodoimport/kodoimport.yaml)，并根据注释结合自己根据实际情况进行调整。\n\n \n \n # 部署\n kubectl apply -f kodoimport.yaml\n \n\n# 3\\. 启动\n\n## 3.1 二进制程序启动\n\n### 3.1.1 单机模式\n\n \n \n # 解压后找到 kodoimport 二进制执行程序，执行以下命令：\n \n ./kodoimport\n \n\n### 3.1.2 多机模式\n\n \n \n # 解压后找到 kodoimport 二进制执行程序\n # Scheduler 的主机 IP 为：192.168.1.5\n # Worker 的主机 IP 为：192.168.1.6\n # 启动 Scheduler \n kodoimport --mode 1 --scheduler-address \"0.0.0.0:8001\"\n \n # 启动 Worker\n kodoimport --mode 2 --scheduler-address \"192.168.1.5:8001\"\n \n\n## 3.2 Docker 启动\n\n### 3.2.1 单机模式\n\n \n \n # 单机模式\n # /Users/test/.kodoimport 为挂载的 kodoimport 工作目录，kodoimport 运行的状态信息会保存此处\n docker run -it -p 7900:7900 \\ \n --mount type=bind,source=/Users/test/.kodoimport,target=/root/.kodoimport \\\n kodoproduct/kodoimport:latest\n \n\n### 3.2.2 多机模式\n\n \n \n # Scheduler 的宿主机 IP 为：192.168.1.5\n # Worker 的宿主机 IP 为：192.168.1.6\n # 启动 Scheduler\n # /Users/test/.kodoimport 为挂载的 kodoimport 工作目录，kodoimport 运行的状态信息会保存此处\n docker run -it -p 7902:7902 -p 8001:8001 \\\n --mount type=bind,source=/Users/test/.kodoimport,target=/root/.kodoimport \\\n kodoproduct/kodoimport:latest \\\n --mode 1 \\\n --scheduler-address \"0.0.0.0:8001\" \\\n --web-address \"0.0.0.0:7902\" \n \n # 启动 Worker\n docker run -it -p 7902:7902 kodoproduct/kodoimport:latest \\\n --mode 2 \\\n --scheduler-address \"192.168.1.5:8001\" \\\n --web-address \"0.0.0.0:7902:192.168.1.6\"\n \n\n## 3.3 kodoimport 启动参数\n\n参数 | 类型 | 作用 | 默认值 \n---|---|---|--- \n–mode | int | 运行模式 \n0：同时部署启动 Scheduler 和 Worker \n1：仅启动 Scheduler \n其他：仅启动 Worker。 | 0 \n–workspace | string | kodoimport 的工作目录，存储 kodoimport 的日志等信息； \n当 kodoimport 中启动了 Scheduer 还会包含 Job 的信息。 | `${当前用户家目录}/.kodoimport` \n–web-address | string | Web 监听的地址，样式: 监听Host:监听端口:路由Host。 \nkodoimport 运行状态和文档，以及 kodoimport-cli 和 kodoimport 的交互也依赖此端口。 \n一般只设置监听地址即可（监听Host:监听端口），在 docker 的多机模式中，由于 Scheduler 需要转发请求到 Worker，此时需要配置\nWorker 的路由Host（Docker 宿主机地址）。 \n仅支持 IPv4。 | 0.0.0.0:7900 \n–scheduler-address | string | Scheduler 和 Worker 远程调用的地址。 \n当启动了 Scheduler 时，为 Scheduler 监听地址； \n当进启动 Worker 时，为 Schdulder 访问地址。 \n仅支持 IPv4。 | 127.0.0.1:8001 \n–worker-name | string | Worker 的别名。 | 无 \n–log-level | string | 日志等级；可配值有：debug、info、warning 和 error； \n当 Worker 启动时未指定此参数，Worker 会使用 Scheduler 配置的值。 | info \n–executor-count | int | Worker 的并发执行数量； \n当 Worker 启动时未指定此参数，Worker 会使用 Scheduler 配置的值。 | 20 \n–username | string | Web 请求中使用的 Basic Auth 验证的用户名 \n只有 Username 和 Password 同时指定才会生效。 | 无 \n–password | string | Web 请求中使用的 Basic Auth 验证的密码 \n只有 Username 和 Password 同时指定才会生效。 | 无 \n \n**注：** \n**特殊状态码说明：**\n\n * 230：文件迁移成功，但由于无法获取文件 Hash 而无法确保文件一致性的文件。\n\n# 4\\. 创建数据迁移 Job\n\n使用 kodoimport-cli 创建迁移 Job，详细使用说明请参考 kodoimport 内置文档中的示例\n\n \n \n kodoimport-cli job create -h\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储上传测试页面"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 实用工具 > 检测工具 >上传测试页面\n\n# 上传测试页面\n\n最近更新时间: 2023-05-12 14:50:15\n\n# 上传速度检测\n\n \n\n在遇到上传慢或上传不了问题时，需要用户通过[提交工单\n__](https://support.qiniu.com/question)提供有效地信息，发给我们来帮助排查。为了方便用户操作，七牛云提供了简单的\nweb 端检测工具。\n\n \n\n# 使用方法\n\n \n\n打开 [测速页面 __](https://kodo-utils.qiniu.com/upload-test)，选择您指定的区域点击**开始测试**\n查看该区域的测速结果。\n\n * 测试方式：使用指定测速区域七牛云对象存储 Kodo 标准域名向该区域所在空间中，上传大小为 100MB 的文件来进行网络测速。\n * 查看当前七牛云对象存储 Kodo 所支持的[存储区域](https://developer.qiniu.com/kodo/product_introduction/1671/region-endpoint-fq)。\n\n\n\n \n\n# 测试结果\n\n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储网络检测工具 Qwebtest"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 实用工具 > 检测工具 >网络检测工具 Qwebtest\n\n# 网络检测工具 Qwebtest\n\n最近更新时间: 2024-01-15 15:07:20\n\n# qwebtest\n\nQwebtest 是七牛云存储提供的一款检测工具，应用于如下场景：\n\n>\n> 遇到了一个奇怪的资源下载或上传问题，您第一时间将现象简单反馈给我们的技术支持，但有时候由于各种不可控的原因（比如提供的信息有限，或者问题重现困难等），问题变得难以排查。\n\n通过在实际环境中模拟上传下载行为，Qwebtest\n自动检测、收集与当前网络相关的各种信息，并形成可读的报告。借由这份报告，我们可以更快更准确地排查出问题所在和根本原因，节省用户在客户端花费的排查时间，同时降低在服务端寻找线索的困难度。\n\n# 下载\n\n * [Windows 32位 __](http://devtools.qiniu.com/windows/386/qwebtest.exe)\n * [Windows 64位 __](http://devtools.qiniu.com/windows/amd64/qwebtest.exe)\n * [Linux 32位 __](http://devtools.qiniu.com/linux/386/qwebtest)\n * [Linux 64位 __](http://devtools.qiniu.com/linux/amd64/qwebtest)\n * [Mac OS __](http://devtools.qiniu.com/darwin/amd64/qwebtest)\n\n# Windows视频教程\n\n[Windows 版视频教程 __](http://7xvilo.com1.z0.glb.clouddn.com/video/official-\ntool/qwebtest_video_for_win_web_low.mp4)\n\n# 使用方法\n\n**注意：**Windows 版本的用法与 Linux／Mac 版本略有不同，请查阅平台使用差异。\n\n## 检测下载问题\n\n \n \n qwebtest -download -s <problem_url> [-H headers][-o output][-timeout mins][-src][-from addr]\n -s 指定下载地址URL\n -H 添加请求的自定义Header，格式: -H \"Referer: http://bar.foo.com\"\n -o 指定文件输出路径，若不指定，下载的文件内容则被丢弃\n -src 穿透CDN，直接从源站下载\n -from 从指定的源站服务器直接下载\n -timeout 设置程序运行的最长时间（单位：分钟）\n \n\n其中 problem_url 为用户下载出问题的 URL 地址。\n\n常用实例：\n\n方式 | 命令 \n---|--- \n从 CDN 下载 | `qwebtest -download -s \"http://bar.qiniudn.com/foo.jpg\"` \n从 CDN 下载并保存 | `qwebtest -download -s \"http://bar.qiniudn.com/foo.jpg\" -o local.jpg` \n从源站下载 | `qwebtest -download -s \"http://bar.qiniudn.com/foo.jpg\" -src` \n从源站下载并保存 | `qwebtest -download -s \"http://bar.qiniudn.com/foo.jpg\" -o local.jpg -src` \n \n## 检测上传问题\n\n \n \n qwebtest -upload [-f inputfile][-r][-to addr][-ak access_key][-sk secret_key][-bucket bucket][-timeout mins]\n -f 指定文件上传，若不指定则默认随机生成内容上传\n -r 使用断点续上传模式，若不指定则默认使用普通上传\n -ak 指定Access Key\n -sk 指定Secret Key\n -bucket 指定Bucket\n -to 上传到指定的服务器\n -timeout 设置程序运行的最长时间（单位：分钟）\n \n\n常用实例：\n\n方式 | 命令 \n---|--- \n生成随机内容上传 | `qwebtest -upload` \n生成随机内容断点续上传 | `qwebtest -upload -r` \n指定本地文件上传 | `qwebtest -upload -f /path/to/local.jpg` \n指定本地文件断点续上传 | `qwebtest -upload -f /path/to/local.jpg -r` \n指定上传到某个空间 foo | `qwebtest -upload -f /path/to/local.jpg -ak x6789..djh68 -sk 78d78a..67fa -bucket foo` \n \n## 查看检测报告\n\n命令运行结束时，会在当前目录下生成一个名为 qwebtest.result..txt 的报告文件，用户可以自行查看，也可以将该 ID\n告诉我们的工作人员，我们会根据这个 ID 找到对应的报告文件。\n\n报告 ID 可以从程序运行之后的输出中获得，例如：\n\n \n \n $ ./qwebtest -download -s \"http://xoxo.qiniudn.com/1.jpg\"\n Get base info ..\n Testing network condition ..\n Testing download ..\n Send back report to qiniu...Done.\n Report ID: 4vGY4BTComyongl3\n \n\n其中的 4vGY4BTComyongl3 就是报告 ID。\n\nWindows 下获取报告 ID 的方式如下：\n\n\n\n## 平台使用差异\n\n**Windows**\n\n按下 Win + R 调出运行对话框，输入命令 cmd\n并按回车执行。在弹出的命令行终端界面中，输入该工具所在的路径或者简单地用鼠标将工具拖拽至命令行终端中，然后填入相关检测参数后即可执行。例如：\n\n\n\n**Linux／Mac**\n\n直接在终端界面中调出命令行工具，输入检测参数后即可执行。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Qiniu Jenkins Plugin"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 实用工具 > Qiniu Jenkins Plugin\n\n# Qiniu Jenkins Plugin\n\n最近更新时间: 2023-06-06 18:36:31\n\n七牛云存储 Jenkins 插件，支持将构建产生的文件保存到七牛，以及从七牛云下载已保存的构建文件到本地，不再占用本地的存储资源。\n\nGithub [代码地址 __](https://github.com/jenkinsci/qiniu-plugin)\n\n# 安装\n\n## 从官方插件列表安装（推荐）\n\n * 点击 Manage Jenkins 进入管理界面。\n * 点击 Manage Plugins进入插件管理界面。\n * 选择 Available Tab，搜索查找到 **Qiniu** 插件（This plugin upload is to archive build artifacts to Qiniu）。\n * 点击 Install without restart 或 Download now and install after restart，安装插件。\n\n\n\n注意：如果之前手动安装过 Qiniu 插件，想从官方插件列表中安装最新版本的插件，需要先将手动安装的插件卸载。\n\n * 进入 Manage Plugins 插件管理界面后，选择 Installed Tab，搜索查找到已安装的 **Qiniu** 插件。\n * 点击 Uninstall 卸载插件，再按上述步骤安装即可。\n\n\n\n## 手动安装\n\n点击下载 [Qiniu Jenkins Plugin __](https://kodo-toolbox-new.qiniu.com/qiniu-\njenkins-v1.0.1.hpi)。\n\n * 点击 Manage Jenkins 进入管理界面。\n * 点击 Manage Plugins进入插件管理界面。\n * 选择 Advanced Tab，在Upload Plugin 设置页选择下载好的七牛云存储插件。\n * 点击 Upload 上传。\n\n\n\n# 全局配置\n\n插件安装好以后，需要先做 Jenkins 的全局配置。\n\n * 点击 Manage Jenkins 进入管理界面。\n * 点击 Configure System 进入配置界面。\n * 点击 Artifact Management for Builds 按钮，选择 Qiniu Artifact Manager。\n * 在出现的 Qiniu Artifact Manager 配置栏中，依次填写 Access Key，Secret Key 和 Bucket Name，注意 Bucket Name 必须是七牛账户中已有的存储空间名称。\n\n\n\n * 可以点击旁边的 Advanced 按钮，将出现更多配置项，这里的配置项都是可选的。 \n * Archive as infrequent storage object：是否以低频存储的方式存储文件，推荐使用低频存储类型。不勾选时，以标准存储类型存储。\n * Delete Artifacts ：build 删除时是否删除已保存的文件，默认删除。可以取消勾选，删除 build 的时候保留已保存的云端文件。\n * Object Name Prefix：在存储空间中的对象名称前缀。如果有多套 Jenkins 系统，可以不同前缀路径来区分。\n * Bucket Download Domain：存储空间绑定的下载域名。如果不填，则从存储空间中选择一个下载域名。但如果在存储空间中没有绑定任何下载域名，则该项必填。\n * Use HTTPs Protocol：是否使用 HTTPS 传输协议，默认使用 HTTP 传输协议。\n * 如果是需要保存到私有云存储中，则必须配置Qiniu UP Domain，Qiniu Uc Domain，Qiniu Rs/Rsf Domain，Qiniu API Domain ；保存到公有云存储时，忽略这些Domain配置。\n * 点击 Save 按钮保存。\n\n\n\n# 部署\n\n全局配置，设置好了统一的存储空间及七牛云存储账号的AK/SK，然后就可以针对不同的项目来部署、配置构建结果保存的具体规则。\n\n## **普通部署**\n\n在 Job 配置界面中，添加 Archive the artifacts to Qiniu 的设置。\n\n * 点击 Post-build Actions 下拉框里的 Archive the artifacts to Qiniu 选项，添加一个配置框。\n * 在 Files to archive 里输入要保存的构建结果路径，可以使用通配符;只需要输入当前 workspace 下的相对路径即可。\n * 可以点击旁边的 Advanced 按钮，将出现更多配置项，这里的配置项都是可选的。 \n * Excludes：排除的文件路径匹配规则。表示要从构建结果中排除一部分文件，依然可以使用通配符。\n * Do not fail build if archiving returns nothing：即使没有匹配到任何文件，也不导致保存失败；表示允许保存空的文件。\n * Archive artifacts only if build is successful：表示仅当构建成功才会保存。\n * Use default excludes：使用默认的排除规则。表示自动将 SCM 软件用的配置文件或数据文件排除，不予保存。\n * Treat include and exclude patterns as case sensitive：文件路径匹配规则是否对大小写敏感。勾选，表示要保存的结果路径为大小写敏感。\n * 点击 Save 按钮保存。\n\n\n\n**注意：** \n为保证文件名称唯一性，保存文件的命名规则为：`<Object Name Prefix>/<Project Full Name>/<Build\nNumber>/<File Path>`\n\n## **Pipeline部署**\n\n在 Pipeline 配置界面中，可以使用 archiveArtifactsToQiniu 指令将构建产生的文件保存到七牛云存储。\n\n脚本示例如下：\n\n \n \n node {\n stage('Build') {\n sh '''\n rm -rf **\n mkdir -p {aa,bb,cc}/{dd,ee,ff}\n for file in {aa,bb,cc}/{dd,ee,ff}/{gg,hh,ii}\n do\n dd if=/dev/urandom of=\"$file\" count=1024 bs=1\n done\n '''\n }\n stage('Results') {\n archiveArtifactsToQiniu allowEmptyArchive: false, caseSensitive: false, excludeFilesGlob: '', includeFilesGlob: '**', onlyIfSuccessful: false, useDefaultExcludes: false\n }\n }\n \n \n\n参数说明如下：\n\n参数名称 | 参数类型 | 描述 | 备注 \n---|---|---|--- \nincludeFilesGlob | 字符串 | 要保存的构建结果路径，支持使用通配符 | 必填，保存所有文件，填写 `**` \nexcludeFilesGlob | 字符串 | 要从构建结果中排除、不做保存的文件，支持使用通配符 | 必填，不排除任何文件，填写 `''` \nallowEmptyArchive | 布尔值 | 允许保存空的文件 | 必填 \nonlyIfSuccessful | 布尔值 | 仅当构建成功才将产生的文件保存 | 必填，且需设置为true；设置为false不生效 \nuseDefaultExcludes | 布尔值 | 使用默认的排除规则，自动将 SCM 软件用的配置文件或数据文件排除，不予保存 | 可选 \ncaseSensitive | 布尔值 | 要保存的结果路径大小写敏感 | 可选 \n \n# 下载\n\n保存到七牛云存储的构建结果文件，可以在每次构建页面中看到，点击即可从七牛云存储下载构建输出的文件到本地。\n\n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储数据安全最佳实践"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 > 数据安全最佳实践\n\n# 数据安全最佳实践\n\n最近更新时间: 2022-07-12 14:38:09\n\n数据上云，数据安全问题成为用户关心的头等要事。而数据安全又涵盖了方方面面，如云存储服务安全的上传、下载、传输，云上资源的稳定性、可访性等。 \n七牛云存储 Kodo 具备了保障数据安全的各项功能以及完善的安全访问体系，为您有效规避风险、提供数据安全的最佳实践。\n\n * [保障安全上传、下载、管理数据](https://developer.qiniu.com/kodo/best_practices/12019/security-upload-download-manage-data)\n * [降低因账号密码泄露带来的未授权访问风险](https://developer.qiniu.com/kodo/best_practices/12020/reduce-because-of-the-account-password-reveal-that-brings-the-risk-of-unauthorized-access)\n * [降低被恶意篡改数据的风险](https://developer.qiniu.com/kodo/best_practices/12021/reducing-the-risk-of-malicious-tampering-with-data)\n * [防止恶意文件上传](https://developer.qiniu.com/kodo/best_practices/6323/prevent-malicious-file-upload-best-practices)\n * [降低被恶意访问、盗量的风险](https://developer.qiniu.com/kodo/best_practices/12022/reduce-the-risk-of-be-malicious-access-stolen)\n * [降低或因误操作导致的数据丢失的风险](https://developer.qiniu.com/kodo/best_practices/12023/to-reduce-or-the-risk-of-data-loss-as-a-result-of-wrong-operation)\n * [跟踪、追溯对数据的关键操作](https://developer.qiniu.com/kodo/best_practices/12024/the-key-to-tracking-traceability-of-data-operation)\n * [敏感数据安全防护](https://developer.qiniu.com/kodo/best_practices/12025/sensitive-data-security-protection)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储保障安全上传、下载、管理数据"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据安全最佳实践](https://developer.qiniu.com/kodo/best_practices/12018/data-\nsecurity-best-practices) > 保障安全上传、下载、管理数据\n\n# 保障安全上传、下载、管理数据\n\n最近更新时间: 2024-06-03 11:26:21\n\nKodo 七牛云存储，综合考虑了如下几种安全机制的场景、及相应的服务模型：\n\n * 上传资源\n * 访问资源\n * 管理和修改资源\n\n\n\n如上述服务模型，在使用 Kodo 对象存储服务时，客户端需要向业务服务器申请上传、下载的凭证，而后通过获得的凭证向云端进行上传、下载文件。期间，由 Kodo\n云存储服务提供账号密钥对 AK/SK （AccessKey/SecretKey）给到业务服务器生成对应凭证，即上传、下载、管理凭证：\n\n * 上传凭证是七牛云存储用于验证上传请求合法性的机制。用户通过上传凭证授权客户端，使其具备访问指定资源的能力。\n * 下载凭证是用于对私有资源下载的授权，通过授权客户端，使其具备访问指定私有资源的能力。下载私有资源的请求需要带一个合法的下载凭证。\n * 管理凭证是用于在管理现有资源时，例如查看资源元数据、删除或移动资源等。 \n不带凭证或带非法凭证的请求将返回 HTTP 错误码 401，代表认证失败。Kodo\n支持使用这些凭证来确保请求中途未经篡改，进而保障用户数据被安全上传、下载和管理。\n\n \n\n# **SSL 加密 保障数据传输安全**\n\nKodo 支持由 SSL 加密和 HTTP 协议构建网络协议，以提供更安全的 HTTPS\n协议访问、操作资源。可防止数据在传输过程中不被窃取、改变，确保数据的完整性。\n\n您只需要在绑定自定义源站域名之后配置\nHTTPS，配置界面如下图，更多设置详情请参考[自定义源站域名](https://developer.qiniu.com/kodo/development_guidelines/8556/set-\nthe-custom-source-domain-name)。\n\n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储降低因账号密码泄露带来的未授权访问风险"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据安全最佳实践](https://developer.qiniu.com/kodo/best_practices/12018/data-\nsecurity-best-practices) > 降低因账号密码泄露带来的未授权访问风险\n\n# 降低因账号密码泄露带来的未授权访问风险\n\n最近更新时间: 2024-06-03 11:26:45\n\n# **避免代码明文使用AccessKey**\n\nKodo 对象存储提供成对创建和使用的密钥对，并提供两份密钥对以备用。其中 AccessKey 会在传输中包含，需要避免明文使用AK，而用户必须保管好\nSecretKey 不在网络上传输以防止被窃取。若 SecretKey 被恶意第三方窃取，可能导致非常严重的数据泄漏风险。因此，如发现 SecretKey\n被非法使用，七牛支持管理员禁用该密钥对、更换新密钥对。\n\n# **权限隔离**\n\n空间的[访问控制](https://developer.qiniu.com/kodo/development_guidelines/8603/dev-\naccess-control)功能，能够统一的限制对空间中数据的访问。Kodo\n支持设置空间访问权限为公开或私有，设置私有空间可有效减少非预期的访问、保障数据被安全访问。\n\n * 公开空间，可通过文件对象的 URL 直接访问。\n * 私有空间，文件对象的访问则必须获得拥有者的授权才能访问。\n\n更多设置详情请参考[设置访问控制](https://developer.qiniu.com/kodo/development_guidelines/8502/set-\naccess-control)。\n\nKodo 支持开通 IAM 权限，基于对资源的功能策略，实现对指定子用户、子用户群组的访问、操作限制，来达到访问安全、可控的目的。如：\n\n * 限制指定子用户、子用户群组对资源的功能操作\n * 限制指定子用户、子用户群组对空间的创建、删除操作\n * 限制指定子用户、子用户群组对空间使用计量的查询\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储降低被恶意篡改数据的风险"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据安全最佳实践](https://developer.qiniu.com/kodo/best_practices/12018/data-\nsecurity-best-practices) > 降低被恶意篡改数据的风险\n\n# 降低被恶意篡改数据的风险\n\n最近更新时间: 2022-07-14 18:22:04\n\n对于一些核心敏感数据，诸如金融交易数据、医疗影响数据等，若您有数据上云后被恶意篡改的顾虑，如文件被恶意加密遭到勒索、文件被恶意删除等，Kodo\n提供了[对象锁定](https://developer.qiniu.com/kodo/development_guidelines/8621/dev-\nobject-\nlocking)功能，帮助您在固定的时间段内或无限期地阻止删除或覆盖数据。您只需给指定存储空间配置该对象锁定功能，便可在配置后实现保护空间内的数据的目的。如下图为对象锁定设置界面，更多设置详情请参考[设置对象锁定](https://developer.qiniu.com/kodo/development_guidelines/8545/set-\nthe-object-lock)。\n\n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储防止恶意文件上传"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据安全最佳实践](https://developer.qiniu.com/kodo/best_practices/12018/data-\nsecurity-best-practices) > 防止恶意文件上传\n\n# 防止恶意文件上传\n\n最近更新时间: 2022-07-12 14:38:01\n\n有用户反馈，存在非法用户盗用她们的 token 在空间上传 svg,xml,html\n等垃圾文件，注入广告，或者散播涉黄视频等资源，严重影响了用户业务的正常运营，针对此类问题，这边总结了如下处理方案。\n\n## **通过上传策略限制上传**\n\n**a.上传策略中 scope 指定 key 值，只允许用户上传指定 key 的文件**\n\n**参数说明：**\n\n字段名 | 说明 \n---|--- \nscope | 指定上传的目标资源空间 Bucket 和资源键 Key（最大为 750 字节）。有三种格式：\n* <bucket>，表示允许用户上传文件到指定的 bucket。在这种格式下文件只能**新增** （分片上传需要指定insertOnly为1才是新增，否则也为覆盖上传），若已存在同名资源（且文件内容/etag不一致），上传会失败；若已存在资源的内容/etag一致，则上传会返回成功。\n* <bucket>:<key>，表示只允许用户上传指定 key 的文件。在这种格式下文件默认允许**修改** ，若已存在同名资源则会被**覆盖** 。如果只希望上传指定 key 的文件，并且不允许修改，那么可以将下面的 insertOnly 属性值设为 1。\n* <bucket>:<keyPrefix>，表示只允许用户上传指定以 keyPrefix 为前缀的文件，当且仅当 isPrefixalScope 字段为 1 时生效，isPrefixalScope 为 1 时无法覆盖上传。 \n \n**python 示例：**\n\n \n \n from qiniu import Auth, put_file\n access_key =\"\"\n secret_key = \"\"\n # 构建鉴权对象\n q = Auth(access_key, secret_key)\n \n # 要上传的空间\n bucket_name = '2'\n key = 'key'\n #获取token的方法指定key\n token = q.upload_token(bucket_name, key, 3600)\n #put方法必须指定相同key才能上传\n ret, info = put_file(token, key, 'localfilepath'）\n print ret\n \n\n \n\n**b.上传策略中 insertOnly 指定为 1 或者指定 forceInsertOnly 为 true，只允许用户上传指定 key\n，并且不允许修改**\n\n**参数说明：**\n\n字段名 | 说明 \n---|--- \ninsertOnly | 默认为0，指定为 1 时，上传指定 key 的文件，并且不允许修改，即上传相同 key ，不同 hash，返回 614 “file exists”，上传相同 key，相同 hash 仍旧返回 200 \nforceInsertOnly | 默认为 False ，指定为 True 时，上传指定 key 的文件，并且不允许修改，只允许上传一次，即上传相同 key，相同 hash 仍旧返回 614 “file exists”， \n \n**python 示例：**\n\n \n \n from qiniu import Auth, put_file\n access_key =\"\"\n secret_key = \"\"\n # 构建鉴权对象\n q = Auth(access_key, secret_key)\n \n # 要上传的空间\n bucket_name = 'bucket'\n key = 'key'\n #insertOnly 指定为 1 \n policy = {\"insertOnly\":1} \n #获取token的方法指定key\n token = q.upload_token(bucket_name, key, 3600, policy)\n \n \"\"\"\n #forceInsertOnly 为 true\n policy = {'forceInsertOnly':True} \n # 注意 forceInsertOnly是新增字段，这时候生成token的方法中 strict_policy 这个参数设置成False才能生效\n token = q.upload_token(bucket_name, key, 3600, policy, strict_policy=False)\n \n \"\"\"\n \n #put方法必须指定相同key才能上传\n ret, info = put_file(token, key, 'localfilepath'）\n print ret\n \n\n \n\n**c.上传策略中指定 mimetype ，限制上传文件类型**\n\n**参数说明：**\n\n字段名 | 说明 \n---|--- \nmimeLimit | 限定用户上传的文件类型。指定本字段值，七牛服务器会侦测文件内容以判断 MimeType，再用判断值跟指定值进行匹配，匹配成功则允许上传，匹配失败则返回 403 状态码。示例：\n* `image/*`表示只允许上传图片类型 \n* `image/jpeg;image/png`表示只允许上传`jpg`和`png`类型的图片 \n* `!application/json;text/plain`表示禁止上传`json`文本和纯文本。**注意最前面的感叹号！** \n \n**python 示例：**\n\n \n \n from qiniu import Auth, put_file\n access_key =\"\"\n secret_key = \"\"\n # 构建鉴权对象\n q = Auth(access_key, secret_key)\n \n # 要上传的空间\n bucket_name = 'bucket'\n key = 'key'\n #限制mimeLimit\n policy = {\n \t\"insertOnly\":1,\n \t\"mimeLimit\":\"image/*\" #只允许上传图片文件\n } \n #获取token的方法指定key\n token = q.upload_token(bucket_name, key, 3600, policy)\n \n #put方法必须指定相同key才能上传\n ret, info = put_file(token, key, 'localfilepath'）\n print ret\n \n\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储降低被恶意访问、盗量的风险"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据安全最佳实践](https://developer.qiniu.com/kodo/best_practices/12018/data-\nsecurity-best-practices) > 降低被恶意访问、盗量的风险\n\n# 降低被恶意访问、盗量的风险\n\n最近更新时间: 2024-06-03 11:25:50\n\n# **访问的限制**\n\n当出现存储空间被恶意攻击、流量被恶意盗刷时，此时会出现高带宽或者大流量突发的情况。为尽量避免此类特殊情况发生、且尽可能杜绝由此带来的重大影响，Kodo\n支持了多种访问相关的功能设置，如针对空间访问权限的控制、设置 Referer 防盗链、跨域资源共享。\n\n其中，空间的[访问控制](https://developer.qiniu.com/kodo/development_guidelines/8603/dev-\naccess-control)功能，能够统一的限制对空间中数据的访问权限。Kodo\n支持设置空间访问权限为公开或私有，设置私有空间可有效降低空间被恶意访问的风险。\n\n * 公开空间，可通过文件对象的 URL 直接访问。\n * 私有空间，文件对象的访问则必须获得拥有者的授权才能访问。\n\n更多设置详情请参考[设置访问控制](https://developer.qiniu.com/kodo/development_guidelines/8502/set-\naccess-control)。\n\n \n\n[Referer\n防盗链](https://developer.qiniu.com/kodo/development_guidelines/8618/dev-\npreventing-hotlinking)功能，支持用户对访问来源自定义黑、白名单，以避免数据被非预期来源访问、盗用。具体的，Kodo 支持在\nReferer 防盗链中配置以下参数：\n\n * Referer 白名单，仅允许指定的域名访问资源；或 Referer 黑名单，指定域名禁止访问资源\n * 是否允许空 Referer。如果不允许空 Referer，则只有 HTTP 或 HTTPS header 中包含 Referer 字段的请求才能访问资源。\n\n如下图为 Referer 防盗链设置界面，更多设置详情请参考[设置 Referer\n防盗链](https://developer.qiniu.com/kodo/development_guidelines/8538/set-the-\nreferer-hotlinking-prevention)。\n\n\n\n \n\n此外，[跨域资源共享](https://developer.qiniu.com/kodo/development_guidelines/8608/dev-\ncross-domain-resource-sharing)功能，跨域访问 CORS（Cross-Origin Resource Sharing）是\nHTML5 提供的标准跨域解决方案，也是浏览器出于安全考虑而设置的一个限制、用于隔离潜在的对文件的恶意访问。\n\n在实际应用中，经常会有跨域访问的需求，比如用户的网站 a.website.com，后端使用了七牛云对象存储 Kodo 系统。在网页中提供了使用\nJavaScript 实现的上传功能，但是在该页面中，只能向 a.website.com\n发送请求，向其他网站发送的请求都会被浏览器拒绝。这样就导致用户上传的数据必须从 a.website.com\n中转。如果设置了跨域访问的话，用户就可以直接上传到七牛云存储而无需从 a.website.com 中转。\n\nKodo\n支持根据需求灵活配置跨域访问规则，实现允许或者拒绝相应的跨域请求，从而也能降低数据被恶意访问的风险。如下图为跨域资源共享设置界面，更多设置详情请参考[设置跨域资源共享](https://developer.qiniu.com/kodo/development_guidelines/8539/set-\nthe-cross-domain-resource-sharing)。\n\n\n\n如果您通过 CDN 域名访问资源，七牛云也提供了在 CDN 域名上开启访问安全控制功能，详情请参考 [CDN 访问控制配置\n__](https://developer.qiniu.com/fusion/4960/access-control-configuration)。\n\n \n\n# **资源的审核**\n\n为有效防止因不预期的资源导致的盗量，我们还建议您开启存储空间的存量和增量内容审核功能，以便于及时发现、处理敏感资源。\n\n七牛云针对 Kodo 云存储用户，提供了一键式的图片、视频内容审核服务。您可以将保存在 Kodo\n中的图片、视频进行鉴黄、鉴暴恐、政治敏感人物识别等内容审核服务，并对增量违规数据使用自动封禁的功能。七牛云还提供对审核结果的自助复核功能，用户可以自行对图片、视频进行删除、封禁和通过等操作。详情请参考[内容审核操作指南\n__](https://developer.qiniu.com/censor/8066/censor-portal-stream)。 \n更多运用内容审核功能的最佳实践请参考[防黑产图片盗刷 __](https://developer.qiniu.com/dora/12700/Anti-\nblackmail-image-theft)。\n\n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储降低或因误操作导致的数据丢失的风险"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据安全最佳实践](https://developer.qiniu.com/kodo/best_practices/12018/data-\nsecurity-best-practices) > 降低或因误操作导致的数据丢失的风险\n\n# 降低或因误操作导致的数据丢失的风险\n\n最近更新时间: 2022-07-14 18:06:36\n\n我们常收到反馈，用户因误操作导致数据被错误删除，导致业务无法正常运转。为尽量避免此类特殊情况发生、且尽可能杜绝因未及时解决数据丢失问题带来的重大影响，Kodo\n支持提供[跨区域同步](https://developer.qiniu.com/kodo/development_guidelines/8613/dev-\ncross-regional-synchronization)功能，您可提前为您空间的数据进行容灾备份。\n\n跨区域同步是将不同区域的存储空间之间的数据同步，它将源存储空间对象的改动（除删除操作）自动、异步地同步到目标存储空间，同时也支持选择是否将源存储空间的历史数据复制至目标存储空间。跨区域同步功能通过跨区域容灾备份数据，解决了用户误操作源文件导致数据丢失的问题。如下图为跨区域同步设置界面，更多设置详情请参考[设置跨区域同步](https://developer.qiniu.com/kodo/development_guidelines/1700/cross-\nregional-synchronization)。 \n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储跟踪、追溯对数据的关键操作"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据安全最佳实践](https://developer.qiniu.com/kodo/best_practices/12018/data-\nsecurity-best-practices) > 跟踪、追溯对数据的关键操作\n\n# 跟踪、追溯对数据的关键操作\n\n最近更新时间: 2022-07-14 18:29:15\n\n除了对风险情况的防范，Kodo\n也支持了应对、追溯风险情况的能力，帮助用户及时有效地发现、关注到重要事件。[事件通知](https://developer.qiniu.com/kodo/development_guidelines/8610/dev-\nevent-notification)和空间日志就是 Kodo 提供的较为典型且实用的跟踪、追溯手段。\n\n其中，事件通知功能，能够对用户所关心的存储资源操作及时进行消息通知。例如：\n\n * 有新数据从图片内容分享平台、音视频平台上传到七牛云存储\n * 资源发生了更新\n * 重要文件被删除\n * 数据同步已经完成\n\n当您创建事件通知规则后，若请求者对您的 Kodo 资源进行操作并触发了事件通知规则，则请求者对 Kodo 进行的相关操作将会被发送到您配置的 HTTP(s)\n服务端地址上。您可以针对事件通知返回的消息进行收集分析，如重点信息特别关注、数据统计分析等。如下图为事件通知设置界面，更多设置详情请参考[设置事件通知](https://developer.qiniu.com/kodo/development_guidelines/8541/set-\nthe-event-notification)。\n\n\n\n此外，[空间日志](https://developer.qiniu.com/kodo/development_guidelines/8614/space-\naccess-log)功能，提供自动保存访问空间日志的功能，能够对用户所关心的存储空间的访问信息进行定时记录。例如：\n\n * 远端访问 IP 地址\n * 收到的访问请求时间、请求内容\n * 请求返回的状态码\n\n当您设置空间日志功能后，您的空间被访问情况将被定时记录，您可以根据日志记录内容有效分析空间访问情况、及时发现异常访问源。如下图为空间日志设置界面，更多设置详情请参考[设置空间日志](https://developer.qiniu.com/kodo/development_guidelines/8546/set-\nthe-space-log)。 \n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储敏感数据安全防护"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据安全最佳实践](https://developer.qiniu.com/kodo/best_practices/12018/data-\nsecurity-best-practices) > 敏感数据安全防护\n\n# 敏感数据安全防护\n\n最近更新时间: 2022-07-05 17:45:42\n\n七牛云支持服务端加密功能以提供静态数据保护。当 Kodo\n对象存储在数据写入磁盘之前，支持在对象级别上应用数据加密的保护策略，并将得到的加密数据持久化保存下来。用户访问数据时，在拥有对象访问权限的前提下，自动对保存的加密数据进行解密并把原始数据返回。\n\nKodo 还提供针对特殊文件类型安全访问的功能，支持对指定文件类型可预览或下载、只下载无法预览以及禁止访问。用户可以按照文件类型区分敏感数据并进行对应设定。\n\n上述功能服务，如有需要请[联系我们 __](https://support.qiniu.com/tickets/new/)咨询详情。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储对象存储开源生态建设"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 > 对象存储开源生态建设\n\n# 对象存储开源生态建设\n\n最近更新时间: 2023-10-07 17:29:38\n\n * [使用 Hadoop S3A 客户端管理对象存储 Kodo](https://developer.qiniu.com/kodo/best_practices/12276/through-docking-hadoop-s3a-agreement)\n * [使用 Hadoop-Kodo 插件管理对象存储 Kodo](https://developer.qiniu.com/kodo/best_practices/12506/Use-Hadoop-kodo)\n * [使用 Terraform 管理对象存储 Kodo](https://developer.qiniu.com/kodo/best_practices/6226/kodo-terraform)\n * [使用 Rclone 命令行工具管理对象存储 Kodo](https://developer.qiniu.com/kodo/best_practices/12285/docking-rclone)\n * [使用 Kubernetes CSI 挂载对象存储 Kodo](https://developer.qiniu.com/kodo/best_practices/12348/use-kubernetes-csi-kodo-mount-object-storage)\n * [使用 Restic 备份工具对接对象存储 Kodo](https://developer.qiniu.com/kodo/best_practices/12503/restic-s3-kodo)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储使用七牛 Go CDK Driver 对接对象存储 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[对象存储开源生态建设](https://developer.qiniu.com/kodo/best_practices/12275/the-third-\nparty-software-extension-support) > 使用 Go CDK 对接对象存储 Kodo >使用七牛 Go CDK Driver\n对接对象存储 Kodo\n\n# 使用七牛 Go CDK Driver 对接对象存储 Kodo\n\n最近更新时间: 2024-01-12 15:26:53\n\n七牛 Go Cloud Development Kit (Go CDK) Driver 为 [gocloud.dev\n__](https://gocloud.dev/)提供了 kodoblob 驱动，可以通过使用[blob\n__](https://gocloud.dev/blob)包对七牛 Bucket 中的 Blob 进行读写，列举或删除。\n\n## 代码案例\n\n### 打开一个七牛 Bucket\n\n \n \n package main\n \n import (\n \t\"context\"\n \t\"fmt\"\n \t\"os\"\n \n \t_ \"github.com/qiniu/go-cdk-driver/kodoblob\"\n \t\"gocloud.dev/blob\"\n )\n \n func main() {\n \tbucket, err := blob.OpenBucket(context.Background(), \"kodo://<Qiniu Access Key>:<Qiniu Secret Key>@<Qiniu Bucket Name>?useHttps\")\n \tif err != nil {\n \t\tfmt.Fprintf(os.Stderr, \"could not open bucket: %v\\n\", err)\n \t\tos.Exit(1)\n \t}\n \tdefer bucket.Close()\n \n // 对 bucket 进行操作\n }\n \n\n这里的 URL 必须遵循以下格式\n\n \n \n kodo://<Qiniu Access Key>:<Qiniu Secret Key>@<Qiniu Bucket Name>?<Options>\n \n\n其中 `Options` 以 URL 查询的形式设置，支持以下选项：\n\n名称 | 值类型 | 备注 \n---|---|--- \n`useHttps` | 布尔值 | 是否使用 HTTPS 协议，默认不使用 \n`downloadDomain` | 字符串列表 | 下载域名，如果不配置则使用默认源站域名，可以配置多个下载域名 \n`signDownloadUrl` | 布尔值 | 是否对下载 URL 签名，对于私有空间来说，这是必须的，默认不签名 \n`bucketHost` | 字符串列表 | 设置 Bucket 域名，可以配置多个 Bucket 域名，默认使用公有云 Bucket 域名 \n`srcUpHost` | 字符串列表 | 设置上传源站域名，可以配置多个上传源站域名，默认通过 Bucket 域名查询获取 \n`cdnUpHost` | 字符串列表 | 设置上传加速域名，可以配置多个上传加速域名，默认通过 Bucket 域名查询获取 \n`rsHost` | 字符串列表 | 设置 RS 域名，可以配置多个 RS 域名，默认通过 Bucket 域名查询获取 \n`rsfHost` | 字符串列表 | 设置 RSF 域名，可以配置多个 RSF 域名，默认通过 Bucket 域名查询获取 \n`apiHost` | 字符串列表 | 设置 API 域名，可以配置多个 API 域名，默认通过 Bucket 域名查询获取 \n \n### 向七牛 Bucket 写入数据\n\n \n \n package main\n \n import (\n \t\"context\"\n \t\"fmt\"\n \t\"os\"\n \n \t_ \"github.com/qiniu/go-cdk-driver/kodoblob\"\n \t\"gocloud.dev/blob\"\n )\n \n func main() {\n \tbucket, err := blob.OpenBucket(context.Background(), \"kodo://<Qiniu Access Key>:<Qiniu Secret Key>@<Qiniu Bucket Name>?useHttps\")\n \tif err != nil {\n \t\tfmt.Fprintf(os.Stderr, \"could not open bucket: %v\\n\", err)\n \t\tos.Exit(1)\n \t}\n \tdefer bucket.Close()\n \n \tw, err := bucket.NewWriter(context.Background(), \"<Key>\", nil)\n \tif err != nil {\n \t\tfmt.Fprintf(os.Stderr, \"could not open object for writing: %v\\n\", err)\n \t\tos.Exit(1)\n \t}\n \tdefer w.Close()\n \n \t// 对 w 写入数据\n }\n \n \n\n### 从七牛 Bucket 读取数据\n\n \n \n package main\n \n import (\n \t\"context\"\n \t\"fmt\"\n \t\"os\"\n \n \t_ \"github.com/qiniu/go-cdk-driver/kodoblob\"\n \t\"gocloud.dev/blob\"\n )\n \n func main() {\n \tbucket, err := blob.OpenBucket(context.Background(), \"kodo://<Qiniu Access Key>:<Qiniu Secret Key>@<Qiniu Bucket Name>?useHttps\")\n \tif err != nil {\n \t\tfmt.Fprintf(os.Stderr, \"could not open bucket: %v\\n\", err)\n \t\tos.Exit(1)\n \t}\n \tdefer bucket.Close()\n \n \tr, err := bucket.NewReader(context.Background(), \"<Key>\", nil)\n \tif err != nil {\n \t\tfmt.Fprintf(os.Stderr, \"could not open object for reading: %v\\n\", err)\n \t\tos.Exit(1)\n \t}\n \tdefer r.Close()\n \n // 从 r 读取数据\n }\n \n\n### 从七牛 Bucket 读取范围数据\n\n`gocloud.dev/blob` 支持读取指定偏移量的数据。\n\n \n \n package main\n \n import (\n \t\"context\"\n \t\"fmt\"\n \t\"os\"\n \n \t_ \"github.com/qiniu/go-cdk-driver/kodoblob\"\n \t\"gocloud.dev/blob\"\n )\n \n func main() {\n \tbucket, err := blob.OpenBucket(context.Background(), \"kodo://<Qiniu Access Key>:<Qiniu Secret Key>@<Qiniu Bucket Name>?useHttps\")\n \tif err != nil {\n \t\tfmt.Fprintf(os.Stderr, \"could not open bucket: %v\\n\", err)\n \t\tos.Exit(1)\n \t}\n \tdefer bucket.Close()\n \n \tr, err := bucket.NewRangeReader(ctx, \"<Key>\", 1024, 4096, nil)\n \tif err != nil {\n \t\tfmt.Fprintf(os.Stderr, \"could not open object for reading: %v\\n\", err)\n \t\tos.Exit(1)\n \t}\n \tdefer r.Close()\n \n // 从 r 读取数据\n }\n \n\n### 从七牛 Bucket 删除数据\n\n \n \n package main\n \n import (\n \t\"context\"\n \t\"fmt\"\n \t\"os\"\n \n \t_ \"github.com/qiniu/go-cdk-driver/kodoblob\"\n \t\"gocloud.dev/blob\"\n )\n \n func main() {\n \tbucket, err := blob.OpenBucket(context.Background(), \"kodo://<Qiniu Access Key>:<Qiniu Secret Key>@<Qiniu Bucket Name>?useHttps\")\n \tif err != nil {\n \t\tfmt.Fprintf(os.Stderr, \"could not open bucket: %v\\n\", err)\n \t\tos.Exit(1)\n \t}\n \tdefer bucket.Close()\n \n \tif err = bucket.Delete(context.Background(), \"1G.65\"); err != nil {\n \t\tfmt.Fprintf(os.Stderr, \"could not delete object: %v\\n\", err)\n \t\tos.Exit(1)\n \t}\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储使用 Go CDK 通过 S3 协议对接对象存储 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[对象存储开源生态建设](https://developer.qiniu.com/kodo/best_practices/12275/the-third-\nparty-software-extension-support) > 使用 Go CDK 对接对象存储 Kodo >使用 Go CDK 通过 S3\n协议对接对象存储 Kodo\n\n# 使用 Go CDK 通过 S3 协议对接对象存储 Kodo\n\n最近更新时间: 2024-01-29 17:01:29\n\nGo 云开发工具包（Go CDK）是一个支持跨云服务商的基础 SDK，提供多种通用的应用程序接口对接云存储，云事件以及云数据库。这里展示用 CDK 的\nblob 包通过 S3 协议对接七牛的案例。\n\n## 配置 AWS 鉴权参数\n\n方法 1. 使用 `aws configure`\n\n \n \n # 确保 Python 3 和 pip3 已经正确安装\n curl \"https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip\" -o \"awscliv2.zip\"\n unzip awscliv2.zip\n sudo ./aws/install\n aws configure\n \n\n填写 Qiniu Access Key ID 和 Qiniu Secret Key 即可\n\n方法 2. 直接编写配置文件\n\n编写 `~/.aws/credentials`\n\n \n \n [default]\n aws_access_key_id = <AccessKey>\n aws_secret_access_key = <SecretKey>\n \n\n## 初始化 S3 bucket\n\n在 Golang 程序中导入 Go CDK 包和 s3blob 驱动\n\n \n \n import (\n \"gocloud.dev/blob\"\n _ \"gocloud.dev/blob/s3blob\"\n )\n \n\n初始化 S3 bucket 的代码为（这里的 `S3 Region Id` 和 `S3 Endpoint URL` 可以参考[服务域名\n__](https://developer.qiniu.com/kodo/4088/s3-access-domainname)）\n\n \n \n values := url.Values{\"awssdk\": []string{\"v2\"}, \"region\": []string{\"<S3 Region Id>\"}, \"endpoint\": []string{\"<S3 Endpoint URL>\"}}\n bucket, err := blob.OpenBucket(ctx, \"s3://<Bucket>?\" + values.Encode())\n \n\n## 从 S3 bucket 中列出对象\n\n \n \n iter := bucket.List(nil) // 这里可以额外填写 Delimiter 和 Prefix\n for {\n \tobject, err := iter.Next(ctx)\n \tif err != nil {\n \t\tif err == io.EOF {\n \t\t\tbreak\n \t\t}\n \t\treturn err\n \t}\n \tfmt.Printf(\"%s\\n\", object.Key)\n }\n \n\n## 获取对象属性\n\n \n \n info, err := bucket.Attributes(context.Background(), objectName)\n if err != nil {\n \treturn err\n }\n fmt.Printf(\"Size: %d\\n\", info.Size)\n fmt.Printf(\"Content-Type: %s\\n\", info.ContentType)\n fmt.Printf(\"MD5: %#v\\n\", info.MD5)\n fmt.Printf(\"ETag: %#v\\n\", info.ETag)\n fmt.Printf(\"Metadata: %#v\\n\", info.Metadata)\n fmt.Printf(\"ModTime: %s\\n\", info.ModTime)\n \n\n## 从对象中读取数据\n\n \n \n reader, err := bucket.NewReader(ctx, objectName, nil)\n if err != nil {\n \treturn err\n }\n defer reader.Close()\n \n\n这里的 `reader` 实现了 `io.Reader`，`io.WriterTo`，`io.Seeker` 和 `io.Closer` 接口\n\n## 将数据写入到对象中\n\n \n \n writer, err := bucket.NewWriter(ctx, objectName, &blob.WriterOptions{\n \tContentType: contentType,\n \tMetadata: metadata,\n })\n if err != nil {\n \treturn err\n }\n defer writer.Close()\n \n\n这里的 `writer` 实现了 `io.Writer`，`io.ReaderFrom` 和 `io.Closer` 接口\n\n## 复制对象\n\n \n \n err = bucket.Copy(ctx, destObjectName, srcObjectName, nil)\n if err != nil {\n \treturn err\n }\n \n\n## 删除对象\n\n \n \n err := bucket.Delete(ctx, objectNameToDelete)\n if err != nil {\n \treturn err\n }\n \n\n## 生成对象下载 URL\n\n \n \n signedUrl, err := bucket.SignedURL(ctx, objectName, &blob.SignedURLOptions{Expiry: time.Minute, Method: http.MethodGet})\n if err != nil {\n \treturn err\n }\n fmt.Printf(\"GET URL: %s\\n\", signedUrl)\n \n\n## 生成对象上传 URL\n\n \n \n signedUrl, err := bucket.SignedURL(ctx, objectName, &blob.SignedURLOptions{Expiry: time.Minute, Method: http.MethodPut})\n if err != nil {\n \treturn err\n }\n fmt.Printf(\"PUT URL: %s\\n\", signedUrl)\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储使用 Hadoop S3A 客户端管理对象存储 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[对象存储开源生态建设](https://developer.qiniu.com/kodo/best_practices/12275/the-third-\nparty-software-extension-support) > 使用 Hadoop 管理对象存储 Kodo >使用 Hadoop S3A\n客户端管理对象存储 Kodo\n\n# 使用 Hadoop S3A 客户端管理对象存储 Kodo\n\n最近更新时间: 2022-11-09 16:17:00\n\nHadoop 支持通过 Hadoop-AWS 插件来集成 AWS，Kodo 对象存储也兼容 AWS S3。因此用户只需要使用 Hadoop-AWS\n插件，并对 Hadoop 进行一定的配置，即可将 Kodo 对接到 Hadoop，使用 Hadoop S3A 来管理 Kodo 对象存储。\n\n * Hadoop S3A 为 Hadoop 官方提供的、在 Hadoop 系统中使用 S3 的工具包，通过 S3A 可以像操作 HDFS 一样操作 S3 存储\n * 目前七牛云存储 Kodo 可以支持大部分常用的 S3A 的功能\n * 关于 S3A 的更多介绍参见 [Hadoop-AWS module: Integration with Amazon Web Services __](https://hadoop.apache.org/docs/current/hadoop-aws/tools/hadoop-aws/index.html) \n \n\n# **部署说明**\n\n本文仅以单机部署方式作为示例参考。 \n**操作系统:** Linux 5.4.0-128-generic #144~18.04.1-Ubuntu \n**Hadoop 版本：** v3.3.4 \n**参考：** [Hadoop-AWS __](https://hadoop.apache.org/docs/current/hadoop-\naws/tools/hadoop-aws/index.html)\n\n## **1、下载 Hadoop 软件包**\n\n示例中 Hadoop 版本为 v3.3.4，下载链接为： \n`https://dlcdn.apache.org/hadoop/common/hadoop-3.3.4/hadoop-3.3.4.tar.gz` \n如果希望下载其他版本，可点击[下载链接\n__](https://dlcdn.apache.org/hadoop/common)并在其中挑选指定版本，最终在指定版本中选择`hadoop-*.tar.gz`\n文件进行下载即可。 \n下载完成后，将上述文件进行解压，拷贝至用户目录下并重命名为 `hadoop`\n\n \n \n # 在用户目录根目录下载 Hadoop\n cd ~\n curl https://dlcdn.apache.org/hadoop/common/hadoop-3.3.4/hadoop-3.3.4.tar.gz\n \n # 下载完成后\n # 解压\n tar -zxvf ./hadoop-3.3.4.tar.gz\n \n # 解压后文件夹名为：hadoop-3.3.4\n # 将 hadoop-3.3.4 重命名为 hadoop\n mv hadoop-3.3.4 hadoop\n \n\n \n\n## **2 文件配置**\n\n**2.1 环境配置** \n在 Hadoop 的软件包中默认已经包含了 S3A 相关的插件，我们无需再下载，只需要将其列入加载的模块序列中即可。 \n`hadoop-env.sh` 中的 `HADOOP_OPTIONAL_TOOLS` 参数用于指定要加载的可选模块，默认是不配置。 \n具体操作如下:\n\n \n \n # 进入 hadoop 路径\n cd ./hadoop\n \n # 修改 hadoop 的配置文件：hadoop-env.sh\n vim etc/hadoop/hadoop-env.sh\n \n # 找到 HADOOP_OPTIONAL_TOOLS\n # 默认为：# export HADOOP_OPTIONAL_TOOLS=\"hadoop-kafka,hadoop-openstack,hadoop-aliyun,hadoop-azure,hadoop-azure-datalake,hadoop-aws\"\n # 此配置默认是被注释掉的，参数中已经包含了 hadoop-aws，此处直接将注释打开（删除前面的 #）。\n \n\n**2.2 配置 core-site.xml** \n在此配置中声明 S3A 相关的配置信息\n\n \n \n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <?xml-stylesheet type=\"text/xsl\" href=\"configuration.xsl\"?>\n <configuration>\n <property>\n <name>fs.s3a.access.key</name>\n <value>[ak]</value>\n </property>\n <property>\n <name>fs.s3a.secret.key</name>\n <value>[sk]</value>\n </property>\n <property>\n <name>fs.s3a.connection.ssl.enabled</name>\n <value>false</value>\n </property>\n <property>\n <name>fs.s3a.path.style.access</name>\n <value>true</value>\n </property>\n <property>\n <name>fs.s3a.endpoint</name>\n <value>http://[endpoint]</value>\n </property>\n <property>\n <name>fs.s3a.impl</name>\n <value>org.apache.hadoop.fs.s3a.S3AFileSystem</value>\n </property>\n <property>\n <name>fs.AbstractFileSystem.s3a.impl</name>\n <value>org.apache.hadoop.fs.s3a.S3A</value>\n </property>\n <property>\n <name>fs.defaultFS</name>\n <value>s3a://[default-bucket]/</value>\n </property>\n </configuration>\n \n\n**注：**\n\n * `ak` / `sk` / `endpoint` / `default-bucket` 需要配置为相应的实际值，ak / sk 为七牛的账户秘钥（AccessKey 和 SecretKey）, endpoint 为 s3 url，default-bucket 为七牛存储的 bucket。\n * 上面配置中配置了 `fs.defaultFS` ，后续的命令我们可以不用加 s3a://[bucket] 信息。\n\n**2.3 Hadoop 的启动与停止**\n\n \n \n # 启动 hadoop\n ./sbin/start-all.sh\n \n # 启动后可以通过 jps 查看 Hadoop 相关节点信息\n jps\n \n # 停止 hadoop\n ./sbin/stop-all.sh\n \n\n**2.4 操作七牛 bucket** \nHadoop 启动后就可以通过 fs 来操作七牛的 bucket 了。\n\n \n \n # 上传一个文件\n ./bin/hdfs dfs -put a.txt /tmp/a.txt\n \n # 列举 / 下的文件列表\n ./bin/hdfs dfs -ls /\n \n\n \n\n# **命令说明**\n\n**Kodo 已支持的 Hadoop FS 命令**\n\n命令 | 说明 \n---|--- \nmkdir | 在存储系统创建新目录 \nput/copyFromLocal | 上传本地文件到存储系统 \ncat | 输出存储系统单个或多个文件内容到控制台 \ntail | 输出存储系统指定文件尾部 1k 字节内容到控制台 \nhead | 输出存储系统指定文件头部 1k 字节内容到控制台 \nls | 列出存储系统指定路径下所有文件 \nlsr | 类似 ls -R \nget/copyToLocal | 拉取存储系统文件到本地 \ngetmerge | 拉取存储系统文件到本地并合并成一个文件 \ndu/dus | 展示目录或者文件大小 \ncp | 拷贝存储系统路径下文件到另一个路径（可跨存储系统拷贝 hdfs=>kodo 或 kodo=>hdfs） \nmv | 移动存储系统路径文件到另一个路径（不支持跨存储系统移动） \nrm/rmr | 删除存储系统中的指定目录或文件 \ntext | 以文本输出存储系统压缩文件 \ntouchz | 创建一个存储系统空文件 \ncount | 统计存储系统路径下的目录数、文件数和总字节数 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储使用 Hadoop-Kodo 插件管理对象存储 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[对象存储开源生态建设](https://developer.qiniu.com/kodo/best_practices/12275/the-third-\nparty-software-extension-support) > 使用 Hadoop 管理对象存储 Kodo >使用 Hadoop-Kodo\n插件管理对象存储 Kodo\n\n# 使用 Hadoop-Kodo 插件管理对象存储 Kodo\n\n最近更新时间: 2023-07-27 17:35:09\n\n七牛云支持使用 Hadoop-Kodo 插件将 Hadoop 对接至对象存储 Kodo，并由此轻松管理 Kodo 对象存储。\n\n * 支持 Hadoop MapReduce 和 Spark 在 Kodo 上的读写操作\n * 实现了 Hadoop 文件系统的接口，通过模拟分级目录结构提供了和 HDFS 相同的使用体验\n * 支持大文件分片上传，最高支持 10TB 的单个文件\n * 使用了 Kodo 的 batch api，具有高性能的文件系统操作能力\n * 支持文件的内存块级缓存和磁盘块级缓存，提高了文件的读取性能\n\n \n\n## **使用说明**\n\n**对象存储不是文件系统** \n由于对象存储并不是文件系统，因此在使用上存在一些限制：\n\n * 对象存储是基于 key-value 的存储，不支持分层目录结构，因此需要使用路径分隔符模拟分层目录结构\n * 不跟踪目录的修改和访问时间\n * Kodo 对象存储暂不支持文件的追加写入，因此不能在已有文件的末尾追加写入数据\n * 不跟踪文件的修改时间，因此在文件系统中，文件的修改时间为文件的创建时间\n * delete 和 rename 的操作是非原子的，这意味着如果操作被意外中断，文件系统可能处于不一致的状态\n * 对象存储并不支持 unix-like 的权限管理，因此为了模拟文件系统，需要提供以下规则： \n * 目录权限为 715\n * 文件权限为 666\n * 文件所有者为本地当前用户\n * 文件所有组为本地当前用户\n * 单次请求的最大文件数量为 1000\n * 支持大文件分片上传，但分片数量限制为 10000，由于单个分片的最大大小为 1GB，因此最大支持 10TB 的单个文件\n\n**目录最后访问时间不被跟踪**\n\n * 依赖此特性的 Hadoop 特性可能会有意外的行为\n * 例如：YARN 的 AggregatedLogDeletionService 将无法删除相应的日志文件\n\n**七牛凭证非常非常有价值**\n\n * 通过您的七牛凭证使用服务将生成相关费用\n * 使用您的七牛凭证还可以读写您的数据，即任何拥有您凭证的人都可以读取您的空间 (Bucket)，他们也可以删除这些空间\n\n \n\n## **安装**\n\n**获取 hadoop-kodo 分发包及其依赖** \n根据您的 Hadoop 版本，从以下地址获取 hadoop-kodo 分发包及其依赖：[hadoop-kodo release\n__](https://github.com/qiniu/hadoop-kodo/releases) \n若 Release 中不存在您需要的 hadoop 版本，可自行编译打包，过程如下：\n\n \n \n # 打包 hadoop-kodo 分发包，其中 <hadoop.version> 为您的目标 hadoop 版本\n mvn package -DskipTests -Dhadoop.version=<hadoop.version>\n \n # 提取其所有依赖包到 target/dependency 目录下\n mvn dependency:copy-dependencies\n \n # 拷贝其依赖的 qiniu-java-sdk 到 target 目录下\n cp target/dependency/qiniu-* target/\n \n\n**安装 hadoop-kodo** \n将 `hadoop-kodo-<hadoop.version>-x.x.x.jar` 和 `qiniu-java-sdk-x.x.x.jar` 拷贝到\n`$HADOOP_HOME/share/hadoop/tools/lib` 目录下。\n\n_注意：请根据您的 Hadoop 版本选择对应的 hadoop-kodo 的 jar 包，若找不到对应版本的 jar 包，请自行编译。_\n\n编辑文件 `$HADOOP_HOME/etc/hadoop/hadoop-env.sh`，增加如下配置：\n\n \n \n for f in $HADOOP_HOME/share/hadoop/tools/lib/*.jar; do\n if [ \"$HADOOP_CLASSPATH\" ]; then\n export HADOOP_CLASSPATH=$HADOOP_CLASSPATH:$f\n else\n export HADOOP_CLASSPATH=$f\n fi\n done\n \n\n \n\n## **配置**\n\n**core-site.xml** \n修改 `$HADOOP_HOME/etc/hadoop/core-site.xml`，增加 Kodo\n相关的用户配置与实现类相关信息。在公有云环境下通常仅需配置如下即可正常工作：\n\n \n \n <configuration>\n <property>\n <name>fs.qiniu.auth.accessKey</name>\n <value>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</value>\n <description>Qiniu Access Key</description>\n </property>\n \n <property>\n <name>fs.qiniu.auth.secretKey</name>\n <value>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</value>\n <description>Qiniu Secret Key</description>\n </property>\n \n <property>\n <name>fs.kodo.impl</name>\n <value>org.apache.hadoop.fs.qiniu.kodo.QiniuKodoFileSystem</value>\n </property>\n <property>\n <name>fs.AbstractFileSystem.kodo.impl</name>\n <value>org.apache.hadoop.fs.qiniu.kodo.QiniuKodo</value>\n </property>\n <property>\n <name>fs.defaultFS</name>\n <value>kodo://example-bucket-name/</value>\n </property>\n </configuration>\n \n\n更多配置请参考文档：[config.md __](https://github.com/qiniu/hadoop-\nkodo/blob/main/docs/config.md)。 对于私有云用户可参考文档：[private-cloud.md\n__](https://github.com/qiniu/hadoop-kodo/blob/main/docs/private-cloud.md)。 \n \n\n## **运行 mapreduce 示例程序 wordcount**\n\n**put 命令**\n\n \n \n mkdir testDir\n touch testDir/input.txt\n echo \"a b c d ee a b s\" > testDir/input.txt\n hadoop fs -put testDir kodo:///testDir\n \n\n**ls 命令**\n\n \n \n hadoop fs -ls -R kodo://example-bucket/\n drwx--xr-x - root root 0 1970-01-01 08:00 kodo://example-bucket/user\n drwx--xr-x - root root 0 1970-01-01 08:00 kodo://example-bucket/user/root\n drwx--xr-x - root root 0 1970-01-01 08:00 kodo://example-bucket/testDir\n -rw-rw-rw- 0 root root 17 2023-01-18 15:54 kodo://example-bucket/testDir/input.txt\n \n\n**get 命令**\n\n \n \n $ hadoop fs -get kodo:///testDir testDir1\n $ ls -l -R testDir1\n total 8\n -rw-r--r-- 1 root staff 17 Jan 18 15:57 input.txt\n \n\n**运行 wordcount 示例**\n\n \n \n hadoop jar $HADOOP_HOME/share/hadoop/mapreduce/hadoop-mapreduce-examples-{version}.jar wordcount kodo://example-bucket/testDir/input.txt kodo://example-bucket/testDir/output\n \n\n执行成功后返回统计信息如下：\n\n \n \n 2023-01-18 16:00:49,228 INFO mapreduce.Job: Counters: 35\n \tFile System Counters\n \t\tFILE: Number of bytes read=564062\n \t\tFILE: Number of bytes written=1899311\n \t\tFILE: Number of read operations=0\n \t\tFILE: Number of large read operations=0\n \t\tFILE: Number of write operations=0\n \t\tKODO: Number of bytes read=34\n \t\tKODO: Number of bytes written=25\n \t\tKODO: Number of read operations=3\n \t\tKODO: Number of large read operations=0\n \t\tKODO: Number of write operations=0\n \tMap-Reduce Framework\n \t\tMap input records=1\n \t\tMap output records=8\n \t\tMap output bytes=49\n \t\tMap output materialized bytes=55\n \t\tInput split bytes=102\n \t\tCombine input records=8\n \t\tCombine output records=6\n \t\tReduce input groups=6\n \t\tReduce shuffle bytes=55\n \t\tReduce input records=6\n \t\tReduce output records=6\n \t\tSpilled Records=12\n \t\tShuffled Maps =1\n \t\tFailed Shuffles=0\n \t\tMerged Map outputs=1\n \t\tGC time elapsed (ms)=31\n \t\tTotal committed heap usage (bytes)=538968064\n \tShuffle Errors\n \t\tBAD_ID=0\n \t\tCONNECTION=0\n \t\tIO_ERROR=0\n \t\tWRONG_LENGTH=0\n \t\tWRONG_MAP=0\n \t\tWRONG_REDUCE=0\n \tFile Input Format Counters \n \t\tBytes Read=17\n \tFile Output Format Counters \n \t\tBytes Written=25\n \n \n \n $ hadoop fs -ls -R kodo://example-bucket/\n drwx--xr-x - root root 0 1970-01-01 08:00 kodo://example-bucket/user\n drwx--xr-x - root root 0 1970-01-01 08:00 kodo://example-bucket/user/root\n drwx--xr-x - root root 0 1970-01-01 08:00 kodo://example-bucket/testDir\n -rw-rw-rw- 0 root root 17 2023-01-18 15:54 kodo://example-bucket/testDir/input.txt\n drwx--xr-x - root root 0 1970-01-01 08:00 kodo://example-bucket/testDir/output\n -rw-rw-rw- 0 root root 0 2023-01-18 16:00 kodo://example-bucket/testDir/output/_SUCCESS\n -rw-rw-rw- 0 root root 25 2023-01-18 16:00 kodo://example-bucket/testDir/output/part-r-00000\n \n\n**cat 命令**\n\n \n \n $ hadoop fs -cat kodo://example-bucket/testDir/output/part-r-00000\n a\t2\n b\t2\n c\t1\n d\t1\n ee\t1\n s\t1\n \n\n \n\n## **测试**\n\n请参考文档：[test.md __](https://github.com/qiniu/hadoop-\nkodo/blob/main/docs/test.md)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储使用 Kubernetes CSI 挂载对象存储 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[对象存储开源生态建设](https://developer.qiniu.com/kodo/best_practices/12275/the-third-\nparty-software-extension-support) > 使用 Kubernetes CSI 挂载对象存储 Kodo\n\n# 使用 Kubernetes CSI 挂载对象存储 Kodo\n\n最近更新时间: 2023-12-14 18:39:54\n\n在 Kubernetes 中，我们支持通过 Container Storage Interface (CSI) 驱动将七牛云对象存储 Kodo\n的存储空间以卷的形式直接在 Kubernetes 容器内挂载，并通过 POSIX 接口直接读写对象存储中的数据。\n\n * 该功能要求 Kubernetes 的版本在 1.18 以上\n * 该功能要求 FUSE3 已经在所有 Kubernetes Node 上安装\n * 查看 [Kubernetes 相关文档 __](https://kubernetes.io/docs/concepts/storage/volumes/#csi)\n\n# **安装 Kodo CSI 驱动**\n\n \n \n kubectl apply -f https://github.com/qiniu/kubernetes-csi-driver/releases/download/v0.1.3/kodo-plugin.yaml\n \n\n# **使用指定的存储空间**\n\nKodo CSI 驱动支持声明指定了对象存储空间的 PV，并通过 PVC 将该 PV 挂载到 Kubernetes 容器内，这样就可以在\nKubernetes 容器内访问到指定存储空间的数据。\n\n下面的教程基于已经将 [Kodo CSI Github __](https://github.com/qiniu/kubernetes-csi-\ndriver)完整克隆到本地 csi-driver 目录的情况下操作，如果没有克隆，则直接复制文件内容到本地目录即可。\n\n**编辑 ./csi-driver/examples/kodo/static-provisioning/secret.yaml**\n\n \n \n apiVersion: v1\n metadata:\n name: kodo-csi-pv-secret # Secret 名称，可以修改\n kind: Secret\n type: Opaque\n data:\n accesskey: \"<Qiniu Access Key>\" # 必填, 必须是 BASE64 格式\n secretkey: \"<Qiniu Secret Key>\" # 必填, 必须是 BASE64 格式\n stringData:\n bucketname: \"<bucketname>\" # 必填\n ucendpoint: \"<ucendpoint>\" # 必填\n storageclass: \"STANDARD\" # 可选\n region: \"z0\" # 可选\n subdir: \"\" # 可选\n s3forcepathstyle: \"false\" # 可选\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \naccesskey | 是 | \\- Access Key \n\\- 必须注意，在 Kubernetes 中，Access 的值必须以 Base64 的形式填写，参考[官方案例\n__](https://kubernetes.io/docs/concepts/configuration/secret/#editing-a-\nsecret)。 \nsecretkey | 是 | \\- Secret Key \n\\- 必须注意，在 Kubernetes 中，Secret 的值必须以 Base64 的形式填写，参考[官方案例\n__](https://kubernetes.io/docs/concepts/configuration/secret/#editing-a-\nsecret)。 \nbucketname | 是 | 空间名称 \nucendpoint | 是 | 在公有云中，该字段可以填写为 https://kodo-config.qiniuapi.com \nstorageclass | 否 | 默认为 STANDARD，可选值为 STANDARD，LINE，GLACIER，DEEP_ARCHIVE \nregion | 否 | 默认为 z0 代表华东区 \nsubdir | 否 | 仅挂载子目录，适用于通过 Bucket Policy 授权子目录的用户 \ns3forcepathstyle | 否 | 是否仅使用 Path Style 调用 S3 API，适用于私有云环境 \n \n \n\n**编辑 ./csi-driver/examples/kodo/static-provisioning/pv.yaml**\n\n \n \n apiVersion: v1\n kind: PersistentVolume\n metadata:\n name: kodo-csi-pv # PV 名称，可以修改\n labels:\n kodo-pvname: kodo-csi-pv # PVC 匹配用的标签，可以修改\n spec:\n capacity:\n storage: 5Gi # 空间大小，可以修改\n accessModes:\n - ReadWriteMany\n persistentVolumeReclaimPolicy: Retain # 无需修改，Kodo CSI 驱动只支持 Retain 策略\n csi:\n driver: kodoplugin.storage.qiniu.com\n volumeHandle: kodo-csi-pv # 指定为上面的 PV 名称\n volumeAttributes:\n uploadcutoff: \"209715200\" \n uploadchunksize: \"5242880\" \n uploadconcurrency: \"4\" \n vfscachemode: \"off\" \n dircacheduration: \"5m0s\" \n buffersize: \"16777216\" \n vfsreadahead: \"0\" \n vfscachemaxage: \"1h0m0s\" \n vfscachemaxsize: \"off\" \n vfscachepollinterval: \"1m0s\" \n vfswriteback: \"5s\" \n vfsreadchunksize: \"134217728\" \n vfsreadchunksizelimit: \"off\" \n nochecksum: \"no\" \n nomodtime: \"no\" \n noseek: \"no\" \n readonly: \"no\" \n transfers: \"4\" \n nodePublishSecretRef:\n name: kodo-csi-pv-secret # 指定 Secret 名称\n namespace: default\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nuploadcutoff | 否 | \\- 分片上传阈值，大于该阈值的文件将自动使用分片的形式上传，单位为字节。 \n\\- 默认为 200 MB，最小值为 0，最大不能超过 5 GB。 \nuploadchunksize | 否 | \\- 分片大小，单位为字节，默认为 5 MB。 \n\\- 对于大文件而言，适当提高分片大小将有效提升上传效率。 \nuploadconcurrency | 否 | 分片上传并发度，默认为 4。 \nvfscachemode | 否 | \\- 本地缓存模式，可选值为 off，minimal，writes，full。 \n\\- 默认为 off，即无本地缓存，具体参见高级参数详解内的说明。 \ndircacheduration | 否 | \\- 目录缓存时长，默认为 5m0s。 \n\\- 当列举目录时，如果目录没有缓存或缓存已经失效，则会从云存储列举，然后刷新缓存。 \nbuffersize | 否 | \\- 文件内存缓冲区最大尺寸，单位为字节，默认为 16 MB。 \n\\- 当文件被下载时，数据将被读入内存缓冲区等待读请求来获取。 \nvfsreadahead | 否 | \\- 额外预读取大小，单位为字节，默认为 0。 \n\\- 仅在 vfscachemode 为 full 时，当文件被下载时，buffersize 大小的数据将被读取到内存缓冲区等待读取，之后的\nvfsreadahead 大小的数据则被读取到本地缓存中等待读取。 \nvfscachemaxage | 否 | \\- 本地缓存时长，默认为 1h0m0s。 \n\\- 当本地缓存被启用时，缓存的数据最长有效期，超过有效期的数据将被自动删除。 \nvfscachemaxsize | 否 | 最大本地缓存尺寸，默认为 off。 \nvfscachepollinterval | 否 | 清理缓存频率，默认为 1m0s。 \nvfswriteback | 否 | \\- 本地缓存上传延迟时长，默认为 5s。 \n\\- 当本地写缓存被启用时，被写入的文件仅在被关闭后，且在延迟时长内没有被再打开的数据才会被上传到云存储。 \nvfsreadchunksize | 否 | \\- 首次下载分片大小，单位为字节，默认为 128 MB。 \n\\- 当 vfsreadchunksize 大于 0\n时，文件总是以分片的形式被下载，且每次下载的分片被读取完毕后，下次下载的分片大小是前一次的两倍，直到分片大小达到 vfsreadchunksizelimit\n或文件被下载完毕为止。 \nvfsreadchunksizelimit | 否 | \\- 最大下载分片大小，单位为字节，默认为 off。 \n\\- 当下载的分片大小不断翻倍直到大于等于 vfsreadchunksizelimit 后，之后每次下载的分片大小总是等于\nvfsreadchunksizelimit，直到文件被下载完毕为止。 \nnochecksum | 否 | 上传下载时不再校验数据，默认为总是校验数据。 \nnomodtime | 否 | \\- 不再读写文件修改时间，默认为总是读写文件修改时间。 \n\\- 禁止读写文件修改时间可以提升文件系统的性能。 \nnoseek | 否 | 禁止文件寻址，默认为允许文件寻址。 \nreadonly | 否 | 只读文件系统，默认为可以修改文件系统。 \ntransfers | 否 | \\- 本地缓存上传并发度，默认为 4。 \n\\- 当本地写缓存被启用时，异步上传文件的并发度。 \n \n \n\n**编辑 ./csi-driver/examples/kodo/static-provisioning/pvc.yaml**\n\n \n \n apiVersion: v1\n kind: PersistentVolumeClaim\n metadata:\n name: kodo-pvc # PVC 名称，可以修改\n spec:\n accessModes:\n - ReadWriteMany\n storageClassName: ''\n resources:\n requests:\n storage: 5Gi # 申请空间大小，可以修改\n selector:\n matchLabels:\n kodo-pvname: kodo-csi-pv # 匹配 PV 的标签\n \n\n \n\n**将 Secret，PV，PVC 导入 Kubernetes**\n\n \n \n kubectl create -f ./csi-driver/examples/kodo/static-provisioning\n \n\n \n\n# **使用 CSI 驱动动态创建的存储空间**\n\nKodo CSI 驱动也支持声明 StorageClass，并在创建 PVC\n的过程中当场为其创建对象存储空间。当容器只是需要非特定的对象存储空间时，动态创建存储空间的方式将更加方便。但需要注意，该功能需要您的账户开启 [IAM 功能\n__](https://developer.qiniu.com/af/10149/iam-introduction)，该功能将允许您创建并管理子账户。\n如果之前从未开启过，请与七牛技术支持联系。\n\n**编辑 ./csi-driver/examples/kodo/dynamic-provisioning/secret.yaml**\n\n \n \n apiVersion: v1\n metadata:\n name: kodo-csi-sc-secret\n kind: Secret\n type: Opaque\n data:\n accesskey: \"<Qiniu Access Key>\" # 必填, 必须是 BASE64 格式\n secretkey: \"<Qiniu Secret Key>\" # 必填, 必须是 BASE64 格式\n stringData:\n ucendpoint: \"<ucendpoint>\" # 必填\n storageclass: \"STANDARD\" # 可选\n region: \"z0\" # 可选\n subdir: \"\" # 可选\n s3forcepathstyle: \"false\" # 可选\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \naccesskey | 是 | \\- Access Key \n\\- 必须注意，在 Kubernetes 中，Access 的值必须以 Base64 的形式填写，参考[官方案例\n__](https://kubernetes.io/docs/concepts/configuration/secret/#editing-a-\nsecret)。 \nsecretkey | 是 | \\- Secret Key \n\\- 必须注意，在 Kubernetes 中，Secret 的值必须以 Base64 的形式填写，参考[官方案例\n__](https://kubernetes.io/docs/concepts/configuration/secret/#editing-a-\nsecret)。 \nucendpoint | 是 | 在公有云中，该字段可以填写为 https://kodo-config.qiniuapi.com \nstorageclass | 否 | 默认为 STANDARD，可选值为 STANDARD，LINE，GLACIER，DEEP_ARCHIVE \nregion | 否 | 默认为 z0 代表华东区 \nsubdir | 否 | 仅挂载子目录，适用于通过 Bucket Policy 授权子目录的用户 \ns3forcepathstyle | 否 | 是否仅使用 Path Style 调用 S3 API，适用于私有云环境 \n \n \n\n**编辑 ./csi-driver/examples/kodo/dynamic-provisioning/sc.yaml**\n\n \n \n apiVersion: storage.k8s.io/v1\n kind: StorageClass\n metadata:\n name: kodo-csi-sc # StorageClass 名称，可以修改\n parameters:\n uploadcutoff: \"209715200\" \n uploadchunksize: \"5242880\" \n uploadconcurrency: \"4\" \n vfscachemode: \"off\" \n dircacheduration: \"5m0s\" \n buffersize: \"16777216\" \n vfsreadahead: \"0\" \n vfscachemaxage: \"1h0m0s\" \n vfscachemaxsize: \"off\" \n vfscachepollinterval: \"1m0s\" \n vfswriteback: \"5s\" \n vfsreadchunksize: \"134217728\" \n vfsreadchunksizelimit: \"off\" \n nochecksum: \"no\" \n nomodtime: \"no\" \n noseek: \"no\" \n readonly: \"no\" \n transfers: \"4\" \n csi.storage.k8s.io/provisioner-secret-name: kodo-csi-sc-secret # 指定 Secret 名称\n csi.storage.k8s.io/provisioner-secret-namespace: default\n provisioner: kodoplugin.storage.qiniu.com\n reclaimPolicy: Retain # 当 PVC 被删除时，相关存储空间的处理策略。可选值为 Retain，Delete，Retain 表示存储空间及相关数据将被保留，Delete 表示存储空间及相关数据将被删除。默认为 Retain。\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nuploadcutoff | 否 | \\- 分片上传阈值，大于该阈值的文件将自动使用分片的形式上传，单位为字节。 \n\\- 默认为 200 MB，最小值为 0，最大不能超过 5 GB。 \nuploadchunksize | 否 | \\- 分片大小，单位为字节，默认为 5 MB。 \n\\- 对于大文件而言，适当提高分片大小将有效提升上传效率。 \nuploadconcurrency | 否 | 分片上传并发度，默认为 4。 \nvfscachemode | 否 | \\- 本地缓存模式，可选值为 off，minimal，writes，full。 \n\\- 默认为 off，即无本地缓存，具体参见高级参数详解内的说明。 \ndircacheduration | 否 | \\- 目录缓存时长，默认为 5m0s。 \n\\- 当列举目录时，如果目录没有缓存或缓存已经失效，则会从云存储列举，然后刷新缓存。 \nbuffersize | 否 | \\- 文件内存缓冲区最大尺寸，单位为字节，默认为 16 MB。 \n\\- 当文件被下载时，数据将被读入内存缓冲区等待读请求来获取。 \nvfsreadahead | 否 | \\- 额外预读取大小，单位为字节，默认为 0。 \n\\- 仅在 vfscachemode 为 full 时，当文件被下载时，buffersize 大小的数据将被读取到内存缓冲区等待读取，之后的\nvfsreadahead 大小的数据则被读取到本地缓存中等待读取。 \nvfscachemaxage | 否 | \\- 本地缓存时长，默认为 1h0m0s。 \n\\- 当本地缓存被启用时，缓存的数据最长有效期，超过有效期的数据将被自动删除。 \nvfscachemaxsize | 否 | 最大本地缓存尺寸，默认为 off。 \nvfscachepollinterval | 否 | 清理缓存频率，默认为 1m0s。 \nvfswriteback | 否 | \\- 本地缓存上传延迟时长，默认为 5s。 \n\\- 当本地写缓存被启用时，被写入的文件仅在被关闭后，且在延迟时长内没有被再打开的数据才会被上传到云存储。 \nvfsreadchunksize | 否 | \\- 首次下载分片大小，单位为字节，默认为 128 MB。 \n\\- 当 vfsreadchunksize 大于 0\n时，文件总是以分片的形式被下载，且每次下载的分片被读取完毕后，下次下载的分片大小是前一次的两倍，直到分片大小达到 vfsreadchunksizelimit\n或文件被下载完毕为止。 \nvfsreadchunksizelimit | 否 | \\- 最大下载分片大小，单位为字节，默认为 off。 \n\\- 当下载的分片大小不断翻倍直到大于等于 vfsreadchunksizelimit 后，之后每次下载的分片大小总是等于\nvfsreadchunksizelimit，直到文件被下载完毕为止。 \nnochecksum | 否 | 上传下载时不再校验数据，默认为总是校验数据。 \nnomodtime | 否 | \\- 不再读写文件修改时间，默认为总是读写文件修改时间。 \n\\- 禁止读写文件修改时间可以提升文件系统的性能。 \nnoseek | 否 | 禁止文件寻址，默认为允许文件寻址。 \nreadonly | 否 | 只读文件系统，默认为可以修改文件系统。 \ntransfers | 否 | \\- 本地缓存上传并发度，默认为 4。 \n\\- 当本地写缓存被启用时，异步上传文件的并发度。 \n \n \n\n**编辑 ./csi-driver/examples/kodo/dynamic-provisioning/pvc.yaml**\n\n \n \n apiVersion: v1\n kind: PersistentVolumeClaim\n metadata:\n name: kodo-pvc # PVC 名称，可以修改\n spec:\n accessModes:\n - ReadWriteMany\n storageClassName: kodo-csi-sc # 指定对应的 StorageClass\n resources:\n requests:\n storage: 5Gi # 申请空间大小，可以修改\n \n\n \n\n**将 Secret，StorageClass，PVC 导入 Kubernetes**\n\n \n \n kubectl create -f ./csi-driver/examples/kodo/dynamic-provisioning\n \n\n \n\n# **将 PVC 挂载进容器**\n\n这里以 Nginx 容器为例，展示将 PVC 挂载进容器的方式 \n**编辑 ./csi-driver/examples/kodo/deploy.yaml**\n\n \n \n apiVersion: apps/v1\n kind: Deployment\n metadata:\n name: deployment-kodo\n labels:\n app: nginx\n spec:\n selector:\n matchLabels:\n app: nginx\n template:\n metadata:\n labels:\n app: nginx\n spec:\n containers:\n - name: nginx\n image: nginx:1.22.0-alpine\n ports:\n - containerPort: 80\n volumeMounts:\n - name: kodo-pvc # 指定 Volume 名称，与下面 Volume 的名称对应\n mountPath: \"/data\" # 挂载路径\n volumes:\n - name: kodo-pvc # Volume 名称，可以修改\n persistentVolumeClaim:\n claimName: kodo-pvc # 要挂载的 PVC 名称\n \n\n \n\n**将容器导入 Kubernetes 并启动**\n\n \n \n kubectl create -f ./csi-driver/examples/kodo/deploy.yaml\n \n\n \n\n# **高级参数详解**\n\n`vfscachemode` 表示文件在读写过程中在本地缓存的模式，可选值为 off，minimal，writes，full。 \n**off**\n\n * 默认模式，完全没有本地缓存，写入的数据直接上传到云存储，读取的数据也直接从云存储读取。\n * 该模式下： \n * 文件不能同时以读和写模式打开。\n * 通过写模式打开的文件无法被寻址。\n * 对于已经存在的文件，如果想要通过写模式打开，则必须添加 O_TRUNC 选项。\n * 如果上传失败了，将无法被重试。\n\n**minimal**\n\n * 仅对同时以读和写模式打开的文件提供本地缓存功能，文件将在本地缓存被写入完毕后异步上传到云存储。\n * 该模式下： \n * 仅通过写模式打开的文件无法被寻址。\n * 对于已经存在的文件，如果想要通过写模式打开，则必须添加 O_TRUNC 选项。\n * 如果上传失败了，将无法被重试。\n\n**writes**\n\n * 仅以读模式打开的文件将直接从云存储读取，以写模式打开或同时以读模式和写模式打开的文件都将在本地缓存被写入完毕后，文件将在本地被写入完毕后异步上传到云存储。\n * 该模式支持所有正常的文件操作。\n\n**full**\n\n * 无论读取还是写入操作，都会从本地缓存读写，写入操作与 writes 机制相同。\n * 对于读取操作，缓存会追踪已经读取的范围，并将下载的数据片段缓存在本地。\n * 该模式支持所有正常的文件操作。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储使用 Rclone 命令行工具管理对象存储 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[对象存储开源生态建设](https://developer.qiniu.com/kodo/best_practices/12275/the-third-\nparty-software-extension-support) > 使用 Rclone 命令行工具管理对象存储 Kodo\n\n# 使用 Rclone 命令行工具管理对象存储 Kodo\n\n最近更新时间: 2022-11-15 12:42:09\n\nRclone 是一个命令行工具，用来管理云上文件。Rclone 具有强大的云上处理功能，等效于 unix 命令\nrsync、cp、mv、mount、ls、ncdu、tree、rm 和 cat，其最初受 rsync 的启发并采用 Go 编写。当前，Rclone\n作为一个成熟的开源软件，已经拥有较为完备的文档和社区，可以提供广泛和友好的使用用例。\n\nRclone 功能非常丰富包括档案同步、文件传输、加密、缓存和挂载等，并且支持各大云存储供应商的接口、能提供统一的访问界面。从 v1.60.0\n开始，Rclone 可以通过 S3 协议对接七牛云对象存储 Kodo，以对 Kodo 进行对象存储管理，常用功能如：上传、下载、删除、数据迁移等。\n\n \n\n# **配置 Rclone**\n\n**关于 Rclone**\n\n * 查看 [Rclone 安装地址 __](https://rclone.org/install/)\n * 点击 [Github 地址 __](https://github.com/rclone/rclone.git)查看 Rclone 代码\n * 查看更多 [Rclone 命令 __](https://rclone.org/commands/)\n * 其他详情请参考 [Rclone 官方网站 __](https://rclone.org/) \n \n\n## **1、创建新的 remote 端**\n\n安装 Rclone 后，执行 rclone config，然后选择 n 创建新的 remote 端\n\n \n \n rclone config\n No remotes found, make a new one?\n n) New remote\n s) Set configuration password\n q) Quit config\n n/s/q> n\n \n\n## **2、为 remote 端命名**\n\n \n \n Enter name for new remote.\n name> qiniu\n \n\n## **3、选择七牛云对象存储 Kodo 所兼容的 S3**\n\n \n \n Option Storage.\n Type of storage to configure.\n Choose a number from below, or type in your own value.\n 1 / 1Fichier\n \\ (fichier)\n 2 / Akamai NetStorage\n \\ (netstorage)\n 3 / Alias for an existing remote\n \\ (alias)\n 4 / Amazon Drive\n \\ (amazon cloud drive)\n 5 / Amazon S3 Compliant Storage Providers including AWS, Alibaba, Ceph, China Mobile, Cloudflare, ArvanCloud, Digital Ocean, Dreamhost, Huawei OBS, IBM COS, IDrive e2, Lyve Cloud, Minio, Netease, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Tencent COS, **Qiniu** and Wasabi\n \\ (s3)\n 6 / Backblaze B2\n \\ (b2)\n 7 / Better checksums for other remotes\n \\ (hasher)\n 8 / Box\n \\ (box)\n 9 / Cache a remote\n \\ (cache)\n 10 / Citrix Sharefile\n \\ (sharefile)\n 11 / Combine several remotes into one\n \\ (combine)\n 12 / Compress a remote\n \\ (compress)\n 13 / Dropbox\n \\ (dropbox)\n 14 / Encrypt/Decrypt a remote\n \\ (crypt)\n 15 / Enterprise File Fabric\n \\ (filefabric)\n 16 / FTP\n \\ (ftp)\n 17 / Google Cloud Storage (this is not Google Drive)\n \\ (google cloud storage)\n 18 / Google Drive\n \\ (drive)\n 19 / Google Photos\n \\ (google photos)\n 20 / HTTP\n \\ (http)\n 21 / Hadoop distributed file system\n \\ (hdfs)\n 22 / HiDrive\n \\ (hidrive)\n 23 / Hubic\n \\ (hubic)\n 24 / In memory object storage system.\n \\ (memory)\n 25 / Internet Archive\n \\ (internetarchive)\n 26 / Jottacloud\n \\ (jottacloud)\n 27 / Koofr, Digi Storage and other Koofr-compatible storage providers\n \\ (koofr)\n 28 / Local Disk\n \\ (local)\n 29 / Mail.ru Cloud\n \\ (mailru)\n 30 / Mega\n \\ (mega)\n 31 / Microsoft Azure Blob Storage\n \\ (azureblob)\n 32 / Microsoft OneDrive\n \\ (onedrive)\n 33 / OpenDrive\n \\ (opendrive)\n 34 / OpenStack Swift (Rackspace Cloud Files, Memset Memstore, OVH)\n \\ (swift)\n 35 / Pcloud\n \\ (pcloud)\n 36 / Put.io\n \\ (putio)\n 37 / QingCloud Object Storage\n \\ (qingstor)\n 38 / SSH/SFTP\n \\ (sftp)\n 39 / Sia Decentralized Cloud\n \\ (sia)\n 40 / Storj Decentralized Cloud Storage\n \\ (storj)\n 41 / Sugarsync\n \\ (sugarsync)\n 42 / Transparently chunk/split large files\n \\ (chunker)\n 43 / Union merges the contents of several upstream fs\n \\ (union)\n 44 / Uptobox\n \\ (uptobox)\n 45 / WebDAV\n \\ (webdav)\n 46 / Yandex Disk\n \\ (yandex)\n 47 / Zoho\n \\ (zoho)\n 48 / premiumize.me\n \\ (premiumizeme)\n 49 / seafile\n \\ (seafile)\n Storage> s3 \n \n\n## **4、选择七牛云对象存储 Kodo 为后端**\n\n \n \n Option provider.\n Choose your S3 provider.\n Choose a number from below, or type in your own value.\n Press Enter to leave empty.\n 1 / Amazon Web Services (AWS) S3\n \\ (AWS)\n 2 / Alibaba Cloud Object Storage System (OSS) formerly Aliyun\n \\ (Alibaba)\n 3 / Ceph Object Storage\n \\ (Ceph)\n 4 / China Mobile Ecloud Elastic Object Storage (EOS)\n \\ (ChinaMobile)\n 5 / Cloudflare R2 Storage\n \\ (Cloudflare)\n 6 / Arvan Cloud Object Storage (AOS)\n \\ (ArvanCloud)\n 7 / Digital Ocean Spaces\n \\ (DigitalOcean)\n 8 / Dreamhost DreamObjects\n \\ (Dreamhost)\n 9 / Huawei Object Storage Service\n \\ (HuaweiOBS)\n 10 / IBM COS S3\n \\ (IBMCOS)\n 11 / IDrive e2\n \\ (IDrive)\n 12 / Seagate Lyve Cloud\n \\ (LyveCloud)\n 13 / Minio Object Storage\n \\ (Minio)\n 14 / Netease Object Storage (NOS)\n \\ (Netease)\n 15 / RackCorp Object Storage\n \\ (RackCorp)\n 16 / Scaleway Object Storage\n \\ (Scaleway)\n 17 / SeaweedFS S3\n \\ (SeaweedFS)\n 18 / StackPath Object Storage\n \\ (StackPath)\n 19 / Storj (S3 Compatible Gateway)\n \\ (Storj)\n 20 / Tencent Cloud Object Storage (COS)\n \\ (TencentCOS)\n 21 / Wasabi Object Storage\n \\ (Wasabi)\n 22 / Qiniu Object Storage (Kodo)\n \\ (Qiniu)\n 23 / Any other S3 compatible provider\n \\ (Other)\n provider> Qiniu\n \n\n## **5、提供七牛云对象存储 Kodo 的 AK/SK**\n\n \n \n Option env_auth.\n Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).\n Only applies if access_key_id and secret_access_key is blank.\n Choose a number from below, or type in your own boolean value (true or false).\n Press Enter for the default (false).\n 1 / Enter AWS credentials in the next step.\n \\ (false)\n 2 / Get AWS credentials from the environment (env vars or IAM).\n \\ (true)\n env_auth> 1\n \n\n输入七牛云对象存储 Kodo 的 AK\n\n \n \n Option access_key_id.\n AWS Access Key ID.\n Leave blank for anonymous access or runtime credentials.\n Enter a value. Press Enter to leave empty.\n access_key_id> **** AK ****\n \n\n输入七牛云对象存储 Kodo 的 SK\n\n \n \n Option secret_access_key.\n AWS Secret Access Key (password).\n Leave blank for anonymous access or runtime credentials.\n Enter a value. Press Enter to leave empty.\n secret_access_key> **** SK ****\n \n\n## **6、选择七牛云对象存储 Kodo 的 S3 地址**\n\n \n \n Option region.\n Region to connect to.\n Choose a number from below, or type in your own value.\n Press Enter to leave empty.\n / The default endpoint - a good choice if you are unsure.\n 1 | East China Region 1.\n | Needs location constraint cn-east-1.\n \\ (cn-east-1)\n / East China Region 2.\n 2 | Needs location constraint cn-east-2.\n \\ (cn-east-2)\n / North China Region 1.\n 3 | Needs location constraint cn-north-1.\n \\ (cn-north-1)\n / South China Region 1.\n 4 | Needs location constraint cn-south-1.\n \\ (cn-south-1)\n / Southeast Asia Region 1.\n 5 | Needs location constraint ap-southeast-1.\n \\ (ap-southeast-1)\n / North America Region.\n 6 | Needs location constraint us-north-1.\n \\ (us-north-1)\n region> 1\n \n \n \n Option endpoint.\n Endpoint for Qiniu Object Storage.\n Choose a number from below, or type in your own value.\n Press Enter to leave empty.\n 1 / East China Endpoint 1\n \\ (s3-cn-east-1.qiniucs.com)\n 2 / East China Endpoint 2\n \\ (s3-cn-east-2.qiniucs.com)\n 3 / North China Endpoint 1\n \\ (s3-cn-north-1.qiniucs.com)\n 4 / South China Endpoint 1\n \\ (s3-cn-south-1.qiniucs.com)\n 5 / North America Endpoint 1\n \\ (s3-us-north-1.qiniucs.com)\n 6 / Southeast Asia Endpoint 1\n \\ (s3-ap-southeast-1.qiniucs.com)\n endpoint> 1\n \n \n \n Option location_constraint.\n Location constraint - must be set to match the Region.\n Used when creating buckets only.\n Choose a number from below, or type in your own value.\n Press Enter to leave empty.\n 1 / East China Region 1\n \\ (cn-east-1)\n 2 / East China Region 2\n \\ (cn-east-2)\n 3 / North China Region 1\n \\ (cn-north-1)\n 4 / South China Region 1\n \\ (cn-south-1)\n 5 / North America Region 1\n \\ (us-north-1)\n 6 / Southeast Asia Region 1\n \\ (ap-southeast-1)\n location_constraint> 1\n \n\n## **7、 选择 ACL 和存储类型**\n\n \n \n Option acl.\n Canned ACL used when creating buckets and storing or copying objects.\n This ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too.\n For more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl\n Note that this ACL is applied when server-side copying objects as S3\n doesn't copy the ACL from the source but rather writes a fresh one.\n Choose a number from below, or type in your own value.\n Press Enter to leave empty.\n / Owner gets FULL_CONTROL.\n 1 | No one else has access rights (default).\n \\ (private)\n / Owner gets FULL_CONTROL.\n 2 | The AllUsers group gets READ access.\n \\ (public-read)\n / Owner gets FULL_CONTROL.\n 3 | The AllUsers group gets READ and WRITE access.\n | Granting this on a bucket is generally not recommended.\n \\ (public-read-write)\n / Owner gets FULL_CONTROL.\n 4 | The AuthenticatedUsers group gets READ access.\n \\ (authenticated-read)\n / Object owner gets FULL_CONTROL.\n 5 | Bucket owner gets READ access.\n | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.\n \\ (bucket-owner-read)\n / Both the object owner and the bucket owner get FULL_CONTROL over the object.\n 6 | If you specify this canned ACL when creating a bucket, Amazon S3 ignores it.\n \\ (bucket-owner-full-control)\n acl> 2\n \n \n \n Option storage_class.\n The storage class to use when storing new objects in Qiniu.\n Choose a number from below, or type in your own value.\n Press Enter to leave empty.\n 1 / Standard storage class\n \\ (STANDARD)\n 2 / Infrequent access storage mode\n \\ (LINE)\n 3 / Archive storage mode\n \\ (GLACIER)\n 4 / Deep archive storage mode\n \\ (DEEP_ARCHIVE)\n storage_class> 1\n \n\n## **8、确认配置**\n\n \n \n Edit advanced config?\n y) Yes\n n) No (default)\n y/n> n\n \n \n \n Configuration complete.\n Options:\n - type: s3\n - provider: Qiniu\n - access_key_id: 0p6YmsTFa-MLL4cZhe2Yj8n7nXZ3N_xxxxxxxxxx\n - secret_access_key: zU9otHDc562WBIDEyExxTlEy9_xxxxxxxxxxxxxx\n - region: cn-east-1\n - endpoint: s3-cn-east-1.qiniucs.com\n - location_constraint: cn-east-1\n - acl: public-read\n - storage_class: STANDARD\n Keep this \"qiniu\" remote?\n y) Yes this is OK (default)\n e) Edit this remote\n d) Delete this remote\n y/e/d> y\n \n \n \n Current remotes:\n \n Name Type\n ==== ====\n qiniu s3\n \n e) Edit existing remote\n n) New remote\n d) Delete remote\n r) Rename remote\n c) Copy remote\n s) Set configuration password\n q) Quit config\n e/n/d/r/c/s/q> q\n \n\n \n\n# **通过 Rclone 管理七牛云对象存储 Kodo 的常用命令**\n\n## **列举**\n\n仅仅列举对象完整路径和大小\n\n \n \n rclone ls qiniu:bucket-name/directory-path\n \n\n额外列举对象修改时间\n\n \n \n rclone lsl qiniu:bucket-name/directory-path\n \n\n仅仅列举目录\n\n \n \n rclone lsd qiniu:bucket-name/directory-path\n \n\n列举目录和文件，目录以 / 结尾\n\n \n \n rclone lsf qiniu:bucket-name/directory-path\n \n\n列举对象所有信息，以 JSON 的形式\n\n \n \n rclone lsjson qiniu:bucket-name/directory-path\n \n\n以树的形式列举目录和文件\n\n \n \n rclone tree qiniu:bucket-name/directory-path\n \n\n以 CUI 的形式列举目录和文件\n\n \n \n rclone ncdu qiniu:bucket-name/directory-path\n \n\n## **读取**\n\n从云存储读取对象内容\n\n \n \n rclone cat qiniu:dest-bucket-name/dest-path\n \n\n从云存储获取对文件下载地址\n\n \n \n rclone link qiniu:dest-bucket-name/dest-path\n \n\n从云存储目录计算对象数量和总大小\n\n \n \n rclone size qiniu:dest-bucket-name/dest-directory-path\n \n\n## **上传**\n\n从标准输入流获取数据并上传到云存储\n\n \n \n cat local-path | rclone rcat qiniu:dest-bucket-name/dest-path\n \n\n## **同步**\n\n从本地同步到云存储\n\n \n \n rclone sync local-path qiniu:dest-bucket-name/dest-directory-path\n \n\n从云存储同步到云存储\n\n \n \n rclone sync qiniu:src-bucket-name/src-directory-path qiniu:dest-bucket-name/dest-directory-path\n \n\n对比本地与云存储\n\n \n \n rclone check local-path qiniu:dest-bucket-name/dest-directory-path\n \n\n对比云存储与云存储\n\n \n \n rclone check qiniu:src-bucket-name/src-directory-path qiniu:dest-bucket-name/dest-directory-path\n \n\n## **移动**\n\n移动目录\n\n \n \n rclone move qiniu:src-bucket-name/src-directory-path qiniu:dest-bucket-name/dest-directory-path\n \n\n移动文件\n\n \n \n rclone moveto qiniu:src-bucket-name/src-path qiniu:dest-bucket-name/dest-path\n \n\n## **复制**\n\n从指定 URL 复制内容到云存储\n\n \n \n rclone copyurl https://url qiniu:dest-bucket-name/dest-path\n \n\n复制目录\n\n \n \n rclone copy qiniu:src-bucket-name/src-directory-path qiniu:dest-bucket-name/dest-directory-path\n \n\n复制文件\n\n \n \n rclone copyto qiniu:src-bucket-name/src-path qiniu:dest-bucket-name/dest-path\n \n\n## **删除**\n\n删除目录\n\n \n \n rclone delete qiniu:bucket-name/dest-directory-path\n \n\n删除文件\n\n \n \n rclone deletefile qiniu:bucket-name/dest-path\n \n\n## **修改存储类型**\n\n修改目录\n\n \n \n rclone settier STORAGE_CLASS qiniu:bucket-name/dest-directory-path\n \n\n修改文件\n\n \n \n rclone settier STORAGE_CLASS qiniu:bucket-name/dest-path\n \n\n## **校验**\n\n校验目录\n\n \n \n rclone hashsum MD5 qiniu:bucket-name/dest-directory-path\n \n\n \n\n# **通过 Rclone 对接到七牛云对象存储 Kodo 的常用命令**\n\n将 Kodo 用作 HTTP 服务器\n\n \n \n rclone serve http qiniu:bucket-name/dest-directory-path --addr ip:port\n \n\n将 Kodo 用作 FTP 服务器\n\n \n \n rclone serve ftp qiniu:bucket-name/dest-directory-path --addr ip:port\n \n\n将 Kodo 作为文件系统挂载到挂载点上\n\n \n \n rclone mount qiniu:bucket-name/dest-directory-path mount-point\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储使用 Restic 备份工具对接对象存储 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[对象存储开源生态建设](https://developer.qiniu.com/kodo/best_practices/12275/the-third-\nparty-software-extension-support) > 使用 Restic 备份工具对接对象存储 Kodo\n\n# 使用 Restic 备份工具对接对象存储 Kodo\n\n最近更新时间: 2023-07-19 17:49:45\n\nRestic 是一款 GO 语言开发的，快速、高效且安全的跨平台备份工具。Restic\n支持备份增量数据，并且操作十分简单、可以随时备份和恢复备份。Restic 使用加密技术来保证数据安全性和完整性，可以将本地数据加密后传输到指定的存储。 \nRestic 支持大多数主流操作系统，比如：Linux、macOS、Windows 以及一些小众的操作系统，比如：FreeBSD 和 OpenBSD 等。 \nRestic 可以通过 S3 协议对接到七牛云对象存储 Kodo，常用功能如：数据备份、恢复备份等。\n\n \n\n# **配置 Restic**\n\n**关于 Restic**\n\n * 查看 [Restic 安装 __](https://restic.readthedocs.io/en/stable/020_installation.html#)\n * 查看 [Restic 常见问题 __](https://restic.readthedocs.io/en/stable/faq.html)\n * 其他详情请参考 [Restic 官方网站 __](https://restic.readthedocs.io/en/stable/010_introduction.html) \n \n\n## **初始化**\n\n安装 Restic 后，执行下述初始化命令: \n1、提供七牛云对象存储 Kodo 的 AK/SK\n\n \n \n export AWS_ACCESS_KEY_ID=<QINIU_ACCESS_KEY> AWS_SECRET_ACCESS_KEY=<QINIU_SECRET_KEY>\n \n\n2、通过 S3 协议对接 Restic \n提供指定的七牛云对象存储 Kodo 空间，并按需指定对应的访问 Endpoint （可参考[服务域名\n__](https://developer.qiniu.com/kodo/4088/s3-access-domainname)）。\n\n \n \n restic -r s3:s3.<Region-ID>.qiniucs.com/<bucket_name> -o s3.region=<Region-ID> init\n \n\n初始化完成后，即可使用 Restic 工具。 \n \n\n# **通过 Restic 对接七牛云对象存储 Kodo 的常用命令**\n\n## **备份**\n\n创建备份\n\n \n \n restic -r s3:s3.<Region-ID>.qiniucs.com/<bucket_name> --verbose backup <path/to/backup>\n \n\n## **列举备份**\n\n列出所有快照\n\n \n \n restic -r s3:s3.<Region-ID>.qiniucs.com/<bucket_name> snapshots\n \n\n按指定 ID 列出快照\n\n \n \n restic -r s3:s3.<Region-ID>.qiniucs.com/<bucket_name> ls <snapshotID>\n \n\n## **恢复备份**\n\n从指定版本恢复备份\n\n \n \n restic -r s3:s3.<Region-ID>.qiniucs.com/<bucket_name> restore <snapshotID> --target <path/to/restore>\n \n\n将备份作为常规文件系统进行浏览\n\n \n \n restic -r s3:s3.<Region-ID>.qiniucs.com/<bucket_name> mount <path/to/mount>\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储使用 Terraform 管理对象存储 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[对象存储开源生态建设](https://developer.qiniu.com/kodo/best_practices/12275/the-third-\nparty-software-extension-support) > 使用 Terraform 管理对象存储 Kodo\n\n# 使用 Terraform 管理对象存储 Kodo\n\n最近更新时间: 2022-11-29 18:08:17\n\nTerraform 是一个开源的自动化的资源编排工具，可以用代码来管理维护 IT 资源。Terraform 的命令行接口（CLI）\n提供一种简单机制，用于将配置文件部署到七牛云或其他任意支持的云上，并对其进行版本控制。它编写了描述云资源拓扑的配置文件中的基础结构，例如虚拟机、存储帐户和网络接口等。Terraform\n通过 Provider 来支持新的基础架构，是一个高度可扩展的工具。\n\n[七牛云Provider __](https://github.com/qiniu/terraform-provider-\nqiniu)依据标准定义了对象存储的 Resource 和 Data Source，您可以使用 Terraform 来管理七牛云对象存储的资源。\n\n# **安装七牛云 Provider**\n\n**1\\. Clone repository**\n\n \n \n $ git clone [email protected]:qiniu/terraform-provider-qiniu.git --recurse-submodules\n \n\n**2\\. Build the provider**\n\n \n \n $ cd terraform-provider-qiniu\n $ make\n \n\n**3\\. Install the provider**\n\n \n \n mkdir -p ~/.terraform.d/plugins\n mv bin/terraform-provider-qiniu ~/.terraform.d/plugins\n \n\n**4\\. 创建配置文件** \n配置 provider 信息，创建 provider.tf 文件，按以下格式配置身份认证信息\n\n \n \n provider \"qiniu\" {\n access_key = \"<Qiniu Access Key>\"\n secret_key = \"<Qiniu Secret Key>\"\n }\n \n\n**5\\. 初始化目录**\n\n \n \n $ terraform init\n \n\n \n\n# **使用 Terraform 管理七牛云对象存储**\n\nProvider 安装以后，就可以通过 Terraform 的操作命令来管理七牛云对象存储了。\n\n## **创建 Bucket**\n\n \n \n resource \"qiniu_bucket\" \"basic_bucket\" {\n name = \"basic-test-terraform-1\" \n region_id = \"z0\" \n private = false \n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nname | 是 | 空间名 \nregion_id | 是 | 空间所属区域 \nprivate | 否 | 空间是否为 private \n \n \n\n## **设置空间标签**\n\n七牛云 Provider 1.0.2 及以上的版本支持。\n\n \n \n resource \"qiniu_bucket\" \"basic_bucket\" {\n name = \"basic-test-terraform-1\" \n region_id = \"z0\" \n tagging = {\n env = \"test\" \n kind = \"basic\" \n }\n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nname | 是 | 空间名 \nregion_id | 是 | 空间所属区域 \ntagging | 是 | 空间标签，每对标签由一对 key-value 组成；每个空间最多设置 10 对标签 \n \n \n\n## **开启默认首页功能**\n\n七牛云 Provider 1.0.2 及以上的版本支持。\n\n \n \n resource \"qiniu_bucket\" \"basic_bucket\" {\n name = \"basic-test-terraform-1\" \n region_id = \"z0\" \n index_page_on = true \n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nname | 是 | 空间名 \nregion_id | 是 | 空间所属区域 \nindex_page_on | 是 | 是否开启默认首页功能；true 表示开启 \n \n \n\n## **设置客户端缓存 maxAge**\n\n七牛云 Provider 1.0.2 及以上的版本支持。\n\n \n \n resource \"qiniu_bucket\" \"basic_bucket\" {\n name = \"basic-test-terraform-1\" \n region_id = \"z0\" \n max_age = 3600 \n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nname | 是 | 空间名 \nregion_id | 是 | 空间所属区域 \nmax_age | 是 | 客户端缓存最大时长，单位秒。不设置时，默认为 31536000。 \n \n \n\n## **设置生命周期规则**\n\n七牛云 Provider 1.0.2 及以上的版本支持。\n\n \n \n resource \"qiniu_bucket\" \"basic_bucket\" {\n name = \"basic-test-terraform-1\" \n region_id = \"z0\" \n lifecycle_rules {\n name = \"rule_1\" \n prefix = \"users/\" \n to_line_after_days = 20 \n delete_after_days = 30 \n }\n lifecycle_rules { \n name = \"rule_2\" \n prefix = \"admin/\" \n to_line_after_days = 40 \n delete_after_days = 60 \n } \n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nname | 是 | 空间名 \nregion_id | 是 | 空间所属区域 \nlifecycle_rules | 是 | 空间的生命周期规则 \n \nlifecycle_rules的配置支持：\n\n参数 | 必填 | 说明 \n---|---|--- \nname | 是 | 规则名称 \nprefix | 是 | 规则匹配的 Objects 的前缀；为空时表示整个 Bucket 生效；前缀为空的规则只能设置一条 \nto_line_after_days | 否 | 设置新创建的文件在指定天数后自动转为低频存储 \ndelete_after_days | 否 | 设置新创建的文件在指定天数后自动删除；与 to_line_after_days 同时设置时，值需要大于 to_line_after_days \n \n \n\n## **设置空间 Referer 防盗链**\n\n七牛云 Provider 1.0.2 及以上的版本支持。\n\n \n \n resource \"qiniu_bucket\" \"basic_bucket\" {\n name = \"basic-test-terraform-1\" \n region_id = \"z0\" \n anti_leech_mode = \"blacklist\" \n referer_pattern = [\"foo.com\", \"*.bar.com\", \"sub.foo.com\"] \n allow_empty_referer = true \n only_enable_anti_leech_for_cdn = false \n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nname | 是 | 空间名 \nregion_id | 是 | 空间所属区域 \nanti_leech_mode | 是 | 防盗链模式；支持白名单 (whitelist) 或黑名单模式 (blacklist) \nreferer_pattern | 是 | referer 规则；支持多条，以 , 分隔 \nonly_enable_anti_leech_for_cdn | 是 | 是否开启源站防盗链；必须设置为 false，表示开启源站防盗链，对空间的所有访问请求均生效 \nallow_empty_referer | 否 | 是否允许空 Referer \n \n详细配置说明可以参见 [设置空间的Referer防盗链规则\n__](https://developer.qiniu.com/kodo/manual/6093/set-the-hotlinking-\nprevention) \n \n\n## **设置跨域访问规则**\n\n七牛云 Provider 1.0.2 及以上的版本支持。 \n不做设置时，默认允许任何跨域访问请求。\n\n \n \n resource \"qiniu_bucket\" \"basic_bucket\" {\n name = \"basic-test-terraform-1\" \n region_id = \"z0\" \n cors_rules {\n allowed_origins = [\"http://www.test1.com\"] \n allowed_methods = [\"GET\", \"POST\"] \n allowed_headers = [\"X-Reqid\", \"Content-Type\"] \n exposed_headers = [\"X-Test-1\", \"X-Test-2\"] \n max_age = 20 \n }\n cors_rules { \n allowed_origins = [\"http://www.test2.com\"] \n allowed_methods = [\"GET\", \"POST\", \"HEAD\"] \n } \n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nname | 是 | 空间名 \nregion_id | 是 | 空间所属区域 \ncors_rules | 是 | 空间的跨域访问规则；最多10条 \n \ncors_rules的配置支持：\n\n参数 | 必填 | 说明 \n---|---|--- \nallowed_origins | 是 | 允许的跨域请求的来源 \nallowed_methods | 是 | 允许的跨域请求方法 \nallowed_headers | 否 | 允许的跨域请求的响应头 \nexposed_headers | 否 | 允许用户从应用程序中访问的响应头 \nmax_age | 否 | 浏览器对特定资源的预取（OPTIONS）请求返回结果的缓存时间 \n \n详细配置说明可以参见 [设置空间的跨域资源共享 __](https://developer.qiniu.com/kodo/manual/6094/set-\ncors) \n \n\n## **创建 Object**\n\n \n \n resource \"qiniu_bucket_object\" \"basic_object\" {\n bucket = \"basic-test-terraform-1\" \n key = \"qiniu-key\" \n source = \"/path/to/file\"\n storage_type = \"infrequent\"\n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nbucket | 是 | 空间名 \nkey | 是 | Object name \nsource | 否 | 待上传 Object 的存放路径 \nstorage_type | 否 | Object 的存储类型；infrequent 表示低频存储类型，为空或不设置表示标准存储类型 \n \n \n\n## **导入已有资源**\n\n可以通过 import 命令导入已有的 Bucket 和 Object。以 Bucket 举例如下： \n首先，配置 Bucket 信息\n\n \n \n resource \"qiniu_bucket\" \"importbucket\" {\n name = \"video\" \n region_id = \"z0\" \n }\n \n\n然后使用 import 命令导入 video 这个 Bucket\n\n \n \n terraform import qiniu_bucket.importbucket video\n \n\n \n\n# **七牛云对象存储 Data Source**\n\n## **qiniu_regions**\n\n \n \n data \"qiniu_regions\" \"China\" {\n id_regex = \"^z\" \n description_regex = \"China\" \n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nid_regex | 否 | 区域 id 的正则匹配规则 \ndescription_regex | 否 | 区域描述的正则匹配规则 \n \n \n\n## **qiniu_buckets**\n\n \n \n data \"qiniu_buckets\" \"z1\" {\n name_regex = \"^bucket-\"\n region_id = \"z1\"\n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nname_regex | 是 | 空间名的正则匹配规则 \nregion_id | 是 | 空间所属区域 \n \n \n\n## **qiniu_buckets_objects**\n\n \n \n data \"qiniu_buckets_objects\" \"all\" {\n bucket = \"basic-test-terraform-1\"\n }\n \n\n参数说明：\n\n参数 | 必填 | 说明 \n---|---|--- \nbucket | 是 | 空间名的正则匹配规则 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储数据迁移"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 > 数据迁移\n\n# 数据迁移\n\n最近更新时间: 2024-04-11 14:43:45\n\n * [热数据无缝迁移](https://developer.qiniu.com/kodo/best_practices/12664/hotdata_to_kodo)\n * [本地数据迁移至 Kodo](https://developer.qiniu.com/kodo/best_practices/12662/localfiles_to_kodo)\n * [第三方云存储数据迁移至 Kodo](https://developer.qiniu.com/kodo/best_practices/12661/cs_to_kodo)\n * [以 URL 作为源地址的数据迁移至 Kodo](https://developer.qiniu.com/kodo/best_practices/12663/urls_to_kodo)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储热数据无缝迁移"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据迁移](https://developer.qiniu.com/kodo/best_practices/12660/data-migration) >\n热数据无缝迁移\n\n# 热数据无缝迁移\n\n最近更新时间: 2024-04-25 10:37:52\n\n对象存储 Kodo 提供 [镜像回源](https://developer.qiniu.com/kodo/8611/dev-the-mirror-back-\nto-the-source) 的功能，能够支持用户将业务热数据无缝迁移到七牛，并且在迁移过程中不影响原有业务系统的访问。 \n同时空间开启镜像回源后，也只会把数据源站中有读写访问请求的数据自动迁移至\nKodo，可以帮助用户快速对数据进行冷热分层，按需只把热数据全部迁移至云端、而冷数据保留在源站。\n\n迁移操作步骤如下：\n\n 1. 登录**对象存储控制台** ，在待迁移数据的目标存储空间中开启镜像设置\n 2. 配置镜像回源地址，然后保存\n 3. 将业务系统的读写请求转到对象存储 Kodo 上\n\n具体的配置方法请参见 [设置镜像回源](https://developer.qiniu.com/kodo/8542/set-up-the-mirror-\nback-to-the-source) 文档。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储本地数据迁移至 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据迁移](https://developer.qiniu.com/kodo/best_practices/12660/data-migration) >\n本地数据迁移至 Kodo\n\n# 本地数据迁移至 Kodo\n\n最近更新时间: 2024-04-25 10:37:30\n\n对于拥有本地数据存储的用户，对象存储 Kodo 提供了一体化迁移工具 Kodoimport，用户只需要通过简单的配置操作，便可将数据快速迁移至 Kodo\n中。\n\n迁移工具 Kodoimport\n\n * 支持单机模式和分布式模式。单机模式部署简单使用方便，但是单机模式迁移能力有限，如果有大规模数据迁移需求分布式模式更为合适。\n * 支持迁移特定前缀的文件。\n * 支持为迁移目标设置特定前缀。\n * 支持断点续传。\n * 支持并行数据下载和上传。\n * 支持数据校验。\n * 支持增量迁移。\n * 支持流量控制。\n\n迁移操作步骤如下：\n\n 1. 下载、安装工具\n 2. 修改配置文件\n 3. 启动工具\n\n具体的操作方法，请参见 [Kodoimport 工具](https://developer.qiniu.com/kodo/6435/kodoimport)\n文档。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储第三方云存储数据迁移至 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据迁移](https://developer.qiniu.com/kodo/best_practices/12660/data-migration) >\n第三方云存储数据迁移至 Kodo\n\n# 第三方云存储数据迁移至 Kodo\n\n最近更新时间: 2024-05-07 11:04:42\n\n对于使用了第三方云存储的用户，在线数据迁移服务可以帮您将其他兼容 AWS S3 协议的云服务商对象存储服务的数据快速迁移至\nKodo（比如阿里云、腾讯云、华为云等厂商的对象存储）。\n\n在线数据迁移服务\n\n * 提供直观的迁移统计信息，包括迁移存储量、迁移文件数量、迁移进度等\n * 支持迁移指定时间段内的文件\n * 支持全量覆盖或按修改时间的覆盖策略\n * 支持文件一致性校验、任务重试\n * 支持设置迁移的流控时段和最大速率\n\n\n\n迁移操作步骤如下：\n\n 1. 登录**对象存储控制台**\n 2. 在左侧导航栏中单击数据迁移，进入数据迁移页面\n 3. 单击新建任务，新建迁移任务并配置任务信息\n 4. 根据源站情况配置分时段的迁移限速\n 5. 保存后自动启动任务\n\n详细操作可参见：[设置数据迁移](https://developer.qiniu.com/kodo/12666/set-data-migration)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储以 URL 作为源地址的数据迁移至 Kodo"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 最佳实践 >\n[数据迁移](https://developer.qiniu.com/kodo/best_practices/12660/data-migration) >\n以 URL 作为源地址的数据迁移至 Kodo\n\n# 以 URL 作为源地址的数据迁移至 Kodo\n\n最近更新时间: 2024-05-06 11:21:06\n\n对于用户想要使用 URL 列表作为数据源地址进行数据迁移，对象存储 Kodo 支持以下迁移方式\n\n * 在线数据迁移服务：全托管式在线迁移、提供可视化界面，能够帮助用户轻松管理大规模的数据迁移任务。\n * 一体化迁移工具 Kodoimport：用户只需要通过简单的配置操作，便可将数据快速迁移至 Kodo 中\n\n### **在线数据迁移服务**\n\n在线数据迁移服务\n\n * 提供直观的迁移统计信息，包括迁移存储量、迁移文件数量、迁移进度等\n * 支持全量覆盖或按修改时间的覆盖策略\n * 支持文件一致性校验、任务重试\n * 支持设置迁移的流控时段和最大速率\n\n迁移操作步骤如下：\n\n 1. 登录对象存储控制台\n 2. 在左侧导航栏中单击数据迁移，进入数据迁移页面\n 3. 单击新建任务，新建迁移任务并配置任务信息\n 4. 根据源站情况配置分时段的迁移限速\n 5. 保存后自动启动任务\n\n详细操作可参见：[设置数据迁移](https://developer.qiniu.com/kodo/12666/set-data-migration)\n\n### **迁移工具 Kodoimport**\n\n迁移工具 Kodoimport\n\n * 支持单机模式和分布式模式。单机模式部署简单使用方便，但是单机模式迁移能力有限，如果有大规模数据迁移需求分布式模式更为合适。\n * 支持为迁移目标设置特定前缀。\n * 支持断点续传。\n * 支持并行数据下载和上传。\n * 支持数据校验。\n * 支持流量控制。\n\n迁移操作步骤如下：\n\n 1. 下载、安装工具\n 2. 修改配置文件\n 3. 启动工具\n\n具体的操作方法，请参见 [Kodoimport 工具](https://developer.qiniu.com/kodo/6435/kodoimport)\n文档。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储服务等级协议（SLA）"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 服务协议 > 服务等级协议（SLA）\n\n# 服务等级协议（SLA）\n\n最近更新时间: 2023-12-25 14:18:14\n\n**版本生效日期：2019 年 4 月 28 日**\n\n**为使用七牛云对象存储服务（以下简称“本服务”），您应当阅读并遵守《七牛云对象存储服务等级协议》（以下简称“本协议”或“SLA”），以及[《七牛云服务用户协议》\n__](https://www.qiniu.com/user-agreement)和[《七牛云隐私权政策》\n__](https://www.qiniu.com/privacy-\nright)。本协议包含本服务的术语和定义、服务可用性/服务成功率等级指标、赔偿方案、免责条款等相关内容。请您务必审慎阅读、充分理解各条款内容，特别是限制、免责条款或者其他涉及您重大权益的条款，这类条款可能会以加粗等形式提示您重点注意。**\n\n**除非您已充分阅读、完全理解并接受本协议所有条款，否则，请您不要购买本服务。您单击“同意”、“下一步”或您的购买、使用等行为或者您以其他任何明示或者默示方式表示接受本协议的，即视为您已阅读并同意本协议的约束。本协议即在您与七牛云之间产生法律效力，成为对双方均具有约束力的法律文件。** \n \n\n## **1.术语和定义**\n\n**七牛云对象存储** ：对象存储是一种基于 HTTP\n协议网络接口上传、下载和管理数据资源，按需扩容的非结构化数据存储服务。对象存储以预付费或后付费的方式提供服务。\n\n**服务周期** ：服务周期是指购买本服务的服务期限所包含的自然月。如用户是3月11日开通服务，则服务周期计算到3月31日。\n\n**月度服务费用** ：指客户的某一个七牛云账号在一个自然月中使用七牛云对象存储服务按地域和存储类型分别统计的服务费用。\n\n**有效请求** ：七牛云对象存储服务端收到的请求视为有效请求，**但不包括以下类型的请求** ：\n\n（1）未通过身份验证和鉴权失败的请求或欠费停服状态下的请求；\n\n（2）跨区域同步数据和生命周期管理等各类后端异步处理发起的所有请求；\n\n（3）获取Bucket列表发起的所有请求；\n\n（4）查询统计数据的请求；\n\n（5）客户的应用程序受到黑客攻击而发起的请求。\n\n**失败请求**\n：七牛云对象存储服务将HTTP状态码为5XX的请求和因七牛对象存储服务故障导致的用户正常请求未能到达服务端的请求均视为失败请求，**但不包括以下类型的请求**\n：\n\n（1）因采用不适当的访问模式导致请求超出对象存储服务的规定配额，造成请求被对象存储限制的错误请求 (HTTP状态码573)；\n\n（2）跨区域同步数据和生命周期管理等各类后端异步处理的失败请求；\n\n（3）获取Bucket列表产生的失败请求；\n\n（4）非七牛服务造成的慢请求或失败请求 (HTTP状态码579)：\n\n1）镜像回源超时或失败的请求；\n\n2）Callback超时或失败的请求；\n\n（5）查询统计数据的失败请求；\n\n（6）由七牛云对象存储服务发起的合理升级、变更、停机而导致的错误请求或服务不可用情况；\n\n（7）客户的应用程序受到黑客攻击而导致被七牛云存储服务限制的请求。\n\n**每5分钟错误率**\n：根据地域和存储类型分别统计的失败请求占5分钟内客户有效请求数的比例，同一账号下相同地域、相同存储类型的多个Bucket，将合并计算错误率。具体计算方式如下：\n\n**每 5 分钟错误率 = (每 5 分钟失败请求数 / 每 5 分钟有效请求数) × 100%** \n \n\n## **2.服务可用性** \n\n### **2.1 服务可用性计算** \n\n七牛云对象存储根据不同地域和存储类型统计对应的服务可用性，同一账号下相同地域、相同存储类型的多个Bucket，将合并计算服务可用性。服务可用性的具体计算方式如下：\n\n**服务可用性 = (1 - (服务周期内的每 5 分钟错误率之和 / 服务周期内的 5 分钟总个数)) × 100%**\n\n注：服务周期内的5分钟总个数=12 x 24 x 该服务周期的天数 \n\n### **2.2 服务可用性承诺** \n\n客户可以通过七牛云对象存储提供的API、SDK、控制台或工具对数据进行上传、下载和管理。针对不同的存储类型，七牛云对象存储分别承诺服务可用性如下：\n\n存储类型 | 服务可用性标准 \n---|--- \n标准存储 | 99.9% \n低频存储 / 归档直读存储 / 归档存储 / 深度归档存储 | 99.0% \n \n**如七牛云对象存储服务未达到上述服务可用性承诺，客户可依据本协议第3条约定获得赔偿** \n\n## **3.赔偿方案** \n\n客户账号按地域及存储类型分别统计各服务周期内的服务可用性，如低于2.2承诺的可用性标准，可按照以下条款约定获得赔偿\n\n### **3.1 赔偿标准** \n\n（1）**赔偿只针对已经使用七牛云对象存储服务并且正常支付费用的客户（除法律法规另有规定外，免费型服务不在赔偿范围内）；赔偿方式仅限于用于支付七牛云对象存储的抵用券，抵用券的使用遵循七牛云发布的相关规则。**\n\n（2）**赔偿额按照服务可用性未达标的服务月度单独计算，且不超过该服务周期内该地域该存储类型所支付月度服务费用的50%（不含抵用券、优惠券等抵扣费用）。赔偿额具体计算方式如下：**\n\n\n\n### **3.2 赔偿申请时限** \n\n（1）客户可以每月**第五(5)个**\n工作日后，对上个服务周期没有达到可用性的服务，通过账户的工单系统提出赔偿申请。赔偿申请提出后七牛云会进行相应审核，对于服务周期的服务可用性计算，若双方出现争议，**双方均同意最终以七牛云的后台记录为准**\n。\n\n（2）**赔偿申请必须在服务可用性未达标的服务周期结束后两（2）个月内提出。若在两（2）个月内未提出赔偿申请，或是在服务可用性未达标的服务周期结束后的两（2）个月以后才提出赔偿申请，均视为客户主动放弃要求赔偿及向七牛云主张其他权利的权利，七牛云有权不受理客户的赔偿申请，不对客户进行任何赔偿或补偿。** \n \n\n## **4.免责条款** \n\n由于以下原因造成的服务不可用，相应服务不可用时间不属于服务不可用的计算范畴和七牛云的赔偿范围，七牛云无需向客户承担责任：\n\n**4.1 七牛云预先通知客户后进行系统维护所引起的，包括割接、维修、升级和模拟故障演练；**\n\n**4.2 任何七牛云所属设备以外的网络、设备或配置调整引起的故障;**\n\n**4.3 客户的应用程序或数据信息受到黑客攻击而引起的；**\n\n**4.4 客户维护不当或保密不当致使数据、口令、密码等丢失或泄漏所引起的；**\n\n**4.5 客户自行升级操作系统所引起的；**\n\n**4.6 客户的应用程序或安装活动所引起的；**\n\n**4.7 客户的疏忽或由用户授权的操作所引起的；**\n\n**4.8 不可抗力以及意外事件引起的；**\n\n**4.9 其他非七牛云原因所造成的不可用或服务不达标；**\n\n**4.10 属于相关法律法规、相关协议、相关规则或七牛云单独发布的相关规则、说明等中所述的七牛云可以免责、免除赔偿责任等的情况** \n \n\n## **5.其他** \n\n**5.1\n七牛云有权根据变化适时或必要时对本协议条款做出修改，您可以在七牛云官网的最新版本中查阅相关协议条款。如您不同意七牛云对协议所做的修改，您有权停止使用本服务，如您继续使用本服务，则视为您接受修改后的协议。** \n\n**5.2 本协议作为[《七牛云服务用户协议》 __](https://www.qiniu.com/user-\nagreement)的附属协议，具有与[《七牛云服务用户协议》 __](https://www.qiniu.com/user-\nagreement)同等效力，本协议未约定事项，您需遵守[《七牛云服务用户协议》 __](https://www.qiniu.com/user-\nagreement)的相关约定。若本协议与[《七牛云服务用户协议》 __](https://www.qiniu.com/user-\nagreement)中的条款相冲突或不一致，则以本协议为准，但仅在该冲突或不一致范围内适用。**\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储Q"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 术语表 > Q\n\n# Q\n\n最近更新时间: 2021-05-13 21:23:52\n\n \n**签名密钥**\n\n签名密钥 (Secret Key) 简称 SK\n，是七牛云存储颁发给用户，用于对访问请求签名的字串。用户使用签名密钥对访问请求的核心要素进行签名，获得请求认证[令牌](https://developer.qiniu.com/kodo/glossary/1646/l#token)。用户将令牌随同访问请求一起发送至七牛云存储服务，七牛云存储将对令牌进行校验，以确认用户请求的合法性。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储E"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 术语表 > E\n\n# E\n\n最近更新时间: 2017-01-20 16:54:40\n\n**ETag**\n\nETag为HTTP协议的一部分，它是 HTTP 提供web缓存验证机制之一。以这种方式使用etag类似于指纹,他们可以通过快速比较来确定两个资源是否相同。\n\n**Exif**\n\nExif 意指可交换图像文件格式，专门为数码相机的照片所设计，可以记录数码照片的属性信息和拍摄数据。Exif\n信息是由数码相机在拍摄过程中采集的一系列信息，然后这些信息放置在我们熟知的 JPEG/TIFF 文件的头部。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储H"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 术语表 > H\n\n# H\n\n最近更新时间: 2017-01-19 19:05:51\n\n**HTTP Referer**\n\nHTTP\nReferer是header的一部分，当浏览器向web服务器发送请求的时候，一般会带上Referer，告诉服务器我是从哪个页面链接过来的，服务器藉此可以获得一些信息用于处理。\n\n**HMAC-SHA1**\n\nHMAC是哈希运算消息认证码 (Hash-based Message Authentication\nCode)，HMAC运算利用哈希算法，以一个密钥和一个消息为输入，生成一个消息摘要作为输出。您可以使用它同时验证数据的完整性和消息的真实性。HMAC-\nSHA1签名算法是一种常用的签名算法，用于对一段信息进行生成签名摘要。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储J"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 术语表 > J\n\n# J\n\n最近更新时间: 2021-05-14 18:40:49\n\n \n**键 (key)**\n\n空间中资源的唯一标识符。空间中的每个资源都有一个对应的键。因为空间和键一起唯一标识每一个资源，您可以认为七牛云存储是基于`空间＋键`和资源本身之间的基本数据映射。\n\n例如：`http://78re52.com1.z0.glb.clouddn.com/resource/AllEast.jpg`\n\n * `78re52.com1.z0.glb.clouddn.com`是空间的绑定域名\n * `resource/AllEast.jpg`是键\n\n \n**JSON**\n\nJSON（JavaScript Object\nNotation）一种轻量级的数据交换格式，具有良好的可读和便于快速编写的特性。可在不同平台之间进行数据交换。JSON采用兼容性很高的、完全独立于语言文本格式，同时也具备类似于C语言的习惯（包括C,\nC++, C#, Java, JavaScript, Perl, Python等）体系的行为。这些特性使JSON成为理想的数据交换语言。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储L"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 术语表 > L\n\n# L\n\n最近更新时间: 2021-05-13 21:24:50\n\n \n**令牌 (Token)**\n\n令牌是用户访问七牛云存储时，进行身份验证的凭证。当用户将一个Bucket设置为私有后，在访问七牛云存储时，必须通过身份验证。用户将访问请求中的一些要素整合起来，用[签名密钥](https://developer.qiniu.com/kodo/glossary/3736/Q)对其加密，得到令牌。然后将令牌随同请求一起发送至七牛云存储。用户可以在令牌中指定请求的时效（七牛云存储统一使用UTC时间计算令牌有效期），防止请求被非法使用。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的对象存储U"
},
{
"from": "gpt",
"value": "[对象存储](https://developer.qiniu.com/kodo) > 术语表 > U\n\n# U\n\n最近更新时间: 2017-01-20 15:16:13\n\n**Unix 时间戳**\n\nUnix时间戳，是一种时间表示方式，定义为从1970年01月01日00时00分00秒起至现在的总秒数。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的CDN产品概述"
},
{
"from": "gpt",
"value": "[CDN](https://developer.qiniu.com/fusion) > 产品简介 > 产品概述\n\n# 产品概述\n\n最近更新时间: 2020-01-09 11:55:43\n\n# 产品简介\n\n七牛 CDN 是在传统 CDN 基础上实现的对数据网络加速进一步优化的智能管理服务。通过全方位的 CDN\n质量监控，以及智能易用的节点调度等功能，提供稳定快速的网络访问服务。保障客户的音视频点播、大文件下载、应用及 Web 加速服务的稳定及连续性。\n\n# 产品架构\n\n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的CDN名词解释"
},
{
"from": "gpt",
"value": "[CDN](https://developer.qiniu.com/fusion) > 产品简介 > 名词解释\n\n# 名词解释\n\n最近更新时间: 2020-01-09 11:55:55\n\n# CNAME域名\n\n在七牛云Portal创建加速域名后，会给域名分配一个\n“CNAME域名”（例：example.qiniudns.com）。用户需要在域名服务商处配置一条主机记录为 example 的 CNAME\n记录类型，并将需要记录值指向 example.qiniudns.com 。 \n生效后域名就会正式指向七牛云 CDN ，该域名所有的请求都开始享有CDN加速效果。\n\n# DNS\n\n即 Domain Name System ，域名解析服务。把域名转换成为网络可以识别的 IP 地址（人们习惯记忆域名，但机器互相只认 IP\n），能够使人更方便地访问互联网，它们之间的转换工作称为域名解析。\n\n# 边缘节点\n\n距离最终用户最近的 CDN\n节点，提高响应速度和连接速度，提高用户浏览网页视频的体验，边缘节点的主要工作是将访问量较大的网页内容和音视频等文件保存在服务器前端的专用缓存设备上。\n\n# 源站\n\n即客户的业务服务器。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的CDN功能特性"
},
{
"from": "gpt",
"value": "[CDN](https://developer.qiniu.com/fusion) > 产品简介 > 功能特性\n\n# 功能特性\n\n最近更新时间: 2020-01-09 11:56:10\n\n# 无盲区\n\n沉淀多年的 CDN 管控经验，精选核心 CDN 高质量节点，实现覆盖全国的边缘节点架构体系，全面覆盖各地、各运营商的网络，实现全地域无盲区的覆盖。\n\n# 智能调度\n\n基于全网请求来源的智能调度系统，支持 DNS、HttpDNS、Http302 调度模式，有效提高访问响应速度，防止劫持，实现全网实时精准调度调度。\n\n# 立体品控\n\n基于权威 APM 的全网覆盖「性能监控」和七牛自研的监控数据为基础上自研的全网「实时可用性监控」，打造七牛 CDN 立体品控体系。\n\n# 降低回源\n\n自建 BGP 网络中间源，消除跨运营商网络回源慢甚至不可达等问题，保护源站带宽不受边缘节点请求波动影响，节省回源成本。\n\n# 链路优化\n\n七牛自研探测 AGENT，精确探测点到点之间的链路质量，凭借特有的链路决策算法，可以保证边缘节点到中间源再到源站直接的所有链路最优。\n\n# 私有协议优化\n\n使用私有传输协议作为 CDN 内部数据交换的基础，确保客户资源在 CDN 内部安全、快速的传输到各个节点，实现客户内容高效、可靠的进行分发。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的CDN使用场景"
},
{
"from": "gpt",
"value": "[CDN](https://developer.qiniu.com/fusion) > 产品简介 > 使用场景\n\n# 使用场景\n\n最近更新时间: 2020-01-09 11:56:40\n\n# 网页/小文件/图片加速\n\n网页静态资源优化加速分发，例如：html、css、js、img 等；全站 HTTPS 保证网站访问安全；自动图片瘦身， TCP\n压缩优化使网页大图，样式等完成秒级加载，缩短网页响应时间提高用户体验。\n\n配合七牛云-图片处理服务一起使用，还可以针对图片进行缩略、打水印，转格式等数据处理服务。\n\n# 大文件下载\n\n大文件下载优化加速分发，例如：ipa、apk、mp3、exe、zip 等；七牛 CDN\n在全球数千个节点，让用户在下载过程中获得更快的下载速度，并利用分段缓存技术提高了大文件下载传输的稳定性。\n\n配合七牛云-存储服务一起使用，可有效降低回源和存储成本。\n\n# 音视频点播服务\n\n音视频点播优化加速服务，例如：mp4、flv、rmvb、wmv、hls 等；七牛 CDN 利用 BGP\n网络中间源技术降低回源带宽压力节省了用户回源成本、分段预取技术使用户在浏览音视频时更加的流畅，高级防盗链技术有效防止用户文件被盗用。\n\n配合七牛云-音视频处理服务，还可以进行音视频转码、转格式、压缩等数据处理服务。\n\n# 动态加速\n\n动态加速针对动态资源进行加速分发，基于七牛 CDN\n在全球的数千个节点，借助特有的动态路由探测技术和私有传输协议优化，可以保证客户源站的内容通过安全稳定的最优链路分发到用户端，在电商、社交、社区论坛、金融支付和游戏娱乐等方面可以显著提升用户的访问性能。\n\n使用动态加速时，域名下面的所有请求都将通过动态路由回到客户源站。如果您的业务同时有静态资源和动态资源，建议您将业务拆分成静态域名和动态域名，静态域名使用我们的普通CDN（点播/下载/网页），动态域名使用动态加速。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的CDNCDN 产品价格说明"
},
{
"from": "gpt",
"value": "[CDN](https://developer.qiniu.com/fusion) > 购买指南 > CDN 产品价格说明\n\n# CDN 产品价格说明\n\n最近更新时间: 2024-01-25 16:01:46\n\n七牛云 CDN 提供两种付费方式，默认的计费方式为后付费按量计费，您也可使用[CDN价格计算器 __](https://www-\nsource.qiniu.com/calculator)进行用量预估；同时提供[国内预付费资源包\n__](https://qmall.qiniu.com/template/NTI?ref=category&spec_combo=MTk0OA&ref=doc)和[海外预付费资源包\n__](https://qmall.qiniu.com/template/NTU?ref=category&spec_combo=MjEzNA&ref=doc)，可获得更优惠的价格。本文主要介绍以下内容： \n1.按流量后付费 \n1.1 免费额度 \n1.2 价格详情 \n1.3 超额累进阶梯计费示例 \n2.按资源包预付费 \n2.1 资源包购买 \n2.2 资源包用量查询 \n3.常见问题 \nQ:开启 HTTPS 以后如何收费？ \nQ:欠费以后还可以继续使用吗？ \nQ:资源包可以叠加使用吗？抵扣顺序是什么？ \nQ:使用量超出资源包后如何计费？ \nQ:今天8点后购买的资源包，为什么没有进行抵扣？\n\n# 1.按流量后付费\n\n七牛云 CDN 加速按国内流量和海外流量[阶梯价格计费\n__](https://www.qiniu.com/prices/qcdn)（动态加速在此基础上额外加收请求数费用），当月分别超额累进)（以自然月为一个累计周期）。\n\n## 1.1 免费额度\n\n开通七牛云 CDN 并完成实名认证的用户即可享有以下免费额度：\n\n * 每个分区（国内+海外各分区） 10GB HTTP 下载流量.\n * 5 万次动态加速请求数.\n\n## 1.2 价格详情\n\n### （1）国内流量价格\n\n名目 | 流量阶梯 （元/GB） | 价格 \n---|---|--- \nHTTP 下载流量/动态加速 HTTP 流量 | 第 0 GB 至 10 GB | 免费（仅限 HTTP 下载流量） \n第 10 GB 至 100 TB | 0.24 \n第 100 TB 至 1 PB | 0.19 \n第 1PB 以上 | 0.14 \nHTTPS 下载流量/动态加速 HTTPS 流量 | 第 0 GB 至 100 TB | 0.28 \n第 100 TB 至 1 PB | 0.23 \n第 1PB 以上 | 0.18 \n \n### （2）海外流量价格\n\n名目 | 流量阶梯 （元/GB） | 亚洲（港澳台/东南亚/印度） | 亚洲（其他地区） | 欧洲/北美洲 | 南美洲 | 大洋洲与其他 \n---|---|---|---|---|---|--- \nHTTP 下载流量/动态加速 HTTP 流量 | 第 0 GB 至 10 GB | 免费（仅限 HTTP 下载流量） \n第 10 GB 至 10 TB | 0.76 | 0.50 | 0.34 | 0.76 | 0.94 \n第 10 TB 至 50 TB | 0.66 | 0.44 | 0.30 | 0.66 | 0.82 \n第 50 TB 至 100 TB | 0.57 | 0.38 | 0.26 | 0.57 | 0.71 \n第 100TB 以上 | 请联系我们 400-808-9176 转 1 \nHTTPS 下载流量/动态加速 HTTPS 流量 | 第 0 GB 至 10 TB | 0.91 | 0.60 | 0.40 | 0.91 | 1.12 \n第 10 TB 至 50 TB | 0.79 | 0.52 | 0.36 | 0.79 | 0.98 \n第 50 TB 至 100TB | 0.68 | 0.45 | 0.31 | 0.68 | 0.85 \n第 100TB 以上 | 请联系我们 400-808-9176 转 1 \n \n### （3）动态加速请求次数价格\n\n动态加速请求次数不分区域，全球统一价格。\n\n动态请求数 \n--- \n名目 | 请求数 | 价格 \n动态加速请求数 | 第 0 次至 5 万次 | 免费 \n第 5 万次及以上 | 0.19 元/万次 \n \n## 1.3 超额累进阶梯计费示例\n\n假设用户 5 月只在中国大陆产生 HTTP 500 TB下载流量，海外各大区均未产生消耗，根据国内 CDN 价格，各阶梯费用计算如下。\n\n流量 | 单价（元/GB） | 本阶梯价格（元） | 累计价格（元） \n---|---|---|--- \n第 0 GB 至 10 GB | 0 | 0 | 0 \n第 10 GB 至 10 TB | 0.24 | 2455.2 | 2455.2 \n第 10 TB 至 500 TB | 0.19 | 95334.4 | 97789.6 \n \n# 2\\. 按资源包付费\n\n## 2.1 资源包购买\n\n根据域名的加速范围，可以选择购买[CDN 中国大陆资源包\n__](https://qmall.qiniu.com/template/NTI?ref=category&spec_combo=MTk0OA&ref=doc)或[CDN\n海外资源包\n__](https://qmall.qiniu.com/template/NTU?ref=category&spec_combo=MjEzNA&ref=doc) \n以下主要以国内资源包购买为例说明选择资源包的购买。 \n \n\n\n### （1）资源包类型\n\n“CDN 下行通用流量”适用于 http 和 https 的静态或动态加速下行流量，其中 http 和 https 协议按照1: 1.15\n的系数抵扣，https 协议不额外收取静态加速请求次数费用。（自 2020 年 11 月 19 日开始，CDN 资源包更新为 CDN\n融合资源包，可同时抵扣多种协议和场景的商品，历史已购买的分协议资源包使用不受影响，）\n\n> **如何理解系数？** 实际使用 https\n> 流量100GB，相当于抵扣资源包流量115GB。资源包的额度可以理解成诸如“点数”的概念，同单位的不同商品需要抵扣的点数不同。\n\n> **按什么顺序抵扣？**\n> 当资源包额度充足时（账单额度<资源包余量），资源包可全部抵扣金额；当资源包额度不够时（账单额度<资源包余量），按以下顺序抵扣：静态加速\n> HTTP、静态加速 HTTPS、动态加速 HTTP、动态加速 HTTPS。\n\n### （2）可用区域\n\n可根据域名的实际加速区域选择资源包的可用区域；如果加速区域为全球，可能同时产生国内流量和海外流量。\n\n### （3）可用时段\n\n为方便不同类型的用户优化 CDN 成本，七牛提供以下几种时段的资源包：\n\n**1\\. 全时段流量包** ：全时段指每天 0:00 - 24:00 \n**2\\. 日间时段流量包** ：日间时段指每天 09:00 - 18:00 \n**3\\. 闲时流量包** ：闲时段指每天 00:00 - 09:00 \n叠加使用规则和抵扣顺序参考 资源包可以叠加使用吗？抵扣顺序是什么？\n\n### （4）用量额度（用量预估）\n\n可根据实际使用需求预估资源包大小；额度越大单价越高，建议可预估一年用量购买。 \n可以根据历史用量预估资源包需求：在管理控制台页面进入 CDN，选择 [**统计分析**\n__](https://portal.qiniu.com/cdn/statistics/usage)，查看「用量统计」，支持按照域名维度、协议维度（http/https）、地区维度进行筛选查看；同时在流量趋势图上支持单独查看闲时、日间流量。 \n\n\n### （5）分配方式\n\n一次性分配资源包的流量在生效期内均可使用。\n\n## 2.2 资源包余量查询\n\n由于七牛目前按量付费资源采取月结算模式，系统每天8点左右将根据用户已使用的用量进行计费，更新一次实时消费明细，即实时消费明细为预估账单和余额预扣除，没有实际完成扣除，所以默认情况下，资源包的余量需要每个月完成月账单出账后更新状态，我们也可以通过下面的方法预估算资源包的使用情况。\n\n### （1）查看资源包余量\n\n在 **管理控制台** 页面右上角选择 [**费用**\n__](https://portal.qiniu.com/financial/overview)，选择[**资源包管理**\n__](https://portal.qiniu.com/financial/orders/respack-\nmgr/current)，筛选需要查看的资源包，点击「详情」。\n\n \n您可以看到当前资源包的剩余可用量以及历史每月账单结算后资源包的抵扣情况。 \n\n\n### （2）查看本月预抵扣明细\n\n注：实时消费明细 每日8点更新，更新用量的使用时间是截止本日0点，非实时动态更新。\n\n在 **管理控制台** 页面选择 [**财务中心**\n__](https://portal.qiniu.com/financial/overview)，选择[**实时消费明细**\n__](https://portal.qiniu.com/financial/orders)，查看从「上次月账单结算完成后」到「当日0点」的预估账单，参考下图，账单中可以下载「资源包抵扣明细」，抵扣明细中包含本月可用量/当前已用/本月剩余可用等参数。 \n\n\n# 3\\. 常见问题\n\n## Q：开启 HTTPS 以后如何收费？\n\n域名开启 HTTPS 配置以后，该域名下所有流量（包括 HTTPS 和 HTTP 请求）即开始按照 HTTPS 协议的价格进行收费。HTTPS\n域名产生的用量不计入免费额度，静态加速下 HTTPS 协议不额外收请求次数费用。对于月中升级为 https 的用户，本月计量都按照https计算。 \n默认配置下可兼容 HTTP 和 HTTPS 两种协议的请求，如需强制 HTTPS 访问，请在控制台开启“强制 HTTPS 访问”配置。\n\n## Q：欠费以后还可以继续使用吗？\n\n欠费以后，无法新增域名和修改域名。更多信息请见： \n[欠费状态下各产品的限制功能 __](https://developer.qiniu.com/af/manual/6650/owe-the-\nprotection-limit-function) \n[新版欠费流程 __](https://developer.qiniu.com/af/kb/5996/new-owe-the-process-\ndescription)\n\n## Q：资源包可以叠加使用吗？抵扣顺序是什么？\n\n资源包可叠加购买，出账时将按照以下规则进行抵扣： \n\n\n## Q：使用量超出资源包后如何计费？\n\n在资源包生效期间内，若当月用量超出可用资源包额度，出账时将优先抵扣完资源包额度，超出部分再按照官网 [CDN 后付费价格\n__](https://www.qiniu.com/prices)结算。\n\n## Q：今天8点后购买的资源包，为什么没有进行抵扣？\n\n实时消费明细 每日8点更新，更新用量的使用时间是截止本日0点，非实时动态更新，当月生效的资源包，您可以在购买后第二天，在财务中心查看实时消费明细账单。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
Subsets and Splits