使用DATASOURCE::ECS::Disk查询云盘资源的属性与返回值-资源编排-阿里云

DATASOURCE::ECS::Disk类型用于查询单个云盘详情。

语法

{
  "Type": "DATASOURCE::ECS::Disk",
  "Properties": {
    "DiskId": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

DiskId

String

是

磁盘 ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

DetachedTime：该云盘最后一次卸载时间。
Category：磁盘类型。
Description：云盘描述信息。
ResourceGroupId：云盘所在的企业资源组 ID。
Encrypted：是否为加密云盘。
Size：云盘大小。
DeleteAutoSnapshot：是否同时删除自动快照。
IopsWrite：每秒写操作的次数上限。
StorageSetPartitionNumber：存储集中的最大分区数量。
MultiAttach：云盘是否开启了多重挂载特性。
ExpiredTime：磁盘到期时间。
ImageId：镜像 ID。
PaymentType：付费类型。
StorageSetId：存储集 ID。
IopsRead：每秒读操作的次数上限。
Tags：云盘的标签列表。
AttachedTime：该云盘最后一次挂载的时间。
BurstingEnabled：是否开启 Burst（性能突发）。
StorageClusterId：专属块存储集群 ID。
KmsKeyId：云盘使用的 KMS 密钥 ID。
ZoneId：云盘所在的可用区。
InstanceId：实例 ID。
ProductCode：云市场的商品标识。
Device：磁盘挂载的实例的设备名。
PerformanceLevel：ESSD 云盘的性能等级。
DeleteWithInstance：磁盘是否设置了随实例释放。
EnableAutomatedSnapshotPolicy：云盘是否设置了自动快照策略。
CreateTime：云盘创建时间。
EnableAutoSnapshot：云盘是否启用自动快照策略功能。
AutoSnapshotPolicyId：云盘采用的自动快照策略 ID。
Iops：每秒读写（I/O）操作的次数上限。
ProvisionedIops：ESSD AutoPL 云盘预配置的读写 IOPS。
DiskName：磁盘名称。
OperationLocks：磁盘锁定原因类型。
SnapshotId：创建云盘时使用的快照 ID。
Portable：磁盘是否支持卸载。
MountInstanceNum：共享存储挂载的实例数量。
MountInstances：共享存储挂载到实例上的信息集合。
DiskId：磁盘 ID。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DiskId:
    Type: String
    Description:
      en: The disk id.
    Required: true
    AssociationProperty: ALIYUN::ECS::Disk::DiskId
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ECS::Disk
    Properties:
      DiskId:
        Ref: DiskId
Outputs:
  DetachedTime:
    Description: Unloading time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DetachedTime
  Category:
    Description: Disk type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Category
  Description:
    Description: The description.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  ResourceGroupId:
    Description: The resource group id.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  Encrypted:
    Description: Whether the disk is encrypted.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Encrypted
  Size:
    Description: Disk size.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Size
  DeleteAutoSnapshot:
    Description: Whether to delete automatic snapshots at the same time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeleteAutoSnapshot
  IopsWrite:
    Description: Number of writes per second.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IopsWrite
  StorageSetPartitionNumber:
    Description: 'Number of Save set partitions. Value range: greater than or equal to 2. The maximum value cannot exceed the equity quota limit displayed after calling.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - StorageSetPartitionNumber
  MultiAttach:
    Description: Whether to enable the multi-Mount feature.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MultiAttach
  ExpiredTime:
    Description: The expiration time of a monthly disk.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpiredTime
  ImageId:
    Description: The image id.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ImageId
  PaymentType:
    Description: Payment method for disk.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  StorageSetId:
    Description: The ID of the Save set.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - StorageSetId
  IopsRead:
    Description: Number of reads per second.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IopsRead
  Tags:
    Description: The tags.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  AttachedTime:
    Description: The attached time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AttachedTime
  BurstingEnabled:
    Description: Does the data disk turn on Burst (performance Burst).
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BurstingEnabled
  StorageClusterId:
    Description: The ID of the dedicated block storage cluster. If you need to create a cloud disk in the specified dedicated block storage cluster, specify this parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - StorageClusterId
  KmsKeyId:
    Description: The KMS keyId.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - KmsKeyId
  ZoneId:
    Description: ID of the free zone to which the disk belongs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneId
  InstanceId:
    Description: The instance id.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceId
  ProductCode:
    Description: The product logo of the cloud market.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ProductCode
  Device:
    Description: Cloud disk or the device name of the mounted instance on the site.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Device
  PerformanceLevel:
    Description: Performance levels of ESSD cloud disk.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PerformanceLevel
  DeleteWithInstance:
    Description: Whether to release with the instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeleteWithInstance
  EnableAutomatedSnapshotPolicy:
    Description: Whether the disk implements an automatic snapshot policy.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnableAutomatedSnapshotPolicy
  CreateTime:
    Description: The creation time.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  EnableAutoSnapshot:
    Description: Whether the disk implements an automatic snapshot policy.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnableAutoSnapshot
  AutoSnapshotPolicyId:
    Description: Automatic snapshot policy ID.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AutoSnapshotPolicyId
  Iops:
    Description: Number of read/write (I/O) operations per second.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Iops
  ProvisionedIops:
    Description: 'The preconfigured read and write IOPS of the ESSD AutoPL cloud disk. Possible values: 0 ~ min{50,000, 1000 * capacity-baseline performance}.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ProvisionedIops
  DiskName:
    Description: The disk name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskName
  OperationLocks:
    Description: Resource locking information.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - OperationLocks
  SnapshotId:
    Description: The source snapshot id.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SnapshotId
  Portable:
    Description: Whether the disk is unmountable.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Portable
  MountInstanceNum:
    Description: Number of instances mounted on shared storage.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MountInstanceNum
  MountInstances:
    Description: Disk mount instances.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MountInstances
  DiskId:
    Description: The disk id.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DiskId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DiskId": {
      "Type": "String",
      "Description": {
        "en": "The disk id."
      },
      "Required": true,
      "AssociationProperty": "ALIYUN::ECS::Disk::DiskId"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ECS::Disk",
      "Properties": {
        "DiskId": {
          "Ref": "DiskId"
        }
      }
    }
  },
  "Outputs": {
    "DetachedTime": {
      "Description": "Unloading time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DetachedTime"
        ]
      }
    },
    "Category": {
      "Description": "Disk type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Category"
        ]
      }
    },
    "Description": {
      "Description": "The description.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The resource group id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "Encrypted": {
      "Description": "Whether the disk is encrypted.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Encrypted"
        ]
      }
    },
    "Size": {
      "Description": "Disk size.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Size"
        ]
      }
    },
    "DeleteAutoSnapshot": {
      "Description": "Whether to delete automatic snapshots at the same time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeleteAutoSnapshot"
        ]
      }
    },
    "IopsWrite": {
      "Description": "Number of writes per second.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IopsWrite"
        ]
      }
    },
    "StorageSetPartitionNumber": {
      "Description": "Number of Save set partitions. Value range: greater than or equal to 2. The maximum value cannot exceed the equity quota limit displayed after calling.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StorageSetPartitionNumber"
        ]
      }
    },
    "MultiAttach": {
      "Description": "Whether to enable the multi-Mount feature.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MultiAttach"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "The expiration time of a monthly disk.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "ImageId": {
      "Description": "The image id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ImageId"
        ]
      }
    },
    "PaymentType": {
      "Description": "Payment method for disk.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "StorageSetId": {
      "Description": "The ID of the Save set.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StorageSetId"
        ]
      }
    },
    "IopsRead": {
      "Description": "Number of reads per second.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IopsRead"
        ]
      }
    },
    "Tags": {
      "Description": "The tags.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "AttachedTime": {
      "Description": "The attached time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AttachedTime"
        ]
      }
    },
    "BurstingEnabled": {
      "Description": "Does the data disk turn on Burst (performance Burst).",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BurstingEnabled"
        ]
      }
    },
    "StorageClusterId": {
      "Description": "The ID of the dedicated block storage cluster. If you need to create a cloud disk in the specified dedicated block storage cluster, specify this parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StorageClusterId"
        ]
      }
    },
    "KmsKeyId": {
      "Description": "The KMS keyId.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "KmsKeyId"
        ]
      }
    },
    "ZoneId": {
      "Description": "ID of the free zone to which the disk belongs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "InstanceId": {
      "Description": "The instance id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "ProductCode": {
      "Description": "The product logo of the cloud market.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ProductCode"
        ]
      }
    },
    "Device": {
      "Description": "Cloud disk or the device name of the mounted instance on the site.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Device"
        ]
      }
    },
    "PerformanceLevel": {
      "Description": "Performance levels of ESSD cloud disk.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PerformanceLevel"
        ]
      }
    },
    "DeleteWithInstance": {
      "Description": "Whether to release with the instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeleteWithInstance"
        ]
      }
    },
    "EnableAutomatedSnapshotPolicy": {
      "Description": "Whether the disk implements an automatic snapshot policy.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnableAutomatedSnapshotPolicy"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "EnableAutoSnapshot": {
      "Description": "Whether the disk implements an automatic snapshot policy.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnableAutoSnapshot"
        ]
      }
    },
    "AutoSnapshotPolicyId": {
      "Description": "Automatic snapshot policy ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AutoSnapshotPolicyId"
        ]
      }
    },
    "Iops": {
      "Description": "Number of read/write (I/O) operations per second.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Iops"
        ]
      }
    },
    "ProvisionedIops": {
      "Description": "The preconfigured read and write IOPS of the ESSD AutoPL cloud disk. Possible values: 0 ~ min{50,000, 1000 * capacity-baseline performance}.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ProvisionedIops"
        ]
      }
    },
    "DiskName": {
      "Description": "The disk name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskName"
        ]
      }
    },
    "OperationLocks": {
      "Description": "Resource locking information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "OperationLocks"
        ]
      }
    },
    "SnapshotId": {
      "Description": "The source snapshot id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SnapshotId"
        ]
      }
    },
    "Portable": {
      "Description": "Whether the disk is unmountable.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Portable"
        ]
      }
    },
    "MountInstanceNum": {
      "Description": "Number of instances mounted on shared storage.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MountInstanceNum"
        ]
      }
    },
    "MountInstances": {
      "Description": "Disk mount instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MountInstances"
        ]
      }
    },
    "DiskId": {
      "Description": "The disk id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DiskId"
        ]
      }
    }
  }
}