You need to enable JavaScript to run this app.
导航
DescribeVolumes
最近更新时间:2024.06.20 11:20:52首次发布时间:2021.11.17 14:15:55

调用DescribeVolumes接口查询云盘列表。

调试

请求参数

名称类型是否必填示例值描述
ActionStringDescribeVolumes要执行的操作,取值:DescribeVolumes
VolumeIds.NStringVolumeIds.1=vol-jv4gkgfal98bv6pz****&VolumeIds.2=vol-jv4gmy2isp8bv7p7****云盘ID。可以指定一个或多个。
VolumeNameStringtest云盘名称,支持模糊查询。

VolumeType

String

PTSSD

云盘类型,取值说明如下:

  • PTSSD:性能型SSD。
  • ESSD_PL0:极速型SSD云盘,PL0规格。
  • ESSD_FlexPL: 极速型SSD云盘,FlexPL规格。

说明

关于云盘规格的详细说明,请参见云盘规格

ZoneIdStringcn-beijing-a可用区ID。

VolumeStatus

String

available

云盘状态,取值说明如下:

  • available:可用
  • attaching:挂载中
  • attached:已挂载
  • detaching:卸载中
  • creating:创建中
  • deleting:删除中
  • error:错误
  • extending:扩容中
  • terminatesuspend:待释放

    说明

    退订包年包月云盘时,云盘的状态会变成待释放。

  • InstanceIdStringi-3ti74if6ay3vj0x1****挂载云盘的ECS实例ID。
    PageNumberInt1起始页码,默认1。
    PageSizeInt15页大小,最大100默认15。
    KindStringdata云盘属性,取值说明如下:
  • system:系统盘
  • data:数据盘
  • ProjectNameStringdefault根据云盘所属的Project(项目)名称筛选云盘。

    TagFilters.N.Key

    String

    TagFilters.1.Key=tag

    根据标签查询资源时指定的标签键。说明如下:

    • TagFilters.N.Key:N表示标签键的序号。取值范围:1~10。

    • 多个标签键之间用&分隔,不允许重复。

    • 不传入该参数则表示查询所有标签。

    • 传入空字符串时,则返回错误码InvalidTagFilterKey.Malformed

    TagFilters.N.Values.N

    String

    TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test

    根据标签查询资源时指定的标签值。说明如下:

    • TagFilters.N.Values.N:第一个N表示标签键的序号。取值范围:1~10。

    • TagFilters.N.Values.N:第二个N表示标签值的序号。取值范围:1~3。

    • 多个标签值之间用&分隔。

    • 如果传入该参数,则必须先传入TagFilters.N.Key

    • 不传入该参数则表示查询同一标签键下的所有标签值。

    • 传入空字符串时,表示查询标签值为空的标签。

    返回数据

    名称类型描述
    TotalCountInt符合条件的云盘总数。
    PageNumberInt页数索引。
    PageSizeInt分页的页容量。
    VolumesArray of object Volumes符合条件的云盘信息。具体请参见下表“Volumes结构”

    Volumes结构

    名称类型示例值描述
    ZoneIdStringcn-beijing-a可用区ID。
    VolumeIdStringvol-3tirbh6lka3vj0x1****云盘ID。
    VolumeNameStringtest-volume云盘名称。
    VolumeTypeStringPTSSD云盘类型。
    DescriptionString-云盘描述信息。
    InstanceIdStringi-3tirbh6lka3vj0x1****云盘挂载的实例ID。
    ImageIdStringimage-3thdzjcwq23vj0wy****云盘中的镜像ID。
    Sizeint1024云盘容量,单位GiB。

    Status

    String

    attached

    云盘状态,取值说明如下:

  • available:可用
  • attaching:挂载中
  • attached:已挂载
  • detaching:卸载中
  • creating:创建中
  • deleting:删除中
  • error:错误
  • extending:扩容中
  • terminatesuspend:待释放

    说明

    退订包年包月云盘时,云盘的状态会变成待释放。

  • KindStringsystem云盘属性,取值说明如下:
  • system:系统盘
  • data:数据盘
  • CreatedAtString2021-06-28T15:10:47+08:00云盘创建时间。
    UpdatedAtString2021-06-28T15:10:47+08:00云盘更新时间。
    BillingTypeInt2计费类型,取值说明如下:
  • 1:包年包月
  • 2:按量计费
  • PayTypeStringpost付费类型,取值说明如下:
  • pre:预付费(包年包月)
  • post:后付费(按量计费)
  • ProjectNameStringdefault云盘所属的项目。
    TradeStatusInt1费用中心的云盘状态。
    ExpiredTimeString2200-01-01 00:00:00包年包月到期时间。
    RenewTypeInt1续费方式,取值说明如下:
  • 1:手动续费
  • 2 :自动续费
  • 3 :到期不续费
  • OverdueReclaimTimeString-云盘欠费回收时间。
    OverdueTimeString-云盘欠费关停时间。
    DeleteWithInstanceBooleantrue释放实例时,该云盘是否随实例一起释放,取值说明如下:
  • true:云盘随实例一起释放。
  • false:云盘不随实例一起释放。
  • BaselinePerformanceArray of object BaselinePerformance-云盘基准性能,具体请参见下表“BaselinePerformance结构”。
    TagsArray of Struct-云盘的标签信息,具体请参见下表“ Tag结构 ”。

    BaselinePerformance结构

    名称类型示例值描述
    IOPSInt2160云盘的基准IOPS,单位为次/秒。
    ThroughputInt107云盘的基准吞吐量,单位为MB/s。

    Tag结构

    名称类型示例值描述
    KeyStringtag云盘的标签键。
    ValueStringtest云盘的标签值。

    请求示例

    GET /?Action=DescribeVolumes&Version=2020-04-01&VolumeIds.1=vol-jv4gkgfal98bv6pz****&VolumeIds.2=vol-jv4gmy2isp8bv7p7**** HTTP/1.1
    Host: open.volcengineapi.com
    Region: cn-beijing
    ServiceName: storage_ebs
    

    返回示例

    {
        "ResponseMetadata": {
            "RequestId": "20230417210548EEFE5B400750987DA5C0",
            "Action": "DescribeVolumes",
            "Version": "2020-04-01",
            "Service": "storage_ebs",
            "Region": "cn-beijing"
        },
        "Result": {
            "PageNumber": 1,
            "PageSize": 15,
            "TotalCount": 2,
            "Volumes": [
                {
                    "BaselinePerformance": {
                        "IOPS": 2160,
                        "Throughput": 107
                    },
                    "BillingType": 2,
                    "CreatedAt": "2023-03-03T16:23:47+08:00",
                    "DeleteWithInstance": false,
                    "Description": "标签测试",
                    "ExpiredTime": "2200-01-01 00:00:00",
                    "ImageId": "",
                    "InstanceId": "",
                    "Kind": "data",
                    "OverdueReclaimTime": "",
                    "OverdueTime": "",
                    "PayType": "post",
                    "ProjectName": "",
                    "RenewType": 1,
                    "Size": "30",
                    "Status": "available",
                    "Tags": [
                        {
                            "Key": "tag1",
                            "Value": "test1"
                        }
                    ],
                    "TradeStatus": 1,
                    "UpdatedAt": "2023-04-11T11:16:19+08:00",
                    "VolumeId": "vol-jv4gkgfal98bv6pz****",
                    "VolumeName": "tagtest1",
                    "VolumeType": "ESSD_PL0",
                    "ZoneId": "cn-beijing-b"
                },
                {
                    "BaselinePerformance": {
                        "IOPS": 2040,
                        "Throughput": 105
                    },
                    "BillingType": 2,
                    "CreatedAt": "2023-03-03T15:58:23+08:00",
                    "DeleteWithInstance": false,
                    "Description": "标签测试",
                    "ExpiredTime": "2200-01-01 00:00:00",
                    "ImageId": "",
                    "InstanceId": "",
                    "Kind": "data",
                    "OverdueReclaimTime": "",
                    "OverdueTime": "",
                    "PayType": "post",
                    "ProjectName": "",
                    "RenewType": 1,
                    "Size": "20",
                    "Status": "available",
                    "Tags": [
                        {
                            "Key": "tag",
                            "Value": "test"
                        }
                    ],
                    "TradeStatus": 1,
                    "UpdatedAt": "2023-04-11T11:16:19+08:00",
                    "VolumeId": "vol-jv4gmy2isp8bv7p7****",
                    "VolumeName": "Tagtest",
                    "VolumeType": "ESSD_PL0",
                    "ZoneId": "cn-beijing-a"
                }
            ]
        }
    }
    

    错误码

    HttpCode错误码错误信息
    404VolumeNotFound云盘未查询到