すべてのプロダクト
Search

このプロダクト

    File Storage NAS:DescribeSnapshots

    ドキュメントセンター

    File Storage NAS:DescribeSnapshots

    最終更新日:Apr 04, 2026

    1 つ以上のファイルシステムのスナップショットに関する情報を照会します。

    操作説明

    • スナップショット機能はパブリックプレビュー中であり、無料で提供されます。パブリックプレビューでは、File Storage NAS サービスレベルアグリーメント (SLA) は保証されません。

    • この機能は、高度な超高速型 NAS ファイルシステムのみでサポートされています。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    nas:DescribeSnapshots

    get

    *Snapshot

    acs:nas:{#regionId}:{#accountId}:snapshot/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    FileSystemType

    string

    任意

    ファイルシステムのタイプ。

    有効な値： extreme。超高速型 File Storage NAS (NAS) ファイルシステムを示します。

    extreme
    FileSystemId

    string

    任意

    ファイルシステムの ID。

    extreme-22f****
    SnapshotIds

    string

    任意

    スナップショット ID。

    最大 100 個のスナップショット ID を指定できます。スナップショット ID はコンマ (,) で区切る必要があります。

    s-extreme-67pxwk9aevrkr****,s-extreme-snapsho****,s-extreme-6tmsbas6ljhwh****
    SnapshotName

    string

    任意

    スナップショット名。

    FinanceJoshua
    SnapshotType

    string

    任意

    スナップショットのタイプ。

    有効な値：

    • auto： 自動スナップショット

    • user： 手動スナップショット

    • all (デフォルト)： すべてのスナップショットタイプ

    all
    Status

    string

    任意

    スナップショットのステータス。

    有効な値：

    • progressing： スナップショットは作成中です。

    • accomplished： スナップショットは作成済みです。

    • failed： スナップショットの作成に失敗しました。

    • all (デフォルト)： すべてのスナップショットステータス。

    all
    PageSize

    integer

    任意

    1ページあたりのエントリ数。

    有効な値： 1～100。

    デフォルト値： 10。

    10
    PageNumber

    integer

    任意

    ページ番号。

    ページは 1 から始まります。デフォルト値： 1。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    返されたスナップショットの総数。

    36
    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    PageSize

    integer

    1ページあたりのエントリ数。

    10
    PageNumber

    integer

    ページ番号。

    1
    Snapshots

    object

    Snapshot

    array<object>

    スナップショットの詳細。

    object

    Status

    string

    スナップショットのステータス。

    有効な値：

    • progressing： スナップショットは作成中です。

    • accomplished： スナップショットは作成済みです。

    • failed： スナップショットの作成に失敗しました。

    accomplished
    Progress

    string

    スナップショット作成の進捗状況をパーセンテージで示します。

    100
    CreateTime

    string

    スナップショットが作成された時刻。

    時刻は、ISO 8601 標準に準拠した協定世界時 (UTC) です。時刻は yyyy-MM-ddThh:mmZ 形式で表示されます。

    2014-07-24T13:00:52Z
    SourceFileSystemId

    string

    ソースファイルシステムの ID。

    このパラメーターは、スナップショットのソースファイルシステムが削除された場合でも保持されます。

    extreme-012****
    RetentionDays

    integer

    自動スナップショットの保存期間。

    単位： 日。

    有効な値：

    • -1： 自動スナップショットは永続的に保持されます。自動スナップショットの数が上限を超えると、最も古い自動スナップショットが自動的に削除されます。

    • 1～65536： 自動スナップショットは指定された日数保持されます。自動スナップショットの保存期間が終了すると、自動スナップショットは自動的に削除されます。

    30
    RemainTime

    integer

    スナップショットの作成に必要な残り時間。

    単位： 秒。

    38
    SourceFileSystemSize

    integer

    ソースファイルシステムの容量。

    単位： GiB。

    2000
    SourceFileSystemVersion

    string

    ソースファイルシステムのバージョン。

    1
    SnapshotName

    string

    スナップショット名。

    スナップショットを作成するために名前を指定した場合、そのスナップショットの名前が返されます。それ以外の場合、このパラメーターには値が返されません。

    FinanceJoshua
    EncryptType

    integer

    スナップショットが暗号化されているかどうかを示します。

    有効な値：

    • 0： スナップショットは暗号化されていません。

    • 1： スナップショットは暗号化されています。

    1
    Description

    string

    スナップショットの説明。

    FinanceDept
    SnapshotId

    string

    スナップショット ID。

    s-extreme-snapsho****
    FileSystemType

    string

    ファイルシステムのタイプ。

    extreme
    SnapshotType

    string

    スナップショットタイプ。有効な値：

    • auto： 自動作成されたスナップショット

    • user： 手動で作成されたスナップショット

    user
    CompletedTime

    string

    スナップショットの作成が完了した時刻。

    時刻は、ISO 8601 標準に準拠した協定世界時 (UTC) です。時刻は yyyy-MM-ddThh:mmZ 形式で表示されます。

    説明

    このパラメーターは、スナップショットが作成された場合にのみ有効です。スナップショットの作成中、このパラメーターの値は `CreateTime` の値と同じです。

    2014-07-24T13:10:52Z

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 36,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "accomplished",
        "Progress": "100",
        "CreateTime": "2014-07-24T13:00:52Z",
        "SourceFileSystemId": "extreme-012****",
        "RetentionDays": 30,
        "RemainTime": 38,
        "SourceFileSystemSize": 2000,
        "SourceFileSystemVersion": "1",
        "SnapshotName": "FinanceJoshua",
        "EncryptType": 1,
        "Description": "FinanceDept",
        "SnapshotId": "s-extreme-snapsho****",
        "FileSystemType": "extreme",
        "SnapshotType": "user",
        "CompletedTime": "2014-07-24T13:10:52Z"
      }
    ]
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。