• 文档
  • 控制台
  • 登录
  • 立即注册
    目前不支持用户自主注册,如需注册账号,请联系400-080-1100
云硬盘EBS API参考手册
最近更新时间:2023-04-16 17:00:00

1 云硬盘管理

1.1 CreateVolume

 调用 CreateVolume 接口创建一个云盘。

1.1.1 使用说明

 POST https://{Endpoint}/ebs/v1.0/volumes
 创建云盘会自动扣费。返回成功后异步处理,可通过查询云盘详情查看状态信息。

1.1.2 请求参数

image.png

image.png

image.png

1.1.3 返回数据

image.png

1.1.4 示例

 1. 请求示例
 POST https://{Endpoint}/ebs/v1.0/volumes{"Name": "myTestVolume4", "Size": 20, "VolumeType": "vspec-hdd", "AvailabilityZone": "dev-001","ChargingMode": "1", "PeriodType": "month", "Duration": 1}
 2. 正常返回示例
 HTTP/1.1 200OK
 Content-Type:application/json
 {
      "RequestId": "1663911924",
      "VolumeId": "vol-pr4k10l3c22ac4",
      "Status": 1,
      "Name": "myTestVolume5",
      "Description": "www",
      "AvailabilityZone": "zone-1",
      "VolumeType": "vspec-hdd",
      "Multiattach": false,
      "Size": 20,
      "Bootable": false,
      "TenantId": "220109012210140"
 }

1.2 DeleteVolume

 调用 DeleteVolume 接口删除一个云盘。

1.2.1 使用说明

 DELETE https://{Endpoint}/ebs/v1.0/volume/:volume_id
 不能删除正在使用中或含有快照的云盘,删除云盘会自动退费。返回成功后异步处理,可通过查询云盘详情查看状态信息。

1.2.2 请求参数

image.png

1.2.3 返回数据

image.png

1.2.4 示例

 1. 请求示例
 DELETE https://{Endpoint}/ebs/v1.0/volume/vol-pr2siiaz2p37vy
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***"
 }

1.3 ExtendVolume

 调用 ExtendVolume 接口扩容云盘。

1.3.1 使用说明

 POST https://{Endpoint}/ebs/v1.0/instance/extendvolume
 返回成功后异步处理,可通过查询云盘详情查看状态信息。

1.3.2 请求参数

image.png

image.png

1.3.3 返回数据

image.png

1.3.4 示例

 1. 请求示例
 POST https://{Endpoint}/ebs/v1.0/instance/extendvolume
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***"
 }

1.4 RenewOrder

 调用 RenewOrder 接口给云盘续费。

1.4.1 使用说明

 POST https://{Endpoint}/ebs/v1.0/instance/reneworder
 自动扣费。

1.4.2 请求参数

image.png

image.png

1.4.3 返回数据

image.png

 表1-1 Instance 对象数据

image.png

1.4.4 示例

 1. 请求示例
 POST https://{Endpoint}/ebs/v1.0/instance/reneworder
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "1660209141",
      "Instances": [
      {
          "InstanceId": "vol-ha27fwhbnji8yd",
          "EndTime": "2022-09-15 23:59:59"
      }
      ]
 }

1.5 GetVolume

 调用 GetVolume 接口获取一个云盘详情。

1.5.1 使用说明

 GET https://{Endpoint}/ebs/v1.0/volume/:volume_id
 获取云盘详情。

1.5.2 请求参数

image.png

1.5.3 Volume 对象

image.png

image.png

image.png

 表1-2 云盘状态定义(Status)

image.png

image.png

