快照相关接口

创建快照

该接口用于从指定的磁盘创建快照,支持创建系统盘快照和CDS磁盘快照。

  • 创建系统盘快照时,实例的状态必须为 Running 或 Stopped 此操作才能正常完成。
  • 创建CDS磁盘快照时,磁盘的状态需要为InUse(使用中)或 Available(待挂载)此操作才能正常完成。
  • 可创建快照数量的配额取决于账号下拥有的磁盘总数,当前最多可同时创建n*8个快照,n为总磁盘(CDS云磁盘+系统盘)数量。

请求结构

POST /v{version}/snapshot?clientToken={clientToken} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

{
    "volumeId":volumeId,
    "snapshotName": snapshotName,
    "desc" : create snapshot
}

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见ClientToken幂等性
volumeId String Request Body参数 用于创建快照的磁盘ID,系统盘则为实例ID
snapshotName String Request Body参数 快照名称,支持大小写字母、数字、中文以及-_ /.特殊字符,必须以字母开头,长度1-65。
desc String Request Body参数 快照描述信息,选填

返回头域

除公共头域,无其它特殊头域。

返回参数

参数名称 类型 描述
snapshotId String 已创建的快照ID

错误码

错误码 错误描述 HTTP状态码 中文解释
BadRequest Bad request parameters or illegal request. 400 请求参数无效
Snapshot.SnapshotNameInvalid snapshot name is invalid. 400 名称非法
Instance.SnapshotLimitExceeded The number of snapshot will exceed the quota limit. 413 快照超出额度

请求示例

POST /v2/snapshot?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "volumeId": "v-nky7qeom",
    "snapshotName": "example-001"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "snapshotId" : "s-6r3dam6F"
}

查询快照列表

该接口用于查询所有的快照信息,包括系统盘快照和CDS磁盘快照信息。

请求结构

GET /v{version}/snapshot?marker={marker}&maxKeys={maxKeys}&volumeId={volumeId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串。
maxKeys int Query参数 每页包含的最大数量,最大数量通常不超过1000。缺省值为1000
volumeId String Query参数 通过磁盘ID过滤,系统盘则为实例ID

返回头域

除公共头域,无其它特殊头域。

返回参数

参数名称 类型 描述
marker String 标记查询的起始位置
isTruncated boolean true表示后面还有数据,false表示已经是最后一页。
nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现。
maxKeys int 每页包含的最大数量
snapshots List<SnapshotModel> 返回的快照列表

错误码

无特殊返回错误码

请求示例

GET /v2/snapshot?marker=s-6r3dam6F&maxKeys=2 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "nextMarker": "s-tpxSNbqb",
    "marker": "s-6r3dam6F",
    "maxKeys": 2,
    "snapshots": [
        {
            "id": "s-6r3dam6F",
            "createTime": "2015-07-08T10:22:04Z",
            "name": "snapshot-name",
            "sizeInGB": 5,
            "status": "Available",
            "createMethod": "MANUAL",
            "volumeId": "v-IgJOjBWj",
            "desc": "snapshot-decription"
        },
        {
            "id": "s-UrGLpTYC",
            "createTime": "2015-07-08T10:21:03Z",
            "name": "snapshot-name",
            "sizeInGB": 5,
            "status": "Available",
            "createMethod": "MANUAL",
            "volumeId": "v-IgJOjBWj",
            "desc": "snapshot-decription"
        }
    ],
    "isTruncated": false
}

查询快照详情

该接口用于通过指定快照ID查询单个快照的详细信息。

请求结构

GET /v{version}/snapshot/{snapshotId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
snapshotId String URL参数 待查询的快照ID

返回头域

除公共头域,无其它特殊头域。

返回参数

参数名称 类型 描述
snapshot SnapshotModel 返回的快照信息

错误码

错误码 错误描述 HTTP状态码 中文解释
BadRequest Bad request parameters or illegal request. 400 请求参数无效
NoSuchObject The specified object is not found or resource do not exist. 404 资源不存在

请求示例

GET /v2/snapshot/s-6r3dam6F HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "snapshot": {
        "id": "s-6r3dam6F",
        "createTime": "2015-07-08T10:21:03Z",
        "name": "snapshot-name",
        "sizeInGB": 5,
        "status": "Available",
        "createMethod": "MANUAL",
        "volumeId": "v-IgJOjBWj",
        "desc": "snapshot-decription"
    }
}

删除快照

该接口用于通过指定快照ID删除快照。

  • snapshotId 所指定的快照不存在时,此操作无法正常完成,将提示 404 错误。
  • 只有当快照的状态为 CreatedFailed 或 Available时,此操作才能正常完成,否则将提示 403 错误。

请求结构

DELETE /v{version}/snapshot/{snapshotId} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其它特殊头域。

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
snapshotId String URL参数 待删除的快照的ID

返回头域

除公共头域,无其它特殊头域。

返回参数

无特殊返回参数

错误码

无特殊错误码

请求示例

DELETE /v2/snapshot/s-6r3dam6F HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS