创建云硬盘

创建一块或多块按量付费或者预付费(包年包月)云硬盘。

描述

  • 单次最多能创建100块云硬盘。

  • 实例创建成功后将自动开机启动,实例状态变为“available未挂载”。

  • 预付费实例的购买会预先扣除本次实例购买所需金额,按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额,在调用本接口前请确保账户余额充足。

  • 在启动实例时,实例属于“创建中”(creating)状态,在实例准备好时,会进入“运行中(available)”状态。

请求参数

名称 是否必须 描述
Action CreateVolume
IndiskName 云硬盘名称
IndiskSize 云硬盘大小
BackupId 快照ID,快照容量必须与云硬盘大小相同
IndiskNum 云硬盘数目
BillType 计费方式---1.monthly:按月; 2.hourlySettlement:按小时实时结算(即按需)
Duration 购买时长---BillType为monthly时必传
DurationUnit 购买时长单位---默认值:M(区分大小写)。BillType为monthly时必传
IsAutoRenew true--自动续费/false--不自动续费。默认为不自动续费

返回参数

名称 位置 类型 是否必须 描述
message body string 执行结果信息 有效值:成功 或 失败。
code body Integer 出现错误时,返回的错误码。
result body ResultObject 结果

示例

  • Sample Request(请求)

    https://ebs.cn-north-3.inspurcloudapi.com/?Action=CreateVolume&IndiskName=testw111&IndiskSize=20&IndiskNum=2&BillType=monthly&Duration=1&DurationUnit=M&Nonce=116&Timestamp=1555717904&Version=2019-01-31
    
  • Sample Response(响应)

    • xml格式

      <CreateVolumeResponse>
        <RequestId>aca3bbf4-a0f0-4d69-83cc-b90d5c89a816</RequestId>
        <Result>
          <Result>true</Result>
          <OrderId>157871062339747840</OrderId>
        </Result>
        <Code>0</Code>
        <Message>创建订单成功!</Message>
      </CreateVolumeResponse>
      
    • json格式

      {
        "result": {
          "result": true,
          "orderId": "157875123748012032"
        },
        "code": "0",
        "requestId": "5ce0e0d1-e2e5-4b54-a9c5-552266ccdf75",
        "message": "创建订单成功!"
      }
      

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.001311 一次购买的数量范围为1-100 400
102.001312 名称长度为2-128个字符,不能以特殊字符及数字开头,只可包含特殊字符中的\".\", \"_\"或\"-\" 400
102.001313 容量范围为20-32768GiB,且最小步长为10,超过32760后请直接输入32768 400
102.001024 云硬盘计费方式错误 400

扩容云硬盘

  • 扩容一个云硬盘,云硬盘处于未挂载(available)和已挂载(in-use)状态;

  • 扩容时进入extending状态,扩容成功后恢复为原状态。

  • 系统盘扩容的上限为500GiB,数据盘扩容的上限为32768GiB。

请求参数

名称 是否必须 描述
Action ExtendVolume
VolumeId 云硬盘UUID
IndiskNewSize 扩容后的云硬盘大小,单位为GiB,最小步长为10。扩容后的云硬盘容量范围,大于原有云硬盘容量~数据盘最大容量(32768GiB),系统盘最大容量为(500GiB)

返回参数

名称 位置 类型 是否必须 描述
message body string 执行结果信息 有效值:成功 或 失败。
code body Integer 出现错误时,返回的错误码。
result body ResultObject 结果

示例

  • Sample Request(请求)

    https://ebs.cn-north-3.inspurcloudapi.com/?Action=ExtendVolume&VolumeId=658aabb2-e76d-4f88-838b-da264d7e7ef0&IndiskCurrentSize=20&IndiskNewSize=50&Nonce=215385&Timestamp=1555717904&Version=2019-01-31
    
  • Sample Response(响应)

  • xml格式

    <ExtendVolumeResponse>
      <RequestId>aca3bbf4-a0f0-4d69-83cc-b90d5c89a816</RequestId>
      <Result>
        <Result>true</Result>
        <OrderId>157871062339747840</OrderId>
      </Result>
      <Code>0</Code>
      <Message>创建订单成功!</Message>
    </ExtendVolumeResponse>
    
  • json格式

    {
      "result": {
        "result": true,
           "orderId": "157875123748012032"
      },
      "code": "0",
      "requestId": "5ce0e0d1-e2e5-4b54-a9c5-552266ccdf75",
      "message": "创建订单成功!"
    }
    

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.001022 云硬盘ID不能为空 400
102.001023 云硬盘大小不能为空 400
102.001313 容量范围为10-32768GiB,且最小步长为10,超过32760后请直接输入32768 400
102.001052 云硬盘新的容量必须大于旧的容量 400

