全部產品
Search
文件中心

:DATASOURCE::ECS::Disks

更新時間:Oct 11, 2024

DATASOURCE::ECS::Disks類型用於查詢您已經建立的Block Storage(包括雲端硬碟以及本地碟)。

文法

{
  "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,
    "RefreshOptions": String
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

Status

String

雲端硬碟狀態。

取值:

  • In_use:使用中。

  • Available:待掛載。

  • Attaching:掛載中。

  • Detaching:卸載中。

  • Creating:建立中。

  • ReIniting:初始化中。

  • All(預設值):所有狀態。

DiskIds

List

雲端硬碟或本地碟ID。

最多支援100個ID,多個ID之間用半形逗號(,)分隔。

樣本:["d-bp67acfmxazb4p****", "d-bp67acfmxazb4g****", … "d-bp67acfmxazb4d****"]

EnableShared

String

是否是共用Block Storage。

取值:

  • true:是共用Block Storage。

  • false(預設值):不是共用Block Storage。

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:查詢共用Block Storage。

DiskType

String

要查詢的雲端硬碟或本地碟類型。

取值:

  • all(預設值):同時查詢系統硬碟與資料盤。

  • system:只查詢系統硬碟。

  • data:只查詢資料盤。

SnapshotId

String

建立雲端硬碟時使用的快照ID。

Portable

String

雲端硬碟或本地碟是否支援卸載。

取值:

  • true:支援卸載。

  • false:不支援卸載。

Filters

List

查詢資源時的篩選值。

取值範圍:1~2。

更多資訊,請參見Filters屬性

AdditionalAttributes

List

其他屬性值。

目前僅支援指定IOPS,表示查詢當前磁碟的IOPS上限。

Tags

List

雲端硬碟或本地碟的標籤。

更多資訊,請參見Tags屬性

RefreshOptions

String

當資源棧更新時,資料來源資源的重新整理策略。

取值:

  • Never(預設值):更新堆棧時,從不重新整理資料來源資源。

  • Always:更新堆棧時,始終重新整理資料來源資源。

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

雲端硬碟所屬的專屬Block Storage叢集ID。

如果您的雲端硬碟在公用雲Block Storage叢集中,則該參數為空白。

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組成的列表,查詢共用Block Storage時不返回該列表。

樣本:

 [
      {
        "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