控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

版本控制

最近更新时间:2020-04-24 18:18:00

简介

本文档提供关于版本控制的 API 概览以及 SDK 示例代码。

API 操作名 操作描述
PUT Bucket versioning 设置版本控制 设置存储桶的版本控制功能
GET Bucket versioning 查询版本控制 查询存储桶的版本控制信息

设置版本控制

功能说明

PUT Bucket versioning 接口实现启用或者暂停存储桶的版本控制功能。

注意:

  1. 如果您从未在存储桶上启用过版本控制,则 GET Bucket versioning 请求不返回版本状态值。
  2. 开启版本控制功能后,只能暂停,不能关闭。
  3. 设置版本控制状态值为 Enabled 或者 Suspended,表示开启版本控制和暂停版本控制。
  4. 设置存储桶的版本控制功能,您需要有存储桶的写权限。

请求示例

cos.putBucketVersioning({
    Bucket: 'examplebucket-1250000000',  /* 必须 */
    Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
    VersioningConfiguration: {
        Status: "Enabled"
    }
}, function (err, data) {
    console.log(err || data);
});

参数说明

参数名称 描述 类型 是否必填
Bucket 开启或暂停版本控制的存储桶,格式:BucketName-APPID String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String
VersioningConfiguration 定义存储桶的版本控制配置信息 Object
- Status 版本控制是否打开的状态,枚举值:Enabled、Suspended。
  • Enabled 表示打开
  • Suspended 表示暂停
  • String

    回调函数说明

    function(err, data) { ... }
    参数名             参数描述 类型
    err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
    - statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
    - headers 请求返回的头部信息 Object
    data 请求成功时返回的对象,如果请求发生错误,则为空 Object
    - statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
    - headers 请求返回的头部信息 Object

    查询版本控制

    功能说明

    查询存储桶的版本控制信息。

    请求示例

    cos.getBucketVersioning({
        Bucket: 'examplebucket-1250000000',  /* 必须 */
        Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
    }, function (err, data) {
        console.log(err || data);
    });

    参数说明

    参数名称 描述 类型 是否必填
    Bucket 查询版本控制的存储桶,格式:BucketName-APPID String
    Region 存储桶所在地域,枚举值请参见 地域和访问域名 String

    回调函数说明

    function(err, data) { ... }
    参数名                                参数描述 类型
    err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
    - statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
    - headers 请求返回的头部信息 Object
    data 请求成功时返回的对象,如果请求发生错误,则为空 Object
    - statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
    - headers 请求返回的头部信息 Object
    - VersioningConfiguration 存储桶的版本控制配置信息,若从未开启过,则为空对象 '{}' Object
    - - Status 版本控制是否打开的状态,枚举值:Enabled、Suspended String
    目录