すべてのプロダクト
Search

このプロダクト

    Security Center:DescribeSnapshots

    ドキュメントセンター

    Security Center:DescribeSnapshots

    最終更新日:Mar 21, 2026

    ランサムウェア対策機能で作成されたバックアップスナップショットを照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    yundun-sas:DescribeSnapshots

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Uuid

    string

    任意

    サーバーの UUID。

    説明

    DescribeBackupPolicy 操作を呼び出して、サーバーの UUID を照会できます。

    061d8042-59ff-416e-bc33-294a1cf5****
    MachineRegion

    string

    任意

    サーバーが配置されているリージョン。

    説明

    Uuid パラメーターが指定されていない場合、このパラメーターは必須です。

    us-east-1
    MachineRemark

    string

    任意

    サーバーの名前または IP アドレス。

    192.168.XX.XX
    StatusList

    string

    任意

    データ復元が可能なバックアップスナップショットのステータス。有効な値は以下のとおりです。

    • COMPLETE：完了

    • PARTIAL_COMPLETE：部分的に完了

    ["COMPLETE"]
    PageSize

    integer

    必須

    1 ページあたりに返すエントリ数。

    20
    CurrentPage

    integer

    任意

    返すページ番号。デフォルト値は 1 です。

    1
    NextToken

    string

    任意

    クエリの開始位置。このパラメーターを空欄のままにした場合、クエリは先頭から開始されます。

    説明

    初回呼び出し時には、このパラメーターを指定する必要はありません。初回の応答には、2 回目の呼び出しで使用できるトークンが含まれます。以降の各応答にも、次の呼び出しで使用できるトークンが含まれます。

    CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAB4SwmEAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM0NzY3YTZjNjI3NjZmNmU3MjcxNjk3NDY5MzY3MjY4****
    ApiVersion

    string

    必須

    ランサムウェア対策ポリシーのバージョン。有効な値は以下のとおりです。

    • 1.0.0

    • 2.0.0

    2.0.0
    IsAliYunEcs

    string

    任意

    サーバーが Elastic Compute Service (ECS) インスタンスであるかどうかを指定します。有効な値は以下のとおりです。

    • true：はい

    • false：いいえ

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    RequestId

    string

    リクエスト ID。問題の特定およびトラブルシューティングに使用されます。

    A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****
    PageInfo

    object

    ページネーション情報。

    CurrentPage

    integer

    返されるページのページ番号。

    1
    NextToken

    string

    次の呼び出しを開始するために使用されるトークン。

    CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****
    PageSize

    integer

    1 ページあたりに返されるエントリ数。

    20
    TotalCount

    integer

    返されるエントリの合計数。

    149
    Count

    integer

    現在のページで返されるエントリ数。

    20
    Snapshots

    array<object>

    バックアップスナップショットを含む配列。

    object

    バックアップスナップショットに関する情報。

    Status

    string

    バックアップタスクのステータス。有効な値は以下のとおりです。

    • COMPLETE：完了

    • PARTIAL_COMPLETE：部分的に完了

    • FAILED：失敗

    COMPLETE
    SnapshotHash

    string

    バックアップスナップショットのハッシュ値。

    9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****
    ActualItems

    integer

    実際のバックアップ対象オブジェクト数。

    説明

    このパラメーターは、ファイルバックアップの場合のみ利用可能です。

    123
    VaultId

    string

    バックアップスナップショットを格納するバックアップボールトの ID。

    v-000ccok3zmw7fbzz****
    ActualBytes

    integer

    重複排除後のバックアップスナップショットの実際のデータ量（バイト単位）。

    686188****
    SourceType

    string

    データソースの種類。有効な値は以下のとおりです。

    • ECS_FILE：ECS ファイル

    • OSS：Object Storage Service (OSS) バケット

    • NAS：File Storage NAS ファイルシステム

    • OTS_TABLE：Tablestore インスタンス

    ECS_FILE
    ClientId

    string

    SourceType パラメーターの値が ECS_FILE の場合にのみ返されるパラメーターです。Hybrid Backup Recovery (HBR) エージェントの ID を示します。

    c-000dbefaw9f7gnbw****
    ItemsDone

    integer

    バックアップ対象オブジェクト数。

    説明

    このパラメーターは、ファイルバックアップの場合のみ利用可能です。

    6
    BytesTotal

    integer

    データソースの総データ量（バイト単位）。

    3484541815****
    Retention

    integer

    バックアップスナップショットの保持期間。

    7
    CreatedTime

    integer

    バックアップスナップショットの作成時刻。値は UNIX タイムスタンプ（秒単位）です。

    1646793988
    ParentSnapshotHash

    string

    親バックアップスナップショットのハッシュ値。

    a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****
    InstanceId

    string

    ECS インスタンスの ID。

    i-2ze78zfakirgh1yl****
    PlanId

    string

    バックアッププランの ID。

    plan-000ee8gh2ljelsnb****
    RegionId

    string

    バックアップスナップショットが保存されているリージョンの ID。

    us-east-1
    Uuid

    string

    サーバーの UUID。

    d332af48-1269-4a55-a6db-8543a80f****
    ErrorFile

    string

    バックアップ失敗に関する情報を記録するファイル。部分的に完了したバックアップタスクに関する情報も含まれます。

    s-0008ndhgrflh55i5****.csv
    SnapshotId

    string

    バックアップスナップショットの ID。

    s-0003ahfuqpjdztsg****
    JobId

    string

    バックアップタスクの ID。

    job-000a2q5vg6awgo01****
    Path

    string

    SourceType パラメーターの値が ECS_FILE の場合にのみ返されるパラメーターです。バックアップファイルのパスを示します。

    ["/home"]

    ItemsTotal

    integer

    データソース内のオブジェクトの総数。

    説明

    このパラメーターは、ファイルバックアップの場合のみ利用可能です。

    7
    BytesDone

    integer

    増分バックアップによって生成された実際のデータ量（バイト単位）。

    800
    Paths

    array

    SourceType パラメーターの値が NAS の場合にのみ返されるパラメーターです。バックアップファイルのパスを示します。

    string

    バックアップスナップショットのパス情報。

    /home
    ClientVersion

    string

    ランサムウェア対策エージェントのバージョン。

    2.10.0
    ExpireTime

    integer

    スナップショットの有効期限タイムスタンプ（ミリ秒単位）。

    1799132915000

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****",
  "PageInfo": {
    "CurrentPage": 1,
    "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****",
    "PageSize": 20,
    "TotalCount": 149,
    "Count": 20
  },
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****",
      "ActualItems": 123,
      "VaultId": "v-000ccok3zmw7fbzz****",
      "ActualBytes": 0,
      "SourceType": "ECS_FILE",
      "ClientId": "c-000dbefaw9f7gnbw****",
      "ItemsDone": 6,
      "BytesTotal": 0,
      "Retention": 7,
      "CreatedTime": 1646793988,
      "ParentSnapshotHash": "a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****",
      "InstanceId": "i-2ze78zfakirgh1yl****",
      "PlanId": "plan-000ee8gh2ljelsnb****",
      "RegionId": "us-east-1",
      "Uuid": "d332af48-1269-4a55-a6db-8543a80f****",
      "ErrorFile": "s-0008ndhgrflh55i5****.csv",
      "SnapshotId": "s-0003ahfuqpjdztsg****",
      "JobId": "job-000a2q5vg6awgo01****",
      "Path": "[\"/home\"]\n",
      "ItemsTotal": 7,
      "BytesDone": 800,
      "Paths": [
        "/home"
      ],
      "ClientVersion": "2.10.0",
      "ExpireTime": 1799132915000
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 ServerError ServerError
    403 NoPermission caller has no permission

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

    変更履歴

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