创建备份任务

删除备份任务。

描述

用户可以通过创建备份任务来定时对所选实例进行备份操作。
一个实例只能创建一个备份任务。
用户不能创建同名的备份任务。

请求参数

名称	是否必须	描述
Action	是	CreateJob
jobName	是	备份任务名
instanceId	是	所选实例id
resourceType	是	产品类型
retentionType	是	备份保留策略类型
retentionPolicy	是	备份保留策略
cronExpression	是	cron表达式
storageSpaceType	是	存储桶类型

成功返回http状态码

204

返回参数

无

示例

创建名为testDemo的任务，对云硬盘的12d51dc7-2939-4d78-bb53-6a40489b8945实例进行备份，每天12点进行备份，备份保留时长为3天。

POST http://cbs.cn-north-3.inspurcloudapi.com?Action=CreateJob&jobName=testDemo&resourceType=ebs&retentionPolicy=3&cronExpression=0 0 12 ?&retentionType=days&instanceId=12d51dc7-2939-4d78-bb53-6a40489b8945&storageSpaceType=ebsBackupSpace

响应示例

返回状态码为204，无返回体。

错误码

请参考错误码

分页查询备份任务列表

分页查询备份任务列表。

描述

本接口是查询备份任务列表接口，可随意选择分页的页数与每页的个数。。
可选择是否按任务名模糊查询，按任务名模糊查询的意思是将任务名中含有该关键词的备份任务分页列出。。

请求参数

名称	是否必须	描述
Action	是	ListBackupJob
pageNo	是	备份任务名
pageSize	是	所选实例id
resourceType	是	产品类型
jobName	是	备份保留策略类型

成功返回http状态码

200

返回参数

名称	位置	类型	是否必须	描述
backupJobDetailVO	body	ListVo<BackupJobVO>	是	描述

示例

查询资源类型为ebs的备份任务，显示第一页，每页显示2个。 POST http://cbs.cn-north-3.inspurcloudapi.com/jobs?Action=ListBackupJob&productType=ebs&pageSize=2&pageNo=1

响应示例

2 1 8 success days 204cd51e-8e45-49f4-b505-fbe79cbfe5ce 3 0 0 2 ? * * executing 2020-08-25T01:57:56Z ebs 2020-08-25T01:57:56Z 0 test12345 91aeecb9-59e5-4adb-99d4-f07ba0e8544d success days 6b4b9a08-7b73-4fd3-b4ac-4dc84fbcac62 0 0 0 4 14 8 ? 2020 disable 2020-08-14T04:25:00Z ecs 2020-08-14T03:07:11Z 4249659316 test23 1cb0f4c8-40bb-4e7d-b0c2-b272064bad99

错误码

请参考错误码

备份任务详情

展示备份任务的详情。

描述

本接口返回备份任务基本信息
本接口返回备份任务执行的次数与成功、失败次数

请求参数

名称	是否必须	描述
Action	是	Details
jobId	是	备份任务ID

成功返回http状态码

200

返回参数

名称	位置	类型	是否必须	描述
backupJobDetailVO	body	BackupJobDetailVO	是	描述

示例

查看任务id为c97becda-1a55-440b-bc8d-b507c4ff3c44的备份详情。

GET http://cbs.cn-north-3.inspurcloudapi.com?Action=DeleteJob&JobId=c97becda-1a55-440b-bc8d-b507c4ff3c44

响应示例

{
    "successCount": 2,
    "totalSize": 140,
    "totalCount": 10,
    "failCount": 8,
    "backupJobVO": {
        "jobName": "backupEveryday",
        "jobId": "e016d64a-a771-4ced-95f8-be235d85e9fa",
        "productType": "ebs",
        "instanceId": "c97becda-1a55-440b-bc8d-b507c4ff3c44",
        "createdTime": "2019-10-28T09:07:52Z",
        "recentActionTime": "2019-10-29T03:20:11Z",
        "recentActionResult": "fail",
        "recentActionSize": 20,
        "status": "enable",
        "cronExpression": "0 0 18 * * ? *",
        "retentionPolicy": 3,
        "retentionType" : "days"
    }
}

