Tablestore バックアップスナップショット API 概要 - Cloud Backup

バックアップされた Tablestore インスタンスの詳細を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hbr:DescribeOtsTableSnapshots

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StartTime	integer	任意	バックアップの開始時刻。値は UNIX タイムスタンプである必要があります。単位：ミリ秒。	1611109271630
EndTime	integer	任意	バックアップの終了時刻。値は UNIX タイムスタンプである必要があります。単位：ミリ秒。	1652068250881
SnapshotIds	array	任意	スナップショット ID。
	string	任意	スナップショット ID。	s-00047mxg17p26****3c
OtsInstances	array<object>	任意	バックアップされた Tablestore インスタンス。
	object	任意	バックアップされた Tablestore インスタンスのリスト。
InstanceName	string	任意	Tablestore インスタンスの名前。	instancename
TableNames	array	任意	Tablestore インスタンス内のテーブルの名前。
	string	任意	Tablestore インスタンス内のテーブルの名前。	tablename
Limit	integer	任意	現在のクエリで返す行の最大数。	100
NextToken	string	任意	バックアップスナップショットの次のページを取得するために必要なトークン。	caeba0bbb2be03f84eb48b699f0a****
CrossAccountType	string	任意	データが同じ Alibaba Cloud アカウント内でバックアップされるか、Alibaba Cloud アカウント間でバックアップされるかを指定します。有効な値： SELF_ACCOUNT：データは同じ Alibaba Cloud アカウント内でバックアップされます。 CROSS_ACCOUNT：データは Alibaba Cloud アカウント間でバックアップされます。	CROSS_ACCOUNT
CrossAccountUserId	integer	任意	クロスアカウントバックアップに使用されるソースアカウントの UID。	144015xxxxx98732
CrossAccountRoleName	string	任意	ソースの Alibaba Cloud アカウントで作成され、現在の Alibaba Cloud アカウントに割り当てられる RAM ロールの名前。このロールは、現在の Alibaba Cloud アカウントによるクロスアカウントのデータバックアップを承認します。	BackupRole

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	09376812-6290-5E36-B504-E8010D72D1F0
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true false	true
Code	string	HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。	200
Message	string	返されたメッセージ。リクエストが成功した場合、「successful」が返されます。リクエストが失敗した場合、エラーメッセージが返されます。	successful
Limit	integer	現在のページに表示されるバックアップスナップショットの数。	10
Snapshots	array<object>	バックアップスナップショット。
	object	バックアップスナップショットのリスト。
Status	string	バックアップジョブのステータス。有効な値： COMPLETE：バックアップジョブは完了しました。 PARTIAL_COMPLETE：バックアップジョブは部分的に完了しました。 FAILED：バックアップジョブは失敗しました。	COMPLETE
SnapshotHash	string	バックアップスナップショットのハッシュ値。	f2fe...
VaultId	string	バックアップスナップショットを格納するバックアップボールトの ID。	v-00030j*******sn
BackupType	string	バックアップタイプ。有効な値：COMPLETE。完全バックアップを示します。	COMPLETE
CreateTime	integer	Tablestore インスタンスが作成された時刻。値は UNIX タイムスタンプです。単位：秒。	1607436917
ActualBytes	string	重複排除後のバックアップスナップショットの実際のデータ量。単位：バイト。	0
SourceType	string	データソースのタイプ。有効な値： ECS_FILE：Elastic Compute Service (ECS) ファイルのバックアップスナップショット OSS：Object Storage Service (OSS) バケットのバックアップスナップショット NAS：Apsara File Storage NAS ファイルシステムのバックアップスナップショット OTS_TABLE：Tablestore インスタンスのバックアップスナップショット	OTS_TABLE
BytesTotal	integer	データの総量。単位：バイト。	0
CompleteTime	integer	バックアップスナップショットが完了した時刻。値は UNIX タイムスタンプです。単位：秒。	1642496679
Retention	integer	バックアップスナップショットの保存期間。単位：日。	730
CreatedTime	integer	バックアップスナップショットが作成された時刻。値は UNIX タイムスタンプです。単位：秒。	1642496679
ParentSnapshotHash	string	親バックアップスナップショットのハッシュ値。	f2fe..
StartTime	integer	バックアップスナップショットが開始された時刻。値は UNIX タイムスタンプです。単位：秒。	1642496543
UpdatedTime	integer	バックアップスナップショットが更新された時刻。値は UNIX タイムスタンプです。単位：秒。	1642496679
SnapshotId	string	バックアップスナップショットの ID。	s-00047mxg17p26*****b
JobId	string	バックアップジョブの ID。	job-00030j3chkt******2
InstanceName	string	Tablestore インスタンスの名前。	instancename
TableName	string	Tablestore インスタンス内のテーブルの名前。	table2
RangeStart	integer	バックアップジョブが開始された時刻。値は UNIX タイムスタンプです。単位：ミリ秒。	1642492553038
RangeEnd	integer	バックアップジョブが終了した時刻。値は UNIX タイムスタンプです。単位：ミリ秒。	1642521709966
NextToken	string	バックアップスナップショットの次のページを取得するために必要なトークン。	caeba0bbb2be03f84eb48b699f0a

例

成功レスポンス

JSONJSON

{
  "RequestId": "09376812-6290-5E36-B504-E8010D72D1F0",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "Limit": 10,
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "f2fe...",
      "VaultId": "v-00030j*******sn",
      "BackupType": "COMPLETE",
      "CreateTime": 1607436917,
      "ActualBytes": "0",
      "SourceType": "OTS_TABLE",
      "BytesTotal": 0,
      "CompleteTime": 1642496679,
      "Retention": 730,
      "CreatedTime": 1642496679,
      "ParentSnapshotHash": "f2fe..",
      "StartTime": 1642496543,
      "UpdatedTime": 1642496679,
      "SnapshotId": "s-00047mxg17p26*****b",
      "JobId": "job-00030j3chkt******2",
      "InstanceName": "instancename",
      "TableName": "table2",
      "RangeStart": 1642492553038,
      "RangeEnd": 1642521709966
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a"
}

エラーコード

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

変更履歴

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