1.5.4 示例

 1. 请求示例
 GET https://{Endpoint}/ebs/v1.0/volume/vol-haqaojk0xz2wmn
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "1660657335",
      "InstaceId": "",
      "CreatedTime": "2022-08-16 21:40:39",
      "ExpireTime": "",
      "HaveSnapshot": 0,
      "VolumeId": "vol-haqaojk0xz2wmn",
      "ImageName": "test-img",
      "ImageId": "img-ha5fmbsiwv7l6i",
      "ImageDeleted": false,
      "AncestorInfo": "{\"container_format\":\"bare\",\"cpu_architecture\":\"arm\",\"image\":\"img�ha5fmbsiwv7l6i\",\"os_bit\":\"64\",\"os_type\":\"linux\",\"os_version\":\"10.1\",\"platform\":\"kylin\",\"class\":\"\"}",
      "SnapshotId": "",
      "Iops": 2400,
      "IsVmDelete": 0,
      "Multiattach": true,
      "Name": "postman-jiuzhang04-v9",
      "OrderId": "",
      "PayModel": "",
      "RegionCode": "hanmei01",
      "Remark": "高效云盘",
      "VolumeType": "vspec-hdd",
      "Type": "高效云盘",
      "Status": 2,
      "AvailabilityZone": "zone-1",
      "ZoneName": "可用区 01",
      "EcsId": "",
      "EcsName": "",
      "VmHostList": null,
      "ResourceCode": "cecloud",
      "Description": "postman-jiuzhang04-jiu2",
      "PolicyId": "policy-ha4aqwj7rsguoc",
      "Size": 20,
      "Bootable": true,
      "TenantId": "220007042600900"
 }

1.6 GetVolumes

 调用 GetVolumes 接口查询用户云盘列表。

1.6.1 使用说明

 GET https://{Endpoint}/ebs/v1.0/volumes
 获取云盘列表。

1.6.2 请求参数

image.png

image.png

1.6.3 返回数据

image.png

