All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::ECS::Snapshot

最終更新日:Sep 06, 2024

DATASOURCE::ECS::Snapshot is used to query the information about a snapshot.

Syntax

{
  "Type": "DATASOURCE::ECS::Snapshot",
  "Properties": {
    "SnapshotId": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

SnapshotId

String

Yes

Yes

The snapshot ID.

None.

Return values

Fn::GetAtt

  • InstantAccess: indicates whether the instant access feature is enabled for the snapshot.

  • Usage: indicates whether the snapshot is used to create an image or a cloud disk.

  • Progress: the creation progress of the snapshot.

  • Description: the description.

  • ResourceGroupId: the ID of the resource group.

  • ProductCode: the product code of the Alibaba Cloud Marketplace image.

  • Encrypted: indicates whether the snapshot is encrypted.

  • CreateTime: the creation time of the snapshot.

  • RetentionDays: the retention period of the automatic snapshot.

  • InstantAccessRetentionDays: the validity period of the instant access feature.

  • SnapshotName: the snapshot name.

  • SourceStorageType: the category of the source cloud disk.

  • SnapshotId: the snapshot ID.

  • SnapshotSN: the serial number of the snapshot.

  • SourceDiskSize: the size of the source cloud disk.

  • SnapshotType: the snapshot type.

  • SourceDiskType: the type of the source cloud disk.

  • RemainTime: the remaining period of time required to create the snapshot.

  • Tags: the tags.

  • DiskId: the ID of the cloud disk.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      SnapshotId:
        Type: String
        Description:
          en: The snapshot id.
        Required: true
        AssociationProperty: ALIYUN::ECS::Snapshot::SnapshotId
    Resources:
      ExtensionDataSource:
        Type: DATASOURCE::ECS::Snapshot
        Properties:
          SnapshotId:
            Ref: SnapshotId
    Outputs:
      InstantAccess:
        Description: Whether snapshot speed availability is enabled.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - InstantAccess
      Usage:
        Description: A resource type that has a reference relationship.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Usage
      Progress:
        Description: Snapshot creation progress, in percentage.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Progress
      Description:
        Description: The description.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Description
      ResourceGroupId:
        Description: The resource group id.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ResourceGroupId
      ProductCode:
        Description: The product number inherited from the mirror market.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ProductCode
      Encrypted:
        Description: Whether the snapshot is encrypted.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Encrypted
      CreateTime:
        Description: The create time.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - CreateTime
      RetentionDays:
        Description: Automatic snapshot retention days.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - RetentionDays
      InstantAccessRetentionDays:
        Description: InstantAccessRetentionDays.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - InstantAccessRetentionDays
      SnapshotName:
        Description: Snapshot Display Name.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - SnapshotName
      SourceStorageType:
        Description: Original disk type.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - SourceStorageType
      SnapshotId:
        Description: The snapshot id.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - SnapshotId
      SnapshotSN:
        Description: Snapshot serial number.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - SnapshotSN
      SourceDiskSize:
        Description: Source disk capacity.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - SourceDiskSize
      SnapshotType:
        Description: Snapshot creation type.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - SnapshotType
      SourceDiskType:
        Description: Source disk attributes.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - SourceDiskType
      RemainTime:
        Description: Remaining completion time for the snapshot being created.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - RemainTime
      Tags:
        Description: The tags.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Tags
      DiskId:
        Description: The source disk id.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DiskId
    
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "SnapshotId": {
          "Type": "String",
          "Description": {
            "en": "The snapshot id."
          },
          "Required": true,
          "AssociationProperty": "ALIYUN::ECS::Snapshot::SnapshotId"
        }
      },
      "Resources": {
        "ExtensionDataSource": {
          "Type": "DATASOURCE::ECS::Snapshot",
          "Properties": {
            "SnapshotId": {
              "Ref": "SnapshotId"
            }
          }
        }
      },
      "Outputs": {
        "InstantAccess": {
          "Description": "Whether snapshot speed availability is enabled.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "InstantAccess"
            ]
          }
        },
        "Usage": {
          "Description": "A resource type that has a reference relationship.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Usage"
            ]
          }
        },
        "Progress": {
          "Description": "Snapshot creation progress, in percentage.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Progress"
            ]
          }
        },
        "Description": {
          "Description": "The description.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Description"
            ]
          }
        },
        "ResourceGroupId": {
          "Description": "The resource group id.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ResourceGroupId"
            ]
          }
        },
        "ProductCode": {
          "Description": "The product number inherited from the mirror market.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ProductCode"
            ]
          }
        },
        "Encrypted": {
          "Description": "Whether the snapshot is encrypted.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Encrypted"
            ]
          }
        },
        "CreateTime": {
          "Description": "The create time.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "CreateTime"
            ]
          }
        },
        "RetentionDays": {
          "Description": "Automatic snapshot retention days.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "RetentionDays"
            ]
          }
        },
        "InstantAccessRetentionDays": {
          "Description": "InstantAccessRetentionDays.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "InstantAccessRetentionDays"
            ]
          }
        },
        "SnapshotName": {
          "Description": "Snapshot Display Name.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "SnapshotName"
            ]
          }
        },
        "SourceStorageType": {
          "Description": "Original disk type.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "SourceStorageType"
            ]
          }
        },
        "SnapshotId": {
          "Description": "The snapshot id.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "SnapshotId"
            ]
          }
        },
        "SnapshotSN": {
          "Description": "Snapshot serial number.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "SnapshotSN"
            ]
          }
        },
        "SourceDiskSize": {
          "Description": "Source disk capacity.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "SourceDiskSize"
            ]
          }
        },
        "SnapshotType": {
          "Description": "Snapshot creation type.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "SnapshotType"
            ]
          }
        },
        "SourceDiskType": {
          "Description": "Source disk attributes.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "SourceDiskType"
            ]
          }
        },
        "RemainTime": {
          "Description": "Remaining completion time for the snapshot being created.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "RemainTime"
            ]
          }
        },
        "Tags": {
          "Description": "The tags.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Tags"
            ]
          }
        },
        "DiskId": {
          "Description": "The source disk id.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DiskId"
            ]
          }
        }
      }
    }