すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeBackupPolicy

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeBackupPolicy

    最終更新日:Jul 27, 2026

    Tair (Redis® OSS-Compatible) データベースインスタンスのバックアップポリシーを照会します。これには、バックアップサイクルとバックアップ時間が含まれます。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    kvstore:DescribeBackupPolicy

    get

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンスの ID。

    r-bp1zxszhcgatnx****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    BackupRetentionPeriod

    string

    バックアップデータの保持日数。

    7
    RequestId

    string

    リクエスト ID。

    90B82DB7-FB28-4CC2-ADBF-1F8659F3****
    PreferredBackupPeriod

    string

    バックアップサイクル。有効な値:

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday。
    PreferredNextBackupTime

    string

    次のバックアップ時間。時間は yyyy-MM-ddTHH:mmZ フォーマット (協定世界時 (UTC)) です。

    2019-03-14T05:28Z
    PreferredBackupTime

    string

    バックアップ時間。時間は HH:mmZ-HH:mmZ フォーマット (協定世界時 (UTC)) です。

    05:00Z-06:00Z
    EnableBackupLog

    integer

    増分バックアップが有効かどうかを示します。有効な値:

    • 1: 有効。

    • 0: 無効。

    1
    BackupLogStartTime

    string

    AccessDeniedDetail

    object

    このパラメーターは非推奨です。このパラメーターは無視してください。

    AuthAction

    string

    上記と同じ。

    -
    AuthPrincipalDisplayName

    string

    上記と同じ。

    -
    AuthPrincipalOwnerId

    string

    上記と同じ。

    -
    AuthPrincipalType

    string

    上記と同じ。

    -
    EncodedDiagnosticMessage

    string

    上記と同じ。

    -
    NoPermissionType

    string

    上記と同じ。

    -
    PolicyType

    string

    上記と同じ。

    -
    DbsInstance

    string

    インスタンスでバックアップサービスが有効かどうかを示します。有効な値:

    • 1: 有効。

    • 0: 無効。

    0

    例

    成功レスポンス

    JSONJSON

    {
  "BackupRetentionPeriod": "7",
  "RequestId": "90B82DB7-FB28-4CC2-ADBF-1F8659F3****",
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "PreferredNextBackupTime": "2019-03-14T05:28Z",
  "PreferredBackupTime": "05:00Z-06:00Z",
  "EnableBackupLog": 1,
  "BackupLogStartTime": "",
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  },
  "DbsInstance": "0"
}

    エラーコード

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

    変更履歴

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