1.6.4 示例

 1. 请求示例
 GET https://{Endpoint}/ebs/v1.0/volumes?PageSize=2&PageNumber=1
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "1660209638",
      "InstaceId": "",
      "Volumes": [
      {
          "RequestId": "1660657335",
          "InstaceId": "",
          "CreatedTime": "2022-08-16 21:40:39",
          "ExpireTime": "2022-09-16 23:59:59",
          "HaveSnapshot": 0,
          "VolumeId": "vol-haqaojk0xz2wmn",
          "ImageName": "test-img",
          "ImageId": "img-ha5fmbsiwv7l6i",
          "ImageDeleted": false,
          "AncestorInfo": "{\"container_format\":\"bare\",\"cpu_architecture\":\"arm\",\"image\":\"img�ha5fmbsiwv7l6i\",\"os_bit\":\"64\",\"os_type\":\"linux\",\"os_version\":\"10.1\",\"platform\":\"kylin\",\"class\":\"\"}",
          "SnapshotId": "",
          "Iops": 2400,
          "IsVmDelete": 0,
          "Multiattach": true,
          "Name": "postman-jiuzhang04-v9",
          "OrderId": "220816000008645",
          "PayModel": "1",
          "RegionCode": "hanmei01",
          "Remark": "高效云盘",
          "VolumeType": "vspec-hdd",
          "Type": "高效云盘",
          "Status": 2,
          "AvailabilityZone": "zone-1",
          "ZoneName": "可用区 01",
          "EcsId": "",
          "EcsName": "",
          "VmHostList": [
          {
              "VmHostId": "ecs-ha0ooqm9zssgwh",
              "VmHostName": "xy1-test-01"
          }
          ],
          "ResourceCode": "cecloud",
          "Description": "postman-jiuzhang04-jiu2",
          "PolicyId": "policy-ha4aqwj7rsguoc",
          "Size": 20,
          "Bootable": true,
          "TenantId": "220007042600900"
      },
      {
          "CreatedTime": "2022-08-11 16:31:15",
          "ExpireTime": "2022-09-11 23:59:59",
          "HaveSnapshot": 0,
          "VolumeId": "vol-ha5pizboriwhgr",
          "ImageName": "",
          "ImageId": "",
          "ImageDeleted": false,
          "AncestorInfo": "",
          "SnapshotId": "",
          "Iops": 1880,
          "IsVmDelete": 0,
          "Multiattach": false,
          "Name": "TEST-OPEN-123",
          "OrderId": "220811000005102",
          "PayModel": "1",
          "RegionCode": "hanmei01",
          "Remark": "高效云盘",
          "VolumeType": "vspec-hdd",
          "Type": "高效云盘",
          "Status": 2,
          "AvailabilityZone": "zone-1",
          "ZoneName": "可用区 01",
          "EcsId": "",
          "EcsName": "",
          "VmHostList": [],
          "ResourceCode": "cecloud",
          "Description": "",
          "PolicyId": "",
          "Size": 10,
          "Bootable": false,
          "TenantId": "220007042600900"
      },
      {
          "CreatedTime": "2022-08-11 16:14:59",
          "ExpireTime": "2022-09-11 23:59:59",
          "HaveSnapshot": 1,
          "VolumeId": "vol-hav6bc0ngfqdqn",
          "ImageName": "",
          "ImageId": "",
          "ImageDeleted": false,
          "AncestorInfo": "",
          "SnapshotId": "",
          "Iops": 1880,
          "IsVmDelete": 0,
          "Multiattach": false,
          "Name": "yuyafei-data1",
          "OrderId": "220811000005089",
          "PayModel": "1",
          "RegionCode": "hanmei01",
          "Remark": "高效云盘",
          "VolumeType": "vspec-hdd",
          "Type": "高效云盘",
          "Status": 4,
          "AvailabilityZone": "zone-1",
          "ZoneName": "可用区 01",
          "EcsId": "",
          "EcsName": "",
          "VmHostList": [
          {
              "VmHostId": "ecs-ha0ooqm9zwgwh3",
              "VmHostName": "cxy-test-01"
          }
          ],
          "ResourceCode": "cecloud",
          "Description": "",
          "PolicyId": "",
          "Size": 10,
          "Bootable": false,
          "TenantId": "220007042600900"
      },
      {
          "CreatedTime": "2022-08-11 16:08:05",
          "ExpireTime": "2022-09-11 23:59:59",
          "HaveSnapshot": 0,
          "VolumeId": "vol-ha3tyxbrjg1s9r",
          "ImageName": "",
          "ImageId": "",
          "ImageDeleted": false,
          "AncestorInfo": "",
          "SnapshotId": "",
          "Iops": 2120,
          "IsVmDelete": 0,
          "Multiattach": true,
          "Name": "yuyafei_multiattach",
          "OrderId": "220811000006335",
          "PayModel": "1",
          "RegionCode": "hanmei01",
          "Remark": "高效云盘",
          "VolumeType": "vspec-hdd",
          "Type": "高效云盘",
          "Status": 4,
          "AvailabilityZone": "zone-1",
          "ZoneName": "可用区 01",
          "EcsId": "",
          "EcsName": "",
          "VmHostList": [
          {
              "VmHostId": "ecs-ha0ooqm9zwgwh3",
              "VmHostName": "cxy-test-01"
          },
          {
              "VmHostId": "ecs-ha9cf1o97l76el",
              "VmHostName": "cxy-os-2"
          }
          ],
          "ResourceCode": "cecloud",
          "Description": "",
          "PolicyId": "",
          "Size": 40,
          "Bootable": false,
          "TenantId": "220007042600900"
      },
      {
          "CreatedTime": "2022-08-10 17:06:54",
          "ExpireTime": "2022-09-15 23:59:59",
          "HaveSnapshot": 0,
          "VolumeId": "vol-ha27fwhbnji8yd",
          "ImageName": "",
          "ImageId": "",
          "ImageDeleted": false,
          "AncestorInfo": "",
          "SnapshotId": "",
          "Iops": 3000,
          "IsVmDelete": 0,
          "Multiattach": true,
          "Name": "cecloud-volume-597wj",
          "OrderId": "220810000004943",
          "PayModel": "1",
          "RegionCode": "hanmei01",
          "Remark": "高效云盘",
          "VolumeType": "vspec-hdd",
          "Type": "高效云盘",
          "Status": 4,
          "AvailabilityZone": "zone-1",
          "ZoneName": "可用区 01",
          "EcsId": "",
          "EcsName": "",
          "VmHostList": [
          {
              "VmHostId": "ecs-ha0ooqm9zwgwh3",
              "VmHostName": "cxy-test-01"
          }
          ],
          "ResourceCode": "cecloud",
          "Description": "",
          "PolicyId": "",
          "Size": 40,
          "Bootable": false,
          "TenantId": "220007042600900"
      }
      ],
      "TotalCount": 74
 }