云硬盘续费

包年包月云硬盘续费。

请求参数

名称 是否必须 描述
Action RenewVolume
VolumeId 云硬盘UUID
Duration 续费时长
DurationUnit 时长单位M(月)

返回参数

名称 位置 类型 是否必须 描述
message body string 执行结果信息 有效值:成功 或 失败。
code body Integer 出现错误时,返回的错误码。
result body ResultObject 结果

示例

  • Sample Request(请求)

    https://ebs.cn-north-3.inspurcloudapi.com/?Action=RenewVolume&VolumeId=c95d321a-469c-415b-a1d6-0e564f62c06a&Duration=1&DurationUnit=M&Nonce=1116323&Timestamp=1555717904&Version=2019-01-31
    
  • Sample Response(响应)

  • xml格式

    <RenewVolumeResponse>
      <RequestId>aca3bbf4-a0f0-4d69-83cc-b90d5c89a816</RequestId>
      <Result>
        <Result>true</Result>
        <OrderId>157871062339747840</OrderId>
      </Result>
      <Code>0</Code>
      <Message>创建订单成功!</Message>
    </RenewVolumeResponse>
    
  • json格式

    {
      "result": {
        "result": true,
          "orderId": "157875123748012032"
      },
      "code": "0",
      "requestId": "5ce0e0d1-e2e5-4b54-a9c5-552266ccdf75",
      "message": "创建订单成功!"
    }
    

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.001022 云硬盘ID不能为空 400

删除云硬盘

删除一个云硬盘,云硬盘是按需付费的;并且云硬盘处于未挂载状态(available)。

请求参数

名称 是否必须 描述
Action DeleteVolume
VolumeId 云硬盘UUID

返回参数

名称 位置 类型 是否必须 描述
message body string 执行结果信息 有效值:成功 或 失败。
code body Integer 出现错误时,返回的错误码。
result body ResultObject 结果

示例

  • Sample Request(请求)

    https://ebs.cn-north-3.inspurcloudapi.com/?Action=DeleteVolume&VolumeId=d35e7165-c437-47db-9683-bade5435fa4d&Nonce=211&Timestamp=1555717904&Version=2019-01-31
    
  • Sample Response(响应)

  • xml格式

    <DeleteVolumeResponse>
      <RequestId>aca3bbf4-a0f0-4d69-83cc-b90d5c89a816</RequestId>
      <Result>
        <Result>true</Result>
        <OrderId>157871062339747840</OrderId>
      </Result>
      <Code>0</Code>
      <Message>创建订单成功!</Message>
    </DeleteVolumeResponse>
    
  • json格式

    {
      "result": {
        "result": true,
        "orderId": "157875123748012032"
      },
      "code": "0",
      "requestId": "5ce0e0d1-e2e5-4b54-a9c5-552266ccdf75",
      "message": "创建订单成功!"
    }
    

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.001022 云硬盘ID不能为空 400

批量删除云硬盘

批量删除云硬盘,云硬盘是按需付费的;并且云硬盘处于未挂载状态(available)。

请求参数

名称 是否必须 描述
Action BatchDeleteVolume
VolumeId1 第一个云硬盘UUID
VolumeId2 第二个云硬盘UUID
... ... ...
VolumeIdn 第n个云硬盘UUID

返回参数

名称 位置 类型 是否必须 描述
message body string 执行结果信息 有效值:成功 或 失败。
code body Integer 出现错误时,返回的错误码。
result body ResultObject 结果

