DATASOURCE::ECS::Snapshots查询ECS快照列表-资源编排-阿里云

DATASOURCE::ECS::Snapshots类型用于查询一台ECS实例或一块云盘所有的快照列表。

语法

{
  "Type": "DATASOURCE::ECS::Snapshots",
  "Properties": {
    "Status": String,
    "Usage": String,
    "Category": String,
    "KMSKeyId": String,
    "ResourceGroupId": String,
    "InstanceId": String,
    "Encrypted": Boolean,
    "SnapshotLinkId": String,
    "SnapshotIds": List,
    "SnapshotName": String,
    "Filters": List,
    "SnapshotType": String,
    "SourceDiskType": String,
    "Tags": List,
    "DiskId": String,
    "RefreshOptions": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
Status	String	否	是	快照状态。	取值： progressing：正在创建。 accomplished：创建成功。 failed：创建失败。 all（默认值）：所有快照状态。
Usage	String	否	是	快照是否被用作创建镜像或云盘。	取值： image：使用快照创建了自定义镜像。 disk：使用快照创建了云盘。 image_disk：使用快照创建了数据盘和自定义镜像。 none：暂未使用快照。
Category	String	否	是	快照类型。	取值： Standard：标准快照。 Flash：本地快照。
KMSKeyId	String	否	是	数据盘对应的KMS密钥ID。	无
ResourceGroupId	String	否	是	资源组ID。	使用该参数过滤资源时，资源数量不能超过1000个。
InstanceId	String	否	是	实例ID。	无
Encrypted	Boolean	否	是	是否过滤加密快照。	取值： true：过滤加密快照。 false（默认值）：不过滤加密快照。
SnapshotLinkId	String	否	是	快照链ID。	无
SnapshotIds	List	否	是	快照ID列表。	最多支持100个快照ID，多个快照ID之间用半角逗号（,）分隔。
SnapshotName	String	否	是	快照名称。	无
Filters	List	否	是	查询资源时的筛选键值。	最多支持指定2个筛选键值。更多信息，请参见Filters属性。
SnapshotType	String	否	是	快照创建类型。	取值： auto：自动创建快照。 user：手动创建快照。 all（默认值）：所有的快照创建类型。
SourceDiskType	String	否	是	源云盘类型。	取值： System：系统盘。 Data：数据盘。
Tags	List	否	是	快照的标签。	最多支持指定20个标签。更多信息，请参见Tags属性。
DiskId	String	否	是	云盘设备ID。	无
RefreshOptions	String	否	是	当资源栈更新时，数据源资源的刷新策略。	有效值： Never（默认值）：更新堆栈时，从不刷新数据源资源。 Always：更新堆栈时，始终刷新数据源资源。

Filters语法

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

Filters属性

属性名称

类型

必须

允许更新

描述

约束

Value

String

否

查询资源时的筛选值。

采用UTC+0时区。

格式：yyyy-MM-ddTHH:mmZ。

Key

String

是

否

查询资源时的筛选键。

取值：

CreationStartTime：创建开始时间。
CreationEndTime：创建结束时间。

Tags语法

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

Tags属性

属性名称	类型	必须	允许更新	描述	约束
Value	String	否	否	快照的标签值。	长度为0~128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或`https://` 。
Key	String	是	否	快照的标签键。	长度为1~128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或`https://` 。

返回数据（Fn::GetAtt）

SnapshotIds：快照ID列表。
Snapshots：快照列表详情。

属性名称	类型	描述	约束
SnapshotIds	List	快照ID列表。	取值示例：`["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", … "s-bp67acfmxazb6p**"]`。
Snapshots	List	快照列表详情。	无
Status	String	快照状态。	取值： progressing：正在创建。 accomplished：创建成功。 failed：创建失败。
Progress	String	快照创建进度。	单位：百分比。取值示例：`100%`。
Usage	String	快照是否被用作创建镜像或云盘。	取值： image：使用快照创建了自定义镜像。 disk：使用快照创建了云盘。 image_disk：使用快照创建了数据盘和自定义镜像。 none：暂未使用快照。
Description	String	描述信息。	无
Category	String	快照类型。	取值： Standard：标准快照。 Flash：本地快照。
KMSKeyId	String	数据盘对应的KMS密钥ID。	无
ProductCode	String	从镜像市场继承的产品编号。	无
Encrypted	Boolean	该快照是否加密。	取值： true：加密。 false：不加密。
SnapshotName	String	快照名称。	无
SourceDiskId	String	源云盘ID。	快照的源云盘被释放后，该字段仍旧保留。
SourceStorageType	String	源云盘类型。	无
SnapshotId	String	快照ID。	无
SnapshotSN	String	快照的序列号。	无
SourceDiskSize	String	源云盘容量。	单位：GiB。
SnapshotType	String	快照创建类型。	取值： auto：自动创建快照。 user：手动创建快照。
SourceDiskType	String	源云盘类型。	取值： System：系统盘。 Data：数据盘。
Tags	List	标签。	取值示例：`[{'Value': 'value_test', 'Key': 'test123'}]`。

示例

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SnapshotName": {
      "Type": "String",
      "Description": "The name of the snapshot.",
      "Default": "auto_20150730_3"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ECS::Snapshots",
      "Properties": {
        "SnapshotName": {
          "Ref": "SnapshotName"
        }
      }
    }
  },
  "Outputs": {
    "SnapshotIds": {
      "Description": "the list of snapshot ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SnapshotIds"
        ]
      }
    },
    "Snapshots": {
      "Description": "the list of snapshots.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Snapshots"
        ]
      }
    }
  }
}