1.7 AttachVolume

 调用 AttachVolume 接口挂载一个云盘到一个云主机。

1.7.1 使用说明

 POST https://{Endpoint}/ebs/v1.0/instance/attachvolume
 只能挂载支持共享的数据盘,或者可用的数据盘。
 返回成功后异步处理,可通过查询云盘详情查看状态信息。

1.7.2 请求参数

image.png

1.7.3 返回数据

image.png

1.7.4 示例

 1. 请求示例
 POST https://{Endpoint}/ebs/v1.0/instance/attachvolume
 {
      "VolumeId": "vol-hax67jnus1yni5",
      "EcsId": "ecs-ha9detk166d0if"
 }
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***"
 }

1.8 DetachVolume

 调用 DetachVolume 接口从云主机卸载一个云盘。

1.8.1 使用说明

 POST https://{Endpoint}/ebs/v1.0/instance/detachvolume
 返回成功后异步处理,可通过查询云盘详情查看状态信息。

1.8.2 请求参数

image.png

1.8.3 返回数据

image.png

1.8.4 示例

 1. 请求示例
 POST https://{Endpoint}/ebs/v1.0/instance/detachvolume
 {
      "VolumeId": "vol-hax67jnus1yni5",
      "EcsId": "ecs-ha9detk166d0if"
 }
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***"
 }

1.9 CreateSnapshot

 调用 CreateSnapshot 接口从一个云盘创建快照。

1.9.1 使用说明

 POST https://{Endpoint}/ebs/v1.0/snapshots
 返回成功后异步处理,可通过查询快照列表中指定快照 ID 查看状态信息。

1.9.2 请求参数

image.png

1.9.3 返回数据

image.png

1.9.4 示例

 1. 请求示例
 POST https://{Endpoint}/ebs/v1.0/snapshots
 {
      "VolumeId": "vol-stjfv3985x39pk",
      "SnapshotName": "snap-postman-openapitest3",
      "Description":"Feixcdecef"
 }
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***"
      "InstaceId": "snap-df1sdf135sd41f5"
 }

1.10 DeleteSnap

 调用 DeleteSnapshot 接口删除一个云盘快照。

1.10.1 使用说明

 DELETE https://{Endpoint}/ebs/v1.0/snapshot/:snapshot_id
 返回成功后异步处理,可通过查询快照列表中指定快照 ID 查看状态信息。

1.10.2 请求参数

image.png

1.10.3 返回数据

image.png

1.10.4 示例

 1. 请求示例
 DELETE https://{Endpoint}/ebs/v1.0/snapshot/snap-pryh278c1ohxjt
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***"
 }

1.11 GetSnapshots

 调用 GetSnapshots 接口获取快照列表。

1.11.1 使用说明

 GET https://{Endpoint}/ebs/v1.0/snapshots
 获取快照列表。

1.11.2 请求参数

image.png

1.11.3 返回数据

image.png

 表1-3 快照对象数据

image.png

image.png

 表1-4 快照状态定义(Status)

image.png

image.png

1.11.4 示例

 1. 请求示例
 GET https://{Endpoint}/ebs/v1.0/snapshots?PageSize=10&PageNumber=1
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "1661233172",
      "InstaceId": "",
      "Snapshots": [
      {
          "Size": 70,
          "CreateTime": "2022-08-22 18:36:47",
          "Description": "",
          "SnapshotId": "snap-has2krg0b8q423",
          "SnapshotName": "snapshot-48307-ttq",
          "RegionCode": "hanmei01",
          "RegionName": "",
          "ResourceCode": "",
          "Status": 2,
          "TenantId": "220007042600900",
          "VolumeSize": 70,
          "VolumeId": "vol-hapjewknqgq8at",
          "VolumeName": "ttq-cecloud-volume-31671",
          "VolumeRemark": "高效云盘",
          "VolumeType": "vspec-hdd",
          "AvailabilityZone": "zone-1",
          "ZoneName": "可用区 1",
          "Bootable": false,
          "Protected": false
      },
      {
          "Size": 10,
          "CreateTime": "2022-08-11 16:51:25",
          "Description": "",
          "SnapshotId": "snap-haj0seatd1kt7a",
          "SnapshotName": "snapshot-10467",
          "RegionCode": "hanmei01",
          "RegionName": "",
          "ResourceCode": "",
          "Status": 2,
          "TenantId": "220007042600900",
          "VolumeSize": 10,
          "VolumeId": "vol-hav6bc0ngfqdqn",
          "VolumeName": "yuyafei-data1",
          "VolumeRemark": "高效云盘",
          "VolumeType": "vspec-hdd",
          "AvailabilityZone": "zone-1",
          "ZoneName": "可用区 1",
          "Bootable": false,
          "Protected": false
      }
      ],
      "TotalCount": 12
 }