示例

  • Sample Request(请求)

    https://ebs.cn-north-3.inspurcloudapi.com/?Action=BatchDeleteVolume&VolumeId1=87d72566-4250-4404-bce8-c793b2347a52&VolumeId2=340f20d8-22c0-4b64-ba05-0c1b33f70a88&VolumeId3=807c47b5-9213-4021-9db7-5e11fe813c72&Nonce=21111&Timestamp=1555717904&Version=2019-01-31
    
  • Sample Response(响应)

  • xml格式

    <BatchDeleteVolumeResponse>
      <RequestId>aca3bbf4-a0f0-4d69-83cc-b90d5c89a816</RequestId>
      <Result>
        <Result>true</Result>
        <OrderId>157871062339747840</OrderId>
      </Result>
      <Code>0</Code>
      <Message>创建订单成功!</Message>
    </BatchDeleteVolumeResponse>
    
  • json格式

    {
      "result": {
        "result": true,
        "orderId": "157875123748012032"
      },
      "code": "0",
      "requestId": "5ce0e0d1-e2e5-4b54-a9c5-552266ccdf75",
      "message": "创建订单成功!"
    }
    

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.001022 云硬盘ID不能为空 400

更新云硬盘名称

更新云硬盘名称。

请求参数

名称 是否必须 描述
Action UpdateVolume
VolumeId 云硬盘UUID
NewName 云硬盘新名称

返回参数

示例

  • Sample Request(请求)
    https://ebs.cn-north-3.inspurcloudapi.com/?Action=UpdateVolume&VolumeId=29d98cfc-4ea6-40a2-b06a-99cd17a3510e&NewName=aaa11111&Nonce=21111&Timestamp=1555717904&Version=2019-01-31
    

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.001022 云硬盘ID不能为空 400
102.001011 云硬盘名称不能为空 400
102.001012 云硬盘名称长度须为2-128个字符 400
102.001013 名称须以中文、英文开头 400
102.001014 名字只能包含中文、英文、数字、特殊字符中的".","_"或"-" 400

查询云硬盘列表

查询云硬盘列表。

请求参数

名称 是否必须 描述
Action ListVolumev2
Offset 页码
Limit 每页记录条数
SearchValue 查询条件
SortField 筛选字段
SortOrder 排序
Status 状态

返回参数

名称 位置 类型 是否必须 描述
pageNo body Integer 页码
pageSize body Integer 每页记录条数
totalCount body Integer 总记录数
data body List<DataObject> 结果

