DATASOURCE::ECS::Disk - Resource Orchestration Service

DATASOURCE::ECS::Disk is used to query the information about a cloud disk.

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
DiskId	String	Yes	Yes	The disk ID.	None.

Return values

Fn::GetAtt

DetachedTime: the most recent time when the disk was detached.
Category: the disk category.
Description: the description of the disk.
ResourceGroupId: the ID of the resource group to which the disk belongs.
Encrypted: indicates whether the disk is an encrypted one.
Size: the disk size.
DeleteAutoSnapshot: indicates whether the automatic snapshots of the disk are deleted when the disk is released.
IopsWrite: the maximum write IOPS.
StorageSetPartitionNumber: the maximum number of partitions in the storage set.
MultiAttach: indicates whether the multi-attach feature is enabled.
ExpiredTime: the expiration time of the disk.
ImageId: the image ID.
PaymentType: the billing method.
StorageSetId: the ID of the storage set.
IopsRead: the maximum read IOPS.
Tags: the tags of the disk.
AttachedTime: the most recent time when the disk was attached.
BurstingEnabled: indicates whether the performance burst feature is enabled.
StorageClusterId: the ID of the dedicated block storage cluster.
KmsKeyId: the ID of the Key Management Service (KMS) key that is used by the disk.
ZoneId: the zone ID of the disk.
InstanceId: the instance ID.
ProductCode: the product code in Alibaba Cloud Marketplace.
Device: the device name of the instance to which the disk is attached.
PerformanceLevel: the performance level (PL) of the Enterprise SSD (ESSD).
DeleteWithInstance: indicates whether the disk is released when the instance to which the disk is attached is released.
EnableAutomatedSnapshotPolicy: indicates whether an automatic snapshot policy is applied to the disk.
CreateTime: the time when the disk was created.
EnableAutoSnapshot: indicates whether the automatic snapshot policy feature is enabled for the disk.
AutoSnapshotPolicyId: the ID of the automatic snapshot policy that is applied to the disk.
Iops: the maximum read/write IOPS.
ProvisionedIops: the provisioned read/write IOPS of the ESSD AutoPL disk.
DiskName: the disk name.
OperationLocks: the reasons why the disk was locked.
SnapshotId: the ID of the snapshot that is used to create the disk.
Portable: indicates whether the disk can be detached.
MountInstanceNum: the number of instances to which the Shared Block Storage device is attached.
MountInstances: the information about the Shared Block Storage device that is attached to the instances.
DiskId: the disk ID.

Examples

YAML format

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 format

{
  "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"
        ]
      }
    }
  }
}