1.12 GetVolumeTypes

 调用 GetvolumeTypes 接口获取存储类型列表。

1.12.1 使用说明

 GET https://{Endpoint}/ebs/v1.0/volumetypes
 创建云盘时,需要选择一个存储类型。

1.12.2 请求参数

image.png

1.12.3 返回数据

image.png

 表1-5 VolumeTypeSpec 对象

image.png

1.12.4 示例

 1. 请求示例
 GET https://{Endpoint}/ebs/v1.0/volumetypes
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "1660210713",
      "InstaceId": "",
      "VolumeTypeSpecs": [
      {
          "Id": "vspec-ha6s6mf1cragrn",
          "Name": "高效云盘",
          "Total": 142180
      },
      {
          "Id": "vspec-hakp6l94rtpi3b",
          "Name": "SSD 云盘",
          "Total": 800000
      }
      ],
      "TotalCount": 2
 }

1.13 GetGroupSnapshotsInfo

 调用 GetGroupSnapshotsInfo 接口获取云主机快照列表。

1.13.1 使用说明

 GET https://{Endpoint}/ebs/v1.0/snapshot/group
 调用分页接口获取主机快照列表。

1.13.2 请求参数

image.png

1.13.3 返回数据

image.png

 表1-6 GroupSnapshots 结构体

image.png

1.13.4 示例

 1. 请求示例
 GET
 https://{Endpoint}/ebs/v1.0/snapshot/group?PageNumber=1&PageSize=3&GroupSnapshotId=gs-colspgv3a7izck
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "dsfsdffsdfsfsdfs",
      "InstaceId": "",
      "GroupSnapshots": [
      {
          "ServerId": "ecs-coy1k5tt8wtlgm",
          "GroupSnapshotId": "gs-coljrosu64hu4m",
          "CreatedAt": "2022-06-22T10:02:24.405+08:00",
          "Type": 0
      },
      {
          "ServerId": "ecs-coxkeby9yztiws",
          "GroupSnapshotId": "gs-co5emp4oo614wf",
          "CreatedAt": "2022-06-21T21:22:29.801+08:00",
          "Type": 0
      },
      {
          "ServerId": "ecs-coy1k5tt8wtlgm",
          "GroupSnapshotId": "gs-colspgv3a7izck",
          "CreatedAt": "2022-06-21T21:22:23.619+08:00",
          "Type": 0
      }
      ],
      "TotalCount": 3
 }

1.14 DeleteSnapshotGroup

 调用 DeleteSnapshotGroup 接口删除云主机快照。

1.14.1 使用说明

 DELETE https://{Endpoint}/ebs/v1.0/snapshot/group/:group_snapshot_id
 调用接口删除云主机快照。

1.14.2 请求参数

image.png

1.14.3 返回数据

image.png

1.14.4 示例

 1. 请求示例
 DELETE https://{Endpoint}/ebs/v1.0/snapshot/group/gs-ha0hiobs0nqp3
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***"
 }

1.15 RollbackSnapshot

 调用 RollbackSnapshot 接口回滚快照源盘到快照。

1.15.1 使用说明

 POST https://{Endpoint}/ebs/v1.0/snapshot/:snapshot_id/rollback
 调用接口回滚快照源盘到快照。

1.15.2 请求参数

image.png

1.15.3 返回数据

image.png