示例

  • Sample Request(请求)

    https://ebs.cn-north-3.inspurcloudapi.com/?Timestamp=1663783070&Nonce=2&Version=2019-01-31&Action=ListVolumev2&Offset=1&Limit=20
    
  • Sample Response(响应)

    • xml格式

       <ListVolumev2Response>
           <DataContainer>
               <Data>
                   <VolumeType>SATA</VolumeType>
                   <SnapshotId>null</SnapshotId>
                   <AttachmentsContainer></AttachmentsContainer>
                   <BackupId>null</BackupId>
                   <Description>null</Description>
                   <ServerName>null</ServerName>
                   <BackupNum>0</BackupNum>
                   <Bootable>false</Bootable>
                   <AvailabilityZone>null</AvailabilityZone>
                   <UserId>null</UserId>
                   <CreatedAt>2019-07-24T09:52:46Z</CreatedAt>
                   <MetaData>
                       <VirtualStatus>creating</VirtualStatus>
                       <Expire/>
                       <ProductTag>EBS</ProductTag>
                       <Volume_tag>0</Volume_tag>
                   </MetaData>
                   <RegionDisplayName>华北三</RegionDisplayName>
                   <Size>20</Size>
                   <FeeData>
                       <IsAutoRenew>未知</IsAutoRenew>
                       <CreateTime>未知</CreateTime>
                       <DeleteTime>未知</DeleteTime>
                       <ServiceStatus>未知</ServiceStatus>
                       <ChargeType>未知</ChargeType>
                       <StartFeeTime>未知</StartFeeTime>
                       <DaysOfDelete>未知</DaysOfDelete>
                       <NextFeeTime>未知</NextFeeTime>
                   </FeeData>
                   <ProductTag>null</ProductTag>
                   <Name>SSZG</Name>
                   <Id>aa175584-d8ea-4323-bcdb-56884d11400a</Id>
                   <Multiattach>null</Multiattach>
                   <ImageRef>null</ImageRef>
                   <Region>cn-north-3</Region>
                   <ProjectId>null</ProjectId>
                   <Status>creating</Status>
               </Data>
           </DataContainer>
           <PageNo>1</PageNo>
           <RequestId>1f5926b8-83fb-4b1c-b50b-9c806255cde7</RequestId>
           <PageSize>1</PageSize>
           <TotalCount>10</TotalCount>
       </ListVolumev2Response>
      
    • json格式

       {
           "data": [
               {
                   "volumeType": "SATA",
                   "snapshotId": null,
                   "attachments": [],
                   "backupId": null,
                   "description": null,
                   "serverName": null,
                   "backupNum": 0,
                   "bootable": "false",
                   "availabilityZone": null,
                   "userId": null,
                   "createdAt": "2019-07-24T09:52:46Z",
                   "metaData": {
                       "virtualStatus": "creating",
                       "expire": "",
                       "productTag": "EBS",
                       "volume_tag": "0"
                   },
                   "regionDisplayName": "华北三",
                   "size": 20,
                   "feeData": {
                       "isAutoRenew": "未知",
                       "createTime": "未知",
                       "deleteTime": "未知",
                       "serviceStatus": "未知",
                       "chargeType": "未知",
                       "startFeeTime": "未知",
                       "daysOfDelete": "未知",
                       "nextFeeTime": "未知"
                   },
                   "productTag": null,
                   "name": "SSZG",
                   "id": "aa175584-d8ea-4323-bcdb-56884d11400a",
                   "multiattach": null,
                   "imageRef": null,
                   "region": "cn-north-3",
                   "projectId": null,
                   "status": "creating"
               }
           ],
           "pageNo": 1,
           "requestId": "013d1e22-7952-4b81-83fd-49ac76d83369",
           "pageSize": 1,
           "totalCount": 10
       }
      

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.001031 云硬盘列表请求参数有误 400
102.001030 获取云硬盘列表失败 500

查询云硬盘详情

查询云硬盘详情。

请求参数

名称 是否必须 描述
Action GetVolume
VolumeId 云硬盘UUID

返回参数

名称 位置 类型 是否必须 描述
volumeType body String 云硬盘类型,目前可支持SATA和SSD
snapshotId body String 快照id
attachments body List<VolumeAttachment> 挂载信息
backupId body Integer 备份id
description body String 描述
serverName body String 挂载的服务器名称
backupNum body String 备份数量
bootable body String 是否为系统盘 ,"true"为系统盘,"false"为数据盘
availabilityZone body String 可用域
userId body String 用户id(openstack)
createdAt body String 创建时间
metaData body Metadata 元数据
regionDisplayName body String 区域名称
size body Integer 云硬盘大小
feeData body Feedata 计费信息
productTag body String 产品标签
name body String 云硬盘名称
id body String 云硬盘ID
multiattach body boolean 是否支持多挂载
imageRef body String 镜像标识
region body String 区域
projectId body String 项目id(openstack)
status body String 状态