错误码

请参考错误码

执行备份任务

执行备份任务。

描述

用户可以将指定的备份任务进行手动执行操作
处于执行中状态的任务不可进行手动执行操作

请求参数

名称	是否必须	描述
Action	是	trigger
jobId	是	备份任务ID

成功返回http状态码

202

返回参数

无

示例

执行任务id为f665d8be-7880-4a5c-8681-2c0aa44a930d的备份任务。

GET http://cbs.cn-north-3.inspurcloudapi.com?Action=trigger&jobId=f665d8be-7880-4a5c-8681-2c0aa44a930d

响应示例

返回状态码为202，无返回体。

错误码

请参考错误码

删除备份任务

删除备份任务。

描述

用户可以将指定的备份任务进行删除
存在由该任务创建的备份的备份任务不可删除

请求参数

名称	是否必须	描述
Action	是	DeleteJob
jobId	是	备份任务id

成功返回http状态码

204

返回参数

无

示例

删除任务id为24216f85-5ebc-48bd-9db3-6dea1efae14a的备份任务。

GET http://cbs.cn-north-3.inspurcloudapi.com?Action=DeleteJob&jobId=24216f85-5ebc-48bd-9db3-6dea1efae14a

响应示例

返回状态码为204，无返回体。

错误码

请参考错误码

分页查询备份列表

分页查询备份列表，可传入第几页与每页个数。

描述

本接口是查询任一备份任务下备份列表接口，可随意选择分页的页数与每页的个数。

请求参数

名称	是否必须	描述
Action	是	BackupList
PageNo	是	当前页数为第几页(与pageSize均传-1为查询所有)
PageSize	是	每一页最多显示几项
SortType	是	排序方式(0:时间倒序 1:时间正序 2:结果倒序 3:结果正序默认为0)
JobId	是	备份任务ID

成功返回http状态码

200

返回参数

名称	位置	类型	是否必须	描述
listVO	body	ListVO<BackupVO>	是	列表信息

示例

查看备份任务id为91aeecb9-59e5-4adb-99d4-f07ba0e8544d的任务下的备份，显示第一页，每页显示2条。

GET http://cbs.cn-north-3.inspurcloudapi.com?Action=BackupList&PageNo=1&PageSize=2&JobId=91aeecb9-59e5-4adb-99d4-f07ba0e8544d

响应示例

<BackupListResponse>
    <PageSize>2</PageSize>
    <PageNo>1</PageNo>
    <TotalCount>1</TotalCount>
    <Data>
        <IsAuto>false</IsAuto>
        <Size>42949672960</Size>
        <Id>177422f4-a1d6-49af-8755-fb71af1db6e6</Id>
        <BackupId>993db34f-5c5f-43f2-b3c2-ce649a81dacb</BackupId>
        <InstanceId>204cd51e-8e45-49f4-b505-fbe79cbfe5ce</InstanceId>
        <InstanceStatus>in-use</InstanceStatus>
        <CreatedTime>2020-08-25T02:01:43Z</CreatedTime>
        <BackupName>test12345_20200825020142758</BackupName>
        <ActualSize>1652199267</ActualSize>
        <Status>success</Status>
    </Data>
</BackupListResponse>

错误码

请参考错误码

删除备份

删除指定的备份。

描述

用户可以将指定的备份进行删除。

请求参数

名称	是否必须	描述
Action	是	DeleteBackup
backupId	是	备份ID

成功返回http状态码

202

返回参数

无

示例

要删除id为0aa06f10-818d-4dfb-aec9-aed2f2241746的备份

GET http://cbs.cn-north-3.inspurcloudapi.com?Action=DeleteBackup&backupId=0aa06f10-818d-4dfb-aec9-aed2f2241746

响应示例

删除成功响应为202，无返回体

错误码

请参考错误码

查看备份空间和备份次数

统计备份信息。

描述

获取当前用户的备份存储空间信息和备份次数信息。

请求参数

名称	是否必须	描述
Action	是	Statistics

成功返回http状态码

200

返回参数

