すべてのプロダクト
Search
ドキュメントセンター

:ListSnapshots

最終更新日:Aug 27, 2026

バックアップポイントのリストを照会します。

操作説明

この操作は、保護対象リソース (ProtectedResourceId) に基づいてバックアップポイントのリストを照会します。使用制限:

  • 保護対象リソースが存在している必要があり、SourceType は保護対象リソースのデータソースタイプと一致する必要があります。

  • MaxResults は 1 より大きい値である必要があります。デフォルト値: 10。

  • Skip は負でない整数であり、かつ MaxResults の倍数である必要があります。Skip が 0 より大きい場合、NextToken を同時に指定することはできません。

  • CompleteTimeStart および CompleteTimeEnd は秒単位の UNIX タイムスタンプです。フィルターの有効値は [CompleteTimeStart, CompleteTimeEnd) です。

  • ソートフィールドが指定されていない場合、結果はデフォルトでバックアップ完了時間 (CompleteTime) の降順にソートされます。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

NextToken

string

任意

ページネーショントークン。最初のリクエストではこのパラメーターを指定する必要はありません。後続のページについては、前のリクエストから返された NextToken 値を渡します。NextToken が空の場合、利用可能なページがそれ以上ないことを示します。このパラメーターは Skip と併用できません。

eyJJbmRleCI6NjUwMX0=

MaxResults

integer

任意

ページングクエリで返す結果の最大値。デフォルト値: 10。値は 1 より大きい必要があります。

10

Skip

integer

任意

スキップするエントリ数。値は負でない整数であり、MaxResults の倍数である必要があります。このパラメーターは NextToken と併用できません。

0

SourceType

string

必須

データソースタイプ。値は保護対象リソース (ProtectedResourceId) のデータソースタイプと一致する必要があります。サポートされているデータソースタイプのリストは有効な値に記載されています。

列挙値:

  • NAS :

    Alibaba Cloud NAS バックアップ。

  • COMMON_FILE_SYSTEM :

    CPFS バックアップ。

  • ECS_FILE :

    ECS ファイルバックアップ。

  • COMMON_NAS :

    オンプレミス NAS バックアップ。

  • File :

    オンプレミスファイルバックアップ。

  • OSS :

    OSS バックアップ。

ECS_FILE

ProtectedResourceId

string

必須

保護対象リソースの ID。保護対象リソースが存在し、そのデータソースタイプが SourceType パラメーターと一致している必要があります。

pr-123***7890

VaultId

string

任意

ボールト ID。これはオプションのフィルター条件です。指定した場合、指定されたボールト内のバックアップポイントのみが返されます。

v-00030j3c******sn

CompleteTimeStart

integer

任意

完了開始時間。UNIX タイムスタンプ (秒単位)。完了時間がこの値以上のバックアップポイントのみが返されます。

1776059082

CompleteTimeEnd

integer

任意

完了終了時間。UNIX タイムスタンプ (秒単位)。完了時間がこの値より前のバックアップポイントのみが返されます。

1776059382

PlanId

string

任意

バックアッププラン ID。これはオプションのフィルター条件です。指定した場合、指定されたバックアッププラン配下のバックアップポイントのみが返されます。

po-0000****123

レスポンスフィールド

フィールド

説明

object

応答。

RequestId

string

リクエスト ID。

17189276-****-****-****-0FF51B5A41A0

Code

string

リターンコード。値が 200 の場合は成功を示します。

200

Message

string

リターンメッセージ。リクエストが成功した場合は "successful" という値が返されます。リクエストが失敗した場合はエラーメッセージが返されます。

successful

Success

boolean

リクエストが成功したかどうかを示します。

  • true: リクエストが成功しました。

  • false: リクエストが失敗しました。

true

Snapshots

array<object>

バックアップポイントのリスト。

object

バックアップポイント情報。

Status

string

バックアップポイントのステータス。

列挙値:

  • COMPLETE :

    バックアップ完了。

  • ARCHIVING :

    バックグラウンドでアーカイブ中。

  • PARTIAL_COMPLETE :

    バックアップ一部完了。

COMPLETE

SnapshotHash

string

バックアップポイントのハッシュ値。

f2ac5fd243**********************bc4451777be019

VaultId

string

バックアップデータを保存するボールトの ID。

v-00030j*******sn

ActualItems

integer

実際のノード数。

6

BackupType

string

バックアップタイプ。値は COMPLETE で、完全バックアップを示します。

COMPLETE

CreateTime

integer

バックアップポイントが作成された時間 (秒単位)。

1607436917

ActualBytes

integer

実際に書き込まれたデータ量 (バイト単位)。

600

SourceType

string

データソースタイプ。有効な値:

  • ECS_FILE: ECS ファイルバックアップ

  • File: オンプレミスファイルバックアップ

  • OSS: OSS バックアップ

  • NAS: Alibaba Cloud NAS バックアップ

  • COMMON_NAS: オンプレミス NAS バックアップ

  • CONTAINER: コンテナバックアップ

  • OTS_TABLE: Tablestore バックアップ

  • COMMON_FILE_SYSTEM: CPFS バックアップ

ECS_FILE

ClientId

string

SourceTypeECS_FILE または File に設定されている場合、このパラメーターはバックアップクライアント ID を示します。それ以外の場合は、バックアップデータソースの ID を示します。

c-*********************

BytesTotal