示例

  • Sample Request(请求)

    https://ebs.cn-north-3.inspurcloudapi.com/?Timestamp=1663783070&Nonce=2&Version=2019-01-31&Action=GetVolume&VolumeId=172606bd-642f-4b84-9bc1-81490e24f85d&Format=json
    
  • Sample Response(响应)

    • xml格式

      <GetVolumeResponse>
          <VolumeType>SATA</VolumeType>
          <SnapshotId>null</SnapshotId>
          <AttachmentsContainer>
              <Attachments>
                  <Hostname>cmp003</Hostname>
                  <Volume_id>172606bd-642f-4b84-9bc1-81490e24f85d</Volume_id>
                  <Attachment_id>589f9727-c5bf-4c5c-aeb0-37ea2dd7f443</Attachment_id>
                  <VolumeId>172606bd-642f-4b84-9bc1-81490e24f85d</VolumeId>
                  <Id>172606bd-642f-4b84-9bc1-81490e24f85d</Id>
                  <Server_id>cbd94682-acae-4c56-99a0-84ce3a5cd4e4</Server_id>
                  <Device>/dev/vdc</Device>
                  <ServerId>cbd94682-acae-4c56-99a0-84ce3a5cd4e4</ServerId>
                  <Host_name>cmp003</Host_name>
              </Attachments>
          </AttachmentsContainer>
          <BackupId>null</BackupId>
          <Description>null</Description>
          <ServerName>EIP-UnitTest2</ServerName>
          <BackupNum>1</BackupNum>
          <Bootable>false</Bootable>
          <AvailabilityZone>null</AvailabilityZone>
          <UserId>null</UserId>
          <CreatedAt>2019-07-10T08:54:10Z</CreatedAt>
          <MetaData>
              <Expire/>
              <ProductTag>EBS</ProductTag>
              <Attached_mode>rw</Attached_mode>
              <Volume_tag>0</Volume_tag>
          </MetaData>
          <RegionDisplayName>华北三</RegionDisplayName>
          <Size>20</Size>
          <FeeData>
              <IsAutoRenew>false</IsAutoRenew>
              <CreateTime>2019-07-10 16:54:10</CreateTime>
              <DeleteTime>null</DeleteTime>
              <ServiceStatus>alreadyOpened</ServiceStatus>
              <ChargeType>hourlySettlement</ChargeType>
              <StartFeeTime>2019-07-10 16:54:10</StartFeeTime>
              <DaysOfDelete>null</DaysOfDelete>
              <NextFeeTime>2099-12-31 23:59:59</NextFeeTime>
          </FeeData>
          <RequestId>f58ba5ba-730b-48fb-beef-65af2b5516ae</RequestId>
          <ProductTag>null</ProductTag>
          <Name>EBS-2019710165333</Name>
          <Id>172606bd-642f-4b84-9bc1-81490e24f85d</Id>
          <Multiattach>null</Multiattach>
          <ImageRef>null</ImageRef>
          <Region>cn-north-3</Region>
          <ProjectId>null</ProjectId>
          <Status>in-use</Status>
      </GetVolumeResponse>
      
    • json格式 {

        "volumeType": "SATA",
        "snapshotId": null,
        "attachments": [
            {
                "hostname": "cmp003",
                "volume_id": "172606bd-642f-4b84-9bc1-81490e24f85d",
                "attachment_id": "589f9727-c5bf-4c5c-aeb0-37ea2dd7f443",
                "volumeId": "172606bd-642f-4b84-9bc1-81490e24f85d",
                "id": "172606bd-642f-4b84-9bc1-81490e24f85d",
                "server_id": "cbd94682-acae-4c56-99a0-84ce3a5cd4e4",
                "device": "/dev/vdc",
                "serverId": "cbd94682-acae-4c56-99a0-84ce3a5cd4e4",
                "host_name": "cmp003"
            }
        ],
        "backupId": null,
        "description": null,
        "serverName": "EIP-UnitTest2",
        "backupNum": 1,
        "bootable": "false",
        "availabilityZone": null,
        "userId": null,
        "createdAt": "2019-07-10T08:54:10Z",
        "metaData": {
            "expire": "",
            "productTag": "EBS",
            "attached_mode": "rw",
            "volume_tag": "0"
        },
        "regionDisplayName": "华北三",
        "size": 20,
        "feeData": {
            "isAutoRenew": "false",
            "createTime": "2019-07-10 16:54:10",
            "deleteTime": null,
            "serviceStatus": "alreadyOpened",
            "chargeType": "hourlySettlement",
            "startFeeTime": "2019-07-10 16:54:10",
            "daysOfDelete": null,
            "nextFeeTime": "2099-12-31 23:59:59"
        },
        "requestId": "655c9ba1-d417-4402-9f94-5e52210e6f7a",
        "productTag": null,
        "name": "EBS-2019710165333",
        "id": "172606bd-642f-4b84-9bc1-81490e24f85d",
        "multiattach": null,
        "imageRef": null,
        "region": "cn-north-3",
        "projectId": null,
        "status": "in-use"
      

      }

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.001041 云硬盘不存在 404
102.001042 获取云硬盘详情失败 500

挂载云硬盘

