自动快照策略相关接口

创建自动快照策略

该接口用于创建自动快照策略。

请求结构

POST /v{version}/asp?clientToken={clientToken} HTTP/1.1
 Host: bcc.bj.baidubce.com
 Authorization: authorization string
 {
     "name":name,
     "timePoints":[timePoints],
     "repeatWeekdays":[repeatWeekdays],
     "retentionDays":retentionDays
 }

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
clientToken String Query参数 幂等性Token,是一个长度不超过64位的ASCII字符串,详见链接
name String Query参数 自动快照策略名称,支持大小写字母、数字、中文以及-_ /.特殊字符,必须以字母开头,长度1-65。
timePoints List<String> Query参数 一天中做快照时间点,取值为0~23。
repeatWeekdays List<String> Query参数 一周中做快照的时间,取值为0~6。
retentionDays String Query参数 自动快照保留天数,取-1则永久保留。

返回头域

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

返回参数

参数名称 类型 描述
aspId String 已创建的自动快照策略ID

错误码

错误码 错误描述 HTTP状态码 中文解释
BadRequest Bad request parameters or illegal request. 400 请求参数无效
Asp.NameInvalid asp name is invalid. 400 名称非法
Asp.RetentionDaysInvalid RetentionDays should in [1,10000] 400 保留天数非法
Asp.TimePointsInvalid TimePoints should in [0,23] 400 执行时间点参数异常
Asp.RepeatWeekdaysInvalid RepeatWeekdays should in [1,7] 400 执行日期参数异常

请求示例

POST /v2/securityGroup?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

 {
     "name":"asp-num1",
     "timePoints":["20"],
     "repeatWeekdays":["1","5"],
     "retentionDays":"7"
 }

返回示例

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 

 {
     "aspId" : "asp-oG6prjrl"
 }

绑定自动快照策略

该接口用于绑定自动快照策略到指定磁盘。

请求结构

PUT /v{version}/asp/{aspId}?{action} HTTP/1.1
 Host: bcc.bj.baidubce.com
 Authorization: authorization string
 {
     "volumeIds":[volumeId]
 }

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
aspId String URL参数 自动快照策略ID
action String Query参数 对自动快照策略执行的动作,当前取值attach
volumeIds List<String> Query参数 需要绑定的磁盘id

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
Asp.VolumeTypeInvalid Volume type should be Cds or System 400 volume类型非法
Asp.VolumeStatusInvalid Volume must be in-use 400 volume状态必须为in-use
BadRequest missing parameter. 400 缺少参数
ServiceInternalError Internal service occurs error. 500 内部错误
NoSuchObject The specified object is not found or resource do not exist. 404 指定资源不存在

请求示例

PUT /v2/asp/asp-oG6prjrl?attach HTTP/1.1
 Host: bcc.bj.baidubce.com
 Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

 {
     "volumeIds":["v-111","v-222"]
 }

返回示例

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

解绑自动快照策略

该接口用于解绑自动快照策略。

请求结构

PUT /v{version}/asp/{aspId}?{action} HTTP/1.1
 Host: bcc.bj.baidubce.com
 Authorization: authorization string
 {
     "volumeIds":[volumeId]
 }

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
aspId String URL参数 自动快照策略ID
action String Query参数 对自动快照策略执行的动作,当前取值detach
volumeIds List<String> Query参数 需要解绑的磁盘id

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
BadRequest missing parameter. 400 缺少参数
ServiceInternalError Internal service occurs error. 500 内部错误

请求示例

PUT /v2/asp/asp-oG6prjrl?detach HTTP/1.1
 Host: bcc.bj.baidubce.com
 Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

 {
     "volumeIds":["v-111","v-222"]
 }

返回示例

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

删除自动快照策略

该接口用于删除自动快照策略。

请求结构

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

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
aspId String URL参数 自动快照策略ID

返回头域

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

返回参数

无特殊返回参数

错误码

错误码 错误描述 HTTP状态码 中文解释
BadRequest Bad request parameters or illegal request. 400 请求参数错误
NoSuchObject The specified object is not found or resource do not exist. 404 指定的asp不存在
ServiceInternalError Internal service occurs error. 500 内部错误

请求示例

DELETE /v2/asp/asp-oG6prjrl 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

查询自动快照策略列表

该接口用于查询所有的自动快照策略。

请求结构

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

请求头域

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

请求参数

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

返回头域

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

返回参数

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

错误码

无特殊返回错误码

请求示例

GET /v2/asp?marker=asp-oG6prjrl&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": "asp-33333",
     "marker": "asp-oG6prjrl",
     "maxKeys": 2,
     "autoSnapshotPolicys": [
         {
             "id": "asp-oG6prjrl",
             "name": "snapshot-name",
             "timePoints": [20,21],
             "repeatWeekdays": [0, 6],
             "retentionDays": 7,
             "status": "active",
             "createdTime": "2015-07-08T10:22:04Z",
             "updatedTime": "2015-07-09T10:22:04Z",
             "deletedTime": "1971-01-01T00:00:01Z",
             "lastExecuteTime": "2015-07-09T10:22:04Z",
             "volumeCount": 1
         },
         {
             "id": "asp-22222",
             "name": "snapshot-name1",
             "timePoints": [23],
             "repeatWeekdays": [5],
             "retentionDays": 7,
             "status": "active",
             "createdTime": "2015-07-08T10:22:04Z",
             "updatedTime": "1971-01-01T00:00:01Z",
             "deletedTime": "1971-01-01T00:00:01Z",
             "lastExecuteTime": "1971-01-01T00:00:01Z",
             "volumeCount": 0
         }
     ],
     "isTruncated": false
 }

查询自动快照策略详情

该接口用于查询指定自动快照策略详情。

请求结构

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

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号
aspId String Query参数 自动快照策略Id

返回头域

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

返回参数

参数名称 类型 描述
autoSnapshotPolicy AutoSnapshotPolicyModel 返回的自动快照策略

错误码

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

请求示例

GET /v2/asp/asp-123 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 

 {
     "autoSnapshotPolicy": {
         "id": "asp-123",
         "name": "snapshot-name",
         "timePoints": [20,21],
         "repeatWeekdays": [0, 6],
         "retentionDays": 7,
         "status": "active",
         "createdTime": "2015-07-08T10:22:04Z",
         "updatedTime": "2015-07-09T10:22:04Z",
         "deletedTime": "1971-01-01T00:00:01Z",
         "lastExecuteTime": "2015-07-09T10:22:04Z",
         "volumeCount": 1
     }
 }