DATASOURCE::ECS::Disks类型用于查询您已经创建的块存储(包括云盘以及本地盘)。

语法

{
  "Type": "DATASOURCE::ECS::Disks",
  "Properties": {
    "Status": String,
    "DiskIds": List,
    "EnableShared": String,
    "Category": String,
    "KMSKeyId": String,
    "ResourceGroupId": String,
    "ZoneId": String,
    "InstanceId": String,
    "Encrypted": Boolean,
    "DeleteWithInstance": Boolean,
    "DeleteAutoSnapshot": String,
    "EnableAutomatedSnapshotPolicy": Boolean,
    "DiskChargeType": String,
    "EnableAutoSnapshot": Boolean,
    "AutoSnapshotPolicyId": String,
    "DiskName": String,
    "MultiAttach": String,
    "DiskType": String,
    "SnapshotId": String,
    "Portable": String,
    "Filters": List,
    "AdditionalAttributes": List,
    "Tags": List
  }
}

属性

属性名称 类型 必须 允许更新 描述 约束
Status String 云盘状态。 取值:
  • In_use:使用中。
  • Available:待挂载。
  • Attaching:挂载中。
  • Detaching:卸载中。
  • Creating:创建中。
  • ReIniting:初始化中。
  • All(默认值):所有状态。
DiskIds List 云盘或本地盘ID。 最多支持100个ID,多个ID之间用半角逗号(,)分隔。

示例:["d-bp67acfmxazb4p****", "d-bp67acfmxazb4g****", … "d-bp67acfmxazb4d****"]

EnableShared String 是否是共享块存储。 取值:
  • true:是共享块存储。
  • false(默认值):不是共享块存储。
Category String 云盘或本地盘种类。 取值:
  • all:所有云盘以及本地盘。
  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD盘。
  • cloud_essd:ESSD云盘。
  • local_ssd_pro:I/O密集型本地盘。
  • local_hdd_pro:吞吐密集型本地盘。
KMSKeyId String 云盘使用的KMS密钥ID。
ResourceGroupId String 云盘或本地盘所在的资源组ID。
ZoneId String 可用区ID。
InstanceId String 云盘或本地盘挂载的实例ID。
Encrypted Boolean 是否为加密云盘。 取值:
  • true:加密云盘。
  • false(默认值):不是加密云盘。
DeleteWithInstance Boolean 是否随实例释放。 取值:
  • true:云盘随实例一起释放。
  • false(默认值):云盘保留不释放,转为按量付费数据盘而保留下来。
DeleteAutoSnapshot String 释放云盘时,是否会同时删除自动快照。 取值:
  • true:删除自动快照。
  • false(默认值):保留自动快照。
EnableAutomatedSnapshotPolicy Boolean 云盘是否设置了自动快照策略。 取值:
  • true:已设置自动快照策略。
  • false(默认值):未设置自动快照策略。
DiskChargeType String 云盘或本地盘的计费方式。 取值:
  • PrePaid:包年包月。
  • PostPaid:按量付费。
EnableAutoSnapshot Boolean 云盘是否启用自动快照策略功能。 取值:
  • true:启用自动快照策略功能
  • false(默认值):禁用自动快照策略功能。
AutoSnapshotPolicyId String 云盘采用的自动快照策略ID。
DiskName String 云盘或本地盘名称。
MultiAttach String 是否开启了多重挂载特性。 取值:
  • Disabled:未开启。
  • Enabled:已开启。
  • LegacyShared:查询共享块存储。
DiskType String 要查询的云盘或本地盘类型。 取值:
  • all(默认值):同时查询系统盘与数据盘。
  • system:只查询系统盘。
  • data:只查询数据盘。
SnapshotId String 创建云盘时使用的快照ID。
Portable String 云盘或本地盘是否支持卸载。 取值:
  • true:支持卸载。
  • false:不支持卸载。
Filters List 查询资源时的筛选值。 取值范围:1~2。

更多信息,请参见Filters属性

AdditionalAttributes List 其他属性值。 目前仅支持指定IOPS,表示查询当前磁盘的IOPS上限。
Tags List 云盘或本地盘的标签。 更多信息,请参见Tags属性

Filters语法

"Filters": [
  {
    "Value": String,
    "Key": String
  }
]

Filters属性

属性名称 类型 必须 允许更新 描述 约束
Value String 筛选值。 示例:2021-12-12T12:12Z
Key String 筛选键。 示例:CreationStartTime

Tags语法

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags属性

属性名称 类型 必须 允许更新 描述 约束
Value String 标签值。
Key String 标签键。

返回数据(Fn::GetAtt)

  • DiskIds:云盘或本地盘ID列表。
  • Disks:云盘或本地盘信息组成的集合。