挂载云硬盘。

请求参数

名称 是否必须 描述
Action AttachVolume
VolumeId 云硬盘UUID
InstanceUuid 云服务器UUID

返回参数

示例

  • Sample Request(请求)
    https://ebs.cn-north-3.inspurcloudapi.com/?Timestamp=1663783070&Nonce=2&Version=2019-01-31&Action=AttachVolume&VolumeId=d542fa5a-4cd9-492d-b2ce-541278aed45d&InstanceUuid=ef2ffe7d-92c2-4e66-bb50-dc3c978971db
    

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.001070 云硬盘挂载失败 500
102.001074 只有‘未挂载’状态可以挂载操作 500
102.001072 该用户下云硬盘不存在 404
102.001075 实例不存在 500
102.001076 实例挂载点已满 500

卸载云硬盘

卸载云硬盘。

请求参数

名称 是否必须 描述
Action DetachVolume
VolumeId 云硬盘UUID
AttachmentId 挂载点ID

返回参数

示例

  • Sample Request(请求)
    https://ebs.cn-north-3.inspurcloudapi.com/?Timestamp=1663783070&Nonce=2&Version=2019-01-31&Action=DetachVolume&VolumeId=d542fa5a-4cd9-492d-b2ce-541278aed45d&AttachmentId=d542fa5a-4cd9-492d-b2ce-541278aed45d
    

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.001071 云硬盘卸载失败 500
102.001073 只有‘已挂载’状态可以卸载操作 500
102.001072 该用户下云硬盘不存在 404

查询快照列表

查询快照列表。

请求参数

名称 是否必须 描述
Action ListBackups
PageNo 页码
PageSize 每页记录条数

返回参数

名称 位置 类型 是否必须 描述
totalCount body Integer 记录总数
pageNo body Integer 页码
pageSize body Integer 每页记录条数
data body List<Backup> 结果

示例

  • Sample Request(请求)

    https://ebs.cn-north-3.inspurcloudapi.com/?Timestamp=1663783070&Nonce=2&Version=2019-01-31&Action=ListBackups&PageNo=1&PageSize=1
    
  • Sample Response(响应)

    • xml格式

       <ListBackupsResponse>
           <DataContainer>
               <Data>
                   <CreatedAt>2019-07-16T08:25:00Z</CreatedAt>
                   <Size>20</Size>
                   <VolumeName>EBS-2019710165333</VolumeName>
                   <Name>test111</Name>
                   <VolumeId>172606bd-642f-4b84-9bc1-81490e24f85d</VolumeId>
                   <Id>daa23d9f-65d2-4269-a14e-007c9c3d27dd</Id>
                   <Bootable>false</Bootable>
                   <Status>restoring</Status>
               </Data>
           </DataContainer>
           <PageNo>1</PageNo>
           <RequestId>2267cb50-cd1b-4b36-a29c-38fbc3640a93</RequestId>
           <PageSize>1</PageSize>
           <TotalCount>1</TotalCount>
       </ListBackupsResponse>
      
    • json格式

      {
          "data": [
              {
                  "createdAt": "2019-07-16T08:25:00Z",
                  "size": 20,
                  "volumeName": "EBS-2019710165333",
                  "name": "test111",
                  "volumeId": "172606bd-642f-4b84-9bc1-81490e24f85d",
                  "id": "daa23d9f-65d2-4269-a14e-007c9c3d27dd",
                  "bootable": "false",
                  "status": "restoring"
              }
          ],
          "pageNo": 1,
          "requestId": "7c933784-21c5-4b89-92fc-d7a670dc8f69",
          "pageSize": 1,
          "totalCount": 1
      }
      

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.003002 获取快照失败 500

回滚快照

回滚快照数据到云硬盘。前提条件要求待回滚的云硬盘为未挂载状态,如果为挂载状态请先卸载。

请求参数

名称 是否必须 描述
Action RestoreBackup
BackupId 快照ID
VolumeId 云硬盘ID

返回参数