integer

バックアップ対象データの総量 (バイト単位)。

1000

ItemsDone

integer

バックアップ済みのノード数。

8

CompleteTime

integer

バックアップ完了時間。UNIX タイムスタンプ (秒単位)。

1642496679

Retention

integer

バックアップの保持期間 (日単位)。

7

CreatedTime

integer

バックアップが作成された時間。

1642496679

InstanceId

string

バックアップデータソースのインスタンス ID。

i-*********************

ErrorFile

string

バックアップ失敗情報を記録するファイル。一部完了したバックアップに関する情報を含みます。

temp/report/123456789/task-xxxxxxxxx_failed.zip

SnapshotId

string

バックアップポイント ID。

s-00047mxg17p26*****b

JobId

string

バックアップジョブ ID。

job-00030j3chkt******2

Path

string

ソースパス。

/home

ItemsTotal

integer

バックアップ対象ノードの総数。

10

BytesDone

integer

バックアップ済みのデータ量 (バイト単位)。

800

Paths

array

ソースパスのリスト。

string

ソースパス。

/home

InstanceName

string

Tablestore インスタンス名。

instancename

TableName

string

Tablestore インスタンス内のデータテーブルの名前。

table2

RangeStart

integer

Tablestore バックアップジョブ実行の開始時刻。UNIX タイムスタンプ (ミリ秒単位)。

1642492553038

RangeEnd

integer

Tablestore バックアップジョブ実行の終了時刻。UNIX タイムスタンプ (ミリ秒単位)。

1642521709966

ExpireTime

integer

バックアップの有効期限時間。

1771901707

StorageClass

string

ストレージクラス。

列挙値:

  • ARCHIVE :

    アーカイブストレージ。

  • STANDARD :

    標準ストレージ。

STANDARD

ArchiveTime

integer

バックアップがアーカイブされた時間。

1640334062

Include

string

バックアップジョブに含まれるソースパス。

[\"/test/example_cn-huhehaote_3.txt\", \"/test/example_cn-huhehaote_9.txt\", \"/test/example_cn-huhehaote_5.txt\", \"/test/example_cn-huhehaote_1.txt\", \"/test/example_cn-huhehaote_7.txt\"]

Exclude

string

バックアップジョブから除外されるソースパス。

[\"/test/example_cn-hangzhou_7.txt\", \"/test/example_cn-hangzhou_1.txt\", \"/test/example_cn-hangzhou_3.txt\", \"/test/example_cn-hangzhou_9.txt\", \"/test/example_cn-hangzhou_6.txt\"]

ProtectedDataSize

integer

保護対象ソースデータサイズ (バイト単位)。SourceType が ECS_FILE に設定されている場合、これは保護対象クラウドディスク容量を示します。

42949672960

PlanId

string

バックアッププラン ID。

po-123***7890

TotalCount

integer

レコードの総数。

3

MaxResults

integer

返される結果の最大値。

10

NextToken

string

次のページのトークン。NextToken が空の場合、利用可能なページがそれ以上ないことを示します。

aWQj********MCMy

成功レスポンス

JSONJSON

{
  "RequestId": "17189276-****-****-****-0FF51B5A41A0",
  "Code": "200",
  "Message": "successful",
  "Success": true,
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "f2ac5fd243**********************bc4451777be019",
      "VaultId": "v-00030j*******sn",
      "ActualItems": 6,
      "BackupType": "COMPLETE",
      "CreateTime": 1607436917,
      "ActualBytes": 600,
      "SourceType": "ECS_FILE",
      "ClientId": "c-*********************",
      "BytesTotal": 1000,
      "ItemsDone": 8,
      "CompleteTime": 1642496679,
      "Retention": 7,
      "CreatedTime": 1642496679,
      "InstanceId": "i-*********************",
      "ErrorFile": "temp/report/123456789/task-xxxxxxxxx_失敗した.zip",
      "SnapshotId": "s-00047mxg17p26*****b",
      "JobId": "job-00030j3chkt******2",
      "Path": "/home",
      "ItemsTotal": 10,
      "BytesDone": 800,
      "Paths": [
        "/home"
      ],
      "InstanceName": "インスタンス名",
      "TableName": "table2",
      "RangeStart": 1642492553038,
      "RangeEnd": 1642521709966,
      "ExpireTime": 1771901707,
      "StorageClass": "STANDARD",
      "ArchiveTime": 1640334062,
      "Include": "[\\\"/test/example_cn-huhehaote_3.txt\\\", \\\"/test/example_cn-huhehaote_9.txt\\\", \\\"/test/example_cn-huhehaote_5.txt\\\", \\\"/test/example_cn-huhehaote_1.txt\\\", \\\"/test/example_cn-huhehaote_7.txt\\\"]",
      "Exclude": "[\\\"/test/example_cn-hangzhou_7.txt\\\", \\\"/test/example_cn-hangzhou_1.txt\\\", \\\"/test/example_cn-hangzhou_3.txt\\\", \\\"/test/example_cn-hangzhou_9.txt\\\", \\\"/test/example_cn-hangzhou_6.txt\\\"]",
      "ProtectedDataSize": 42949672960,
      "PlanId": "po-123***7890"
    }
  ],
  "TotalCount": 3,
  "MaxResults": 10,
  "NextToken": "aWQj********MCMy"
}

エラーコード

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

変更履歴

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