属性名称 类型 描述 约束
DiskIds List 云盘或本地盘ID列表。 示例:['d-bp180bogui4ky7o4****','d-bp180bogui4ky7o4****']
Disks List 云盘或本地盘信息组成的集合。
Type String 云盘或本地盘类型。
Status String 云盘状态。
SerialNumber String 云盘或本地盘的序列号。 示例:bp18um4r4f2fve2****
PerformanceLevel String ESSD云盘的性能等级。 取值:
  • PL0:单盘最高随机读写IOPS 1万。
  • PL1:单盘最高随机读写IOPS 5万。
  • PL2:单盘最高随机读写IOPS 10万。
  • PL3:单盘最高随机读写IOPS 100万。
EnableAutoSnapshot Boolean 云盘是否启用自动快照策略功能。
StorageSetId String 存储集ID。 示例:ss-i-bp1j4i2jdf3owlhe****
DiskId String 云盘或本地盘ID。 示例值:d-bp18um4r4f2fve24****
StorageSetPartitionNumber Integer 存储集中的最大分区数量。
MultiAttach String 是否开启了多重挂载特性。
DeleteAutoSnapshot Boolean 是否同时删除自动快照。
Encrypted Boolean 是否为加密云盘。
IOPSRead Integer 每秒读操作的次数。 单位:次/s。
MountInstanceNum Integer 共享存储挂载的实例数量。
Description String 云盘或本地盘描述。
Device String 云盘或本地盘挂载的实例的设备名。 当Status取值为In_use时返回该参数。开启多重挂载特性的云盘,该参数始终为空。

示例:/dev/xvda

DiskName String 云盘或本地盘名称。
Portable Boolean 云盘或本地盘是否支持卸载。
StorageClusterId String 云盘所属的专属块存储集群ID。 如果您的云盘在公共云块存储集群中,则该参数为空。
ImageId String 创建ECS实例时使用的镜像ID。 只有通过镜像创建的云盘将返回该参数,否则为空。
DeleteWithInstance Boolean 是否随实例释放。
KMSKeyId String 云盘使用的KMS密钥ID。
DetachedTime String 云盘最后一次卸载时间(UTC时间)。 示例:2021-06-07T21:01:22Z
SourceSnapshotId String 创建云盘使用的快照ID。 如果创建云盘时,没有指定快照,则该参数值为空。
AutoSnapshotPolicyId String 云盘采用的自动快照策略ID。
EnableAutomatedSnapshotPolicy Boolean 云盘是否设置了自动快照策略。
IOPSWrite Integer 每秒写操作的次数。 单位:次/s。
InstanceId String 云盘或本地盘挂载的实例ID。
IOPS Integer 每秒读写(I/O)操作的次数。 单位:次/s。
ExpiredTime String 包年包月云盘的过期时间(UTC时间)。 示例:2021-07-07T16:00Z
Size Integer 云盘或本地盘大小。 示例值:60
ResourceGroupId String 云盘或本地盘所在的资源组ID。
ZoneId String 云盘或本地盘所属的可用区ID。
DiskChargeType String 云盘或本地盘的计费方式。
Category String 云盘或本地盘种类。
AttachedTime String 该云盘最后一次挂载的时间(UTC时间)。 示例:2021-06-05T21:01:22Z
ProductCode String 云市场的商品标识。
OperationLocks List 云盘或本地盘锁定的原因类型。
Tags List 云盘或本地盘的标签集合。 示例:
[
      {
        "Value": "value_test",
        "Key": "key_test"
      },
      {
        "Value": "value_test2",
        "Key": "key_test2"
      }
    ]
Attachments List 云盘所涉及的挂载信息。 由Attachment组成的列表,查询共享块存储时不返回该列表。

示例:

 [
      {
        "AttachedTime": "2022-02-14T09:13:39Z",
        "InstanceId": "i-bp1evllqxw6b1srq****",
        "Device": "/dev/xvda"
      }
    ],

示例

  • JSON格式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Resources": {
        "Disks": {
          "Type": "DATASOURCE::ECS::Disks",
          "Properties": {
            "Filters": [
              {
                "Key": "CreationStartTime",
                "Value": "2021-12-12T12:12Z"
              }
            ]
          }
        }
      },
      "Outputs": {
        "Disks": {
          "Value": {
            "Fn::GetAtt": [
              "Disks",
              "Disks"
            ]
          }
        },
        "DisksIds": {
          "Value": {
            "Fn::GetAtt": [
              "Disks",
              "DiskIds"
            ]
          }
        }
      }
    }
  • YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
    Resources:
      Disks:
        Type: DATASOURCE::ECS::Disks
        Properties:
          Filters:
            - Key: CreationStartTime
              Value: 2021-12-12T12:12Z
    Outputs:
      Disks:
        Value:
          Fn::GetAtt:
            - Disks
            - Disks
      DisksIds:
        Value:
          Fn::GetAtt:
            - Disks
            - DiskIds