名称	位置	类型	是否必须	描述
storage	body	StorageDTO	是	备份存储空间信息
backupCount	body	CountDTO	是	备份次数信息
storageSpaceType	data	String	是	存储空间类型

示例

GET http://cbs.cn-north-3.inspurcloudapi.com?Action=Statistics

响应示例

<StatisticsResponse>
    <Data>
        <BackupCount>
            <Failed>18</Failed>
            <Total>39</Total>
            <Success>21</Success>
        </BackupCount>
        <Storage>
            <Total>322122547200</Total>
            <Free>122754599526</Free>
            <Used>199367947674</Used>
        </Storage>
        <InstanceId>2022d5d6-06b4-4136-91dd-115fdd614cdc</InstanceId>
        <StorageSpaceType>ebsBackupSpace</StorageSpaceType>
    </Data>
    <Data>
        <BackupCount>
            <Failed>0</Failed>
            <Total>2</Total>
            <Success>2</Success>
        </BackupCount>
        <Storage>
            <Total>107374182400</Total>
            <Free>98874863768</Free>
            <Used>8499318632</Used>
        </Storage>
        <InstanceId>597cddfb-f387-44c2-a499-888c9a804e90</InstanceId>
        <StorageSpaceType>ecsBackupSpace</StorageSpaceType>
    </Data>
</StatisticsResponse>

错误码

请参考错误码

查看时间段内备份量

查看时间段内备份量。

描述

按照日粒度和月粒度查看时间段内的存储大小。

请求参数

名称	是否必须	描述
Action	是	Storage
StartTime	是	开始时间
EndTime	是	结束时间
DateType	是	时间粒度，可传day或month

成功返回http状态码

200

返回参数

名称	位置	类型	是否必须	描述
info	body	Map	是	时间段内存储量
info	Map	List<StorageVO>	是	云硬盘存储桶存储量
info	Map	List<StorageVO>	是	云服务器存储桶存储量

示例一

按天查询存储量

GET http://cbs.cn-north-3.inspurcloudapi.com?Action=Storage&StartTime=2020-08-23&EndTime=2020-08-25&DateType=day

响应示例

<StorageResponse>
    <Info>
        <EbsBackupSpace>
            <Date>2020-08-23</Date>
            <Storage>0</Storage>
        </EbsBackupSpace>
        <EbsBackupSpace>
            <Date>2020-08-24</Date>
            <Storage>0</Storage>
        </EbsBackupSpace>
        <EbsBackupSpace>
            <Date>2020-08-25</Date>
            <Storage>1652199267</Storage>
        </EbsBackupSpace>
        <EcsBackupSpace>
            <Date>2020-08-23</Date>
            <Storage>0</Storage>
        </EcsBackupSpace>
        <EcsBackupSpace>
            <Date>2020-08-24</Date>
            <Storage>0</Storage>
        </EcsBackupSpace>
        <EcsBackupSpace>
            <Date>2020-08-25</Date>
            <Storage>0</Storage>
        </EcsBackupSpace>
    </Info>
</StorageResponse>

示例二

按月查询存储量

GET http://cbs.cn-north-3.inspurcloudapi.com?Action=Storage&StartTime=2020-06&EndTime=2020-08&DateType=month

响应示例

<StorageResponse>
    <Info>
        <EbsBackupSpace>
            <Date>2020-06</Date>
            <Storage>0</Storage>
        </EbsBackupSpace>
        <EbsBackupSpace>
            <Date>2020-07</Date>
            <Storage>508869835237</Storage>
        </EbsBackupSpace>
        <EbsBackupSpace>
            <Date>2020-08</Date>
            <Storage>1652199267</Storage>
        </EbsBackupSpace>
        <EcsBackupSpace>
            <Date>2020-06</Date>
            <Storage>0</Storage>
        </EcsBackupSpace>
        <EcsBackupSpace>
            <Date>2020-07</Date>
            <Storage>0</Storage>
        </EcsBackupSpace>
        <EcsBackupSpace>
            <Date>2020-08</Date>
            <Storage>8499318632</Storage>
        </EcsBackupSpace>
    </Info>
</StorageResponse>

错误码

请参考错误码