示例

  • Sample Request(请求)
    https://ebs.cn-north-3.inspurcloudapi.com/?Timestamp=1663783070&Nonce=2&Version=2019-01-31&Action=RestoreBackup&BackupId=daa23d9f-65d2-4269-a14e-007c9c3d27dd&VolumeId=302c3c1e-3df3-4bf0-86d6-3e305e54d7c1
    

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.003004 根据快照回滚云硬盘失败 500
102.003005 云硬盘的容量不能小于快照的容量 500
102.003006 云硬盘状态不合法,无法回滚 500

创建快照

可以通过创建快照的方式来实现云硬盘备份。

请求参数

名称 是否必须 描述
Action CreateBackup
VolumeId 云硬盘UUID
BackupName 快照名称

返回参数

示例

  • Sample Request(请求)
    https://ebs.cn-north-3.inspurcloudapi.com/?Timestamp=1663783070&Nonce=2&Version=2019-01-31&Action=CreateBackup&VolumeId=d542fa5a-4cd9-492d-b2ce-541278aed45d&BackupName=snapshot1
    

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.003020 创建备份失败 500
102.003021 云硬盘不存在 500
102.003022 云硬盘处在中间状态时创建快照不可用,包括:创建中,挂载中,卸载中,扩容中 500
102.003023 快照总配额不足 500
102.003024 该云硬盘的快照配额不足 500
102.003025 该云硬盘已删除,无法创建快照 500

删除快照

可以删除快照来释放快照配额,前提条件要求快照是可用状态。支持批量删除快照。

请求参数

名称 是否必须 描述
Action DeleteBackup
BackupId1 快照ID
... ... ...
BackupIdN 快照ID

返回参数

示例

  • Sample Request(请求)
    https://ebs.cn-north-3.inspurcloudapi.com/?Action=DeleteBackup&BackupId1=a4244d37-a258-40aa-944b-772a900ac051&BackupId2=0fe20994-efdf-418d-af82-d4f05d5ff2e9&Nonce=2366611&Timestamp=1555717904&Version=2019-01-31
    

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.003050 请选择要删除的快照 500
102.003051 仅允许删除“可用”或“错误”状态下的快照,请重新选择 500
102.003052 含有不存在的快照,请确认 500

查询快照配额

获取某个云硬盘的快照配额。

请求参数

名称 是否必须 描述
Action BackupQuota
VolumeId 云硬盘(磁盘)ID

返回参数

名称 位置 类型 是否必须 描述
remain body Integer 剩余
used body Integer 已用

示例

  • Sample Request(请求)

    https://ebs.cn-north-3.inspurcloudapi.com/?Timestamp=1663783070&Nonce=2&Version=2019-01-31&Action=BackupQuota&VolumeId=302c3c1e-3df3-4bf0-86d6-3e305e54d7c1
    
  • Sample Response(响应)

    • xml格式

      <BackupQuotaResponse>
          <Remain>6</Remain>
          <RequestId>28de029e-d6e4-4fad-83f3-b5314d285365</RequestId>
          <Used>1</Used>
      </BackupQuotaResponse>
      
    • json格式

      {
          "remain": 6,
          "requestId": "d4142283-b695-45bd-b50e-5be332655a33",
          "used": 1
      }
      

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
102.003060 获取快照配额失败 500
102.003061 云硬盘不存在 500

获取token

获取token。

URL

https:// + 请求域名 + /getToken

请求参数

名称 是否必须 描述
UserName 用户名
Password 密码

返回参数

名称 位置 类型 是否必须 描述
code body Integer 出现错误时,返回的错误码。
data body string 结果

示例

  • Sample Request(请求)

    https://ebs.cn-north-3.inspurcloudapi.com/getToken?Timestamp=1663783070&Nonce=2&Version=2019-01-31&UserName=xinjing&Password=1qaz2wsx3edc
    
  • Sample Response(响应)

    • xml格式

      <GetTokenResponse>
          <Code>200</Code>
          <Data>eyJhbGci...Qydkg</Data>
          <RequestId>8bbb6323-0258-43d4-9204-e7b81a03e998</RequestId>
      </GetTokenResponse>
      
    • json格式

      {
          "code": 200,
          "data": "eyJhbGci...Qydkg",
          "requestId": "8bbb6323-0258-43d4-9204-e7b81a03e998"
      }
      

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
401 Invalid user credentials 401