すべてのプロダクト
Search

このプロダクト

    :DescribeHanaRetentionSetting

    ドキュメントセンター

    :DescribeHanaRetentionSetting

    最終更新日:Dec 23, 2025

    SAP HANA データベースのバックアップ保存期間をクエリします。

    操作説明

    • データベースのバックアップパラメーターをクエリする場合は、DescribeHanaBackupSetting 操作を呼び出します。

    • Cloud Backup は、Backint とファイルバックアップに関連する期限切れのカタログとデータを削除します。削除されたカタログとデータは復元できません。ビジネス要件に基づいて保存期間を設定することを推奨します。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    VaultId

    string

    必須

    バックアップボールトの ID。

    v-000ii8t******ntrt2
    ClusterId

    string

    必須

    SAP HANA インスタンスの ID。

    cl-0002ys1i******wwtf
    DatabaseName

    string

    任意

    データベース名。

    C4P

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    280DD872-EE25-52E8-9CB4-491067173DD0
    VaultId

    string

    バックアップボールトの ID。

    v-0006wkn7******zkn
    Schedule

    string

    保存期間を更新するポリシー。フォーマットは I|{startTime}|{interval} です。これは、{startTime} から開始し、{interval} の間隔で保存期間が更新されることを示します。

    • startTime：システムがバックアップジョブの実行を開始する時間。時間は UNIX 時間形式に従います。単位は秒です。

    • interval：システムがバックアップジョブを実行する間隔。間隔は ISO 8601 標準に従います。たとえば、PT1H は 1 時間の間隔を示し、P1D は 1 日の間隔を示します。

    I|0|P1D
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true

    • false

    true
    DatabaseName

    string

    データベース名。

    Q01
    Disabled

    boolean

    バックアップが永続的に保持されるかどうかを示します。有効な値：

    • true：バックアップは永続的に保持されます。

    • false：バックアップは指定された日数保持されます。

    false
    Code

    string

    応答コード。ステータスコード 200 は、リクエストが成功したことを示します。

    200
    RetentionDays

    integer

    バックアップが保持される日数。Disabled パラメーターの値が false の場合、バックアップはこのパラメーターで指定された日数保持されます。

    3650
    Message

    string

    返されるメッセージ。リクエストが成功した場合、「successful」が返されます。リクエストが失敗した場合、エラーメッセージが返されます。

    successful
    ClusterId

    string

    SAP HANA インスタンスの ID。

    cl-0003jyv******fsku5m

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "280DD872-EE25-52E8-9CB4-491067173DD0",
  "VaultId": "v-0006wkn7******zkn",
  "Schedule": "I|0|P1D",
  "Success": true,
  "DatabaseName": "Q01",
  "Disabled": false,
  "Code": "200",
  "RetentionDays": 3650,
  "Message": "successful",
  "ClusterId": "cl-0003jyv******fsku5m"
}

    エラーコード

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

    変更履歴

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