VaultId と ClusterId で SAP HANA バックアッププランをフィルタリング - Cloud Backup

指定された条件に一致する 1 つ以上の SAP HANA バックアッププランを照会します。

今すぐお試しください

この 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:DescribeHanaBackupPlans

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
VaultId	string	任意	バックアップボールトの ID。	v-000i4lg4kz******ahl
ClusterId	string	必須	SAP HANA インスタンスの ID。	cl-000chxz******lz7bk
PageNumber	integer	任意	ページ番号。値は 1 から始まる数値である必要があります。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値: 1～99。デフォルト値: 10。	10
DatabaseName	string	任意	データベースの名前。	SYSTEMDB
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmvywqfey5njq

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9
Success	boolean	リクエストが成功したかどうかを示します。 true: リクエストは成功しました。 false: リクエストは失敗しました。	true
Code	string	リターンコード。値 200 は、リクエストが成功したことを示します。	200
Message	string	返されるメッセージ。リクエストが成功した場合、「successful」が返されます。リクエストが失敗した場合、エラーメッセージが返されます。	successful
PageNumber	integer	ページ番号。値は 1 から始まる数値である必要があります。デフォルト値: 1。	1
PageSize	integer	1 ページあたりのエントリ数。有効な値: 1～99。デフォルト値: 10。	10
TotalCount	integer	レコードの総数。	6
HanaBackupPlans	object
HanaBackupPlan	array<object>	バックアッププランの詳細。
	object	バックアッププランの詳細。
VaultId	string	バックアップボールトの ID。	v-000csihw82pqkd7hcjws
BackupPrefix	string	バックアッププレフィックス。	COMPLETE_DATA_BACKUP
Schedule	string	バックアップポリシー。フォーマット: `I\|{startTime}\|{interval}`。システムは `{startTime}` で指定された時点で最初のバックアップジョブを実行し、`{interval}` で指定された間隔でバックアップジョブを繰り返します。システムは、失敗したバックアップジョブを補うためのバックアップジョブを実行しません。バックアップジョブが完了していない場合、次のバックアップジョブはトリガーされません。たとえば、`I\|1631685600\|P1D` は、システムが 2021-09-15 14:00:00 から毎日バックアップジョブを実行することを示します。 startTime: バックアップジョブの開始時刻。この値は UNIX タイムスタンプです。単位: 秒。 interval: バックアップジョブの間隔。この値は ISO 8601 標準に準拠しています。たとえば、PT1H はバックアップジョブが 1 時間ごとに実行されることを示します。P1D は、バックアップジョブが毎日実行されることを示します。	I\|1602673264\|P1D
DatabaseName	string	データベースの名前。	SYSTEMDB
BackupType	string	バックアップタイプ。 COMPLETE: 完全バックアップ。 INCREMENTAL: 増分バックアップ。 DIFFERENTIAL: 差分バックアップ。	COMPLETE
Disabled	boolean	バックアッププランが一時停止されているかどうかを示します。 true: バックアッププランは一時停止されています。 false: バックアッププランは一時停止されていません。	false
PlanId	string	バックアッププランの ID。	pl-0000tnyndg3ne5m4ubeu
ClusterId	string	SAP HANA インスタンスの ID。	cl-0002scknka*****
PlanName	string	バックアッププランの名前。	plan-20220118-141153
BusinessStatus	string	ビジネスステータス。	ACTIVE

例

成功レスポンス

JSONJSON

{
  "RequestId": "F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 6,
  "HanaBackupPlans": {
    "HanaBackupPlan": [
      {
        "VaultId": "v-000csihw82pqkd7hcjws",
        "BackupPrefix": "COMPLETE_DATA_BACKUP",
        "Schedule": "I|1602673264|P1D",
        "DatabaseName": "SYSTEMDB",
        "BackupType": "COMPLETE",
        "Disabled": false,
        "PlanId": "pl-0000tnyndg3ne5m4ubeu",
        "ClusterId": "cl-0002scknka*****",
        "PlanName": "plan-20220118-141153",
        "BusinessStatus": "ACTIVE"
      }
    ]
  }
}

エラーコード

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

変更履歴

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