1.15.4 示例

 1. 请求示例
 POST https://{Endpoint}/ebs/v1.0/snapshot/snap-pryh278c1ohxjt/rollback
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "1661501427",
 }

1.16 UpdateVolumeName

 调用 UpdateVolumeName 修改云盘名称。

1.16.1 使用说明

 POST http(s)://{Endpoint}/ebs/v1.0/instance/updateVolumeName
 调用云盘名称修改接口修改云盘名称。

1.16.2 请求参数

image.png

1.16.3 返回数据

image.png

1.16.4 示例

 1. 请求示例
 POST http(s)://{Endpoint}/ebs/v1.0/instance/updateVolumeName
 {
      "VolumeId": "vol-hax67jnus1yni5",
      "Name": "test-1008-13"
 }
 2.正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "1663911924"
 }

1.17 UpdateVolumeDesc

 调用 UpdateVolumeDesc 修改云盘描述。

1.17.1 使用说明

 POST http(s)://{Endpoint}/ebs/v1.0/instance/updateVolumeDescription
 调用云盘描述修改接口修改云盘描述信息。

1.17.2 请求参数

image.png

1.17.3 返回数据

image.png

1.17.4 示例

 1.请求示例
 POST http(s)://{Endpoint}/ebs/v1.0/instance/updateVolumeDescription
 {
      "VolumeId": "vol-hax67jnus1yni5",
      "Description": "Highwdwd"
 }
 2.正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "1663911990"
 }

1.18 UpdateSnapshotName

 调用 UpdateSnapshotName 修改快照名称。

1.18.1 使用说明

 POST http(s)://{Endpoint}/ebs/v1.0/instance/updateSnapshotName
 调用快照名称修改接口修改快照名称。

1.18.2 请求参数

image.png

1.18.3 返回数据

image.png

1.18.4 示例

 1.请求示例
 POST http(s)://{Endpoint}/ebs/v1.0/instance/updateSnapshotName
 {
      "SnapshotId": "snap-prhwwzkszbvr59",
      "Name": "snapshot-70732"
 }
 2.正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "1663911897"
 }

1.19 UpdateSnapshotDesc

 调用 UpdateSnapshotDesc 修改快照描述。

1.19.1 使用说明

 POST http(s)://{Endpoint}/ebs/v1.0/instance/updateSnapshotDesc
 调用快照描述修改接口修改快照描述信息。

1.19.2 请求参数

image.png

1.19.3 返回数据

image.png

1.19.4 示例

 1.请求示例
 POST http(s)://{Endpoint}/ebs/v1.0/instance/updateSnapshotDesc
 {
      "SnapshotId": "snap-prhwwzkszbvr59",
      "Description": "fyyf"
 }
 2.正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "RequestId": "1663911567"
 }

1.20 GetEncryptionKeyNames

 调用 GetEncryptionKeyNames 接口查询可用的加密密钥名。

1.20.1 使用说明

 GET http(s)://{Endpoint}/v1.0/volume/getEncryptionKeyNames
 调用获取密钥名称列表接口获取密钥名称列表。

1.20.2 请求参数

 无

1.20.3 返回数据

image.png

1.20.4 示例

 1.请求示例
 GET http(s)://{Endpoint}/v1.0/volume/getEncryptionKeyNames
 2.正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
      "data": [
          "minio-key-cestc",
          "minio-key-cestc-1",
          "minio-key-cestc-2"
     ]
 }

1.21 SupportEncryption

 调用 SupportEncryption 接口查询所选云盘规格是否支持加密。

1.21.1 使用说明

 GET http(s)://{Endpoint}/v1.0/volume/supportEncryption/:specId
 调用 SupportEncryption 接口查询所选云盘规格是否支持加密。

1.21.2 请求参数

image.png

1.21.3 返回数据

image.png

1.21.4 示例

 1.请求示例
 GET http(s)://{Endpoint}/v1.0/volume/supportEncryption/vspec-ssd
 2. 正常返回示例
 HTTP/1.1 200 OK
 Content-Type:application/json
 {
     "data": true
 }

意见反馈

文档内容是否对您有帮助?

如您有其他疑问,您也可以通过在线客服来与我们联系探讨 在线客服

联系我们
回到顶部