すべてのプロダクト
Search

このプロダクト

    :DescribeLogBackupPolicy

    ドキュメントセンター

    :DescribeLogBackupPolicy

    最終更新日:Dec 11, 2025

    PolarDB クラスターのログバックアップのデータ保持ポリシーを照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeLogBackupPolicy

    get

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    説明

    DescribeDBClusters 操作を呼び出して、クラスター ID を含む、特定のリージョン内のすべてのクラスターに関する情報を照会できます。

    pc-*****************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    LogBackupRetentionPeriod

    integer

    ログバックアップの保持期間。有効な値:

    • 3～7300: ログバックアップは 3～7300 日間保持されます。

    • -1: ログバックアップは永久に保持されます。

    説明

    • 高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedLogPolicies パラメーターを使用してください。

    7
    RequestId

    string

    リクエスト ID。

    62EE0051-102B-488D-9C79-D607B8******
    LogBackupAnotherRegionRetentionPeriod

    string

    リージョン間ログバックアップの保持期間。有効な値:

    • 0: リージョン間ログバックアップ機能は無効になっています。

    • 30～7300: リージョン間ログバックアップは 30～7300 日間保持されます。

    • -1: リージョン間ログバックアップは永久に保持されます。

    説明

      • クラスターを作成するときのデフォルト値は 0 です。この値は、リージョン間ログバックアップ機能が無効になっていることを示します。

      • 高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedLogPolicies パラメーターを使用してください。

    0
    LogBackupAnotherRegionRegion

    string

    リージョン間ログバックアップが保存されるリージョン。リージョン間バックアップをサポートするリージョンの詳細については、「概要」をご参照ください。

    説明

    高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedLogPolicies パラメーターを使用してください。

    cn-beijing
    EnableBackupLog

    integer

    ログバックアップ機能が有効になっているかどうかを示します。有効な値:

    • 0: 機能は無効です。

    • 1: 機能は有効です。デフォルトでは、ログバックアップ機能は有効になっており、無効にすることはできません。

    説明

    高度なバックアップ機能が有効になっている場合、このパラメーターは推奨されません。代わりに AdvancedLogPolicies パラメーターを使用してください。

    1
    AdvancedLogPolicies

    object

    AdvancedLogPolicy

    array<object>

    高度なログバックアップポリシーの詳細。

    説明

    • このパラメーターは、PolarDB for PostgreSQL (Oracle 互換) または PolarDB for PostgreSQL ではサポートされていません。

    object

    PolicyId

    string

    ログバックアップポリシーの ID。

    説明

    このパラメーターは、リージョン間ログバックアップ機能が有効になっているクラスターに対してのみ返されます。

    1c75zkmqczcd1vbf6f6d05***
    LogRetentionType

    string

    ログバックアップの保持タイプ。有効な値:

    • never: ログバックアップは有効期限が切れません。

    • delay: ログバックアップは指定された日数保持されます。

    delay
    LogRetentionValue

    string

    ログバックアップを保持する日数。有効な値:

    • 3～7300: 保持期間 (日数)。

    • -1: ログバックアップは永久に保持されます。

    7
    SrcType

    string

    ログバックアップポリシーのソースタイプ。有効な値:

    • db: データベースクラスター

    • level1: レベル 1 バックアップ

    • level2: レベル 2 バックアップ

    • level2Cross: レベル 2 リージョン間バックアップ

    level1
    DestType

    string

    ログバックアップポリシーの宛先タイプ。有効な値:

    • level1: レベル 1 バックアップ

    • level2: レベル 2 バックアップ

    • level2Cross: レベル 2 リージョン間バックアップ

    level2
    EnableLogBackup

    integer

    ログバックアップ機能が有効になっているかどうかを示します。戻り値は次のとおりです。

    • 1: 有効

    • 0: 無効

    1
    SrcRegion

    string

    ログバックアップポリシーのソースリージョン。

    cn-hangzhou
    DestRegion

    string

    ログバックアップポリシーのターゲットリージョン。

    cn-shanghai

    例

    成功レスポンス

    JSONJSON

    {
  "LogBackupRetentionPeriod": 7,
  "RequestId": "62EE0051-102B-488D-9C79-D607B8******",
  "LogBackupAnotherRegionRetentionPeriod": "0",
  "LogBackupAnotherRegionRegion": "cn-beijing",
  "EnableBackupLog": 1,
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "PolicyId": "1c75zkmqczcd1vbf6f6d05***",
        "LogRetentionType": "delay",
        "LogRetentionValue": "7",
        "SrcType": "level1",
        "DestType": "level2",
        "EnableLogBackup": 1,
        "SrcRegion": "cn-hangzhou",
        "DestRegion": "cn-shanghai"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records.

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

    変更履歴

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