すべてのプロダクト
Search
ドキュメントセンター

:DescribePolicyBindings

最終更新日:Mar 18, 2026

ポリシーにアタッチされているデータソース、またはデータソースにアタッチされているポリシーを照会できます。

今すぐお試しください

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

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

NextToken

string

任意

次のページの結果を取得するために使用されるトークンです。

caeba0bbb2be03f84eb48b699f0a

MaxResults

integer

任意

各クエリで返される結果の数です。

有効値:10~100。デフォルト値:10。

10

PolicyId

string

任意

ポリシー ID です。

po-000************hky

DataSourceIds

array

任意

データソース ID のリストです。

string

任意

データソース ID です。

i-uf6************68n

SourceType

string

任意

データソースのタイプです。有効な値:

  • UDM_ECS:ECS インスタンスのバックアップ。

UDM_ECS

Filters

array<object>

任意

クエリフィルターです。

object

任意

クエリフィルターです。

Key

string

任意

フィルターのキーです。有効な値:

  • PolicyId:バックアップポリシー ID

  • DataSourceId:ECS インスタンス ID

  • DataSourceType:データソースタイプ

DataSourceType

Operator

string

任意

照合方法です。デフォルト値は IN です。このパラメーターは、キーと値の照合に使用する演算子を指定します。有効な値:

  • EQUAL:等しい

  • NOT_EQUAL:等しくない

  • GREATER_THAN:より大きい

  • GREATER_THAN_OR_EQUAL:以上

  • LESS_THAN:より小さい

  • LESS_THAN_OR_EQUAL:以下

  • BETWEEN:間。値は [lower_bound,upper_bound] の形式の JSON 配列です。

  • IN:セット内。値は配列です。

IN

Values

array

任意

フィルターで照合する値です。

string

任意

フィルターで照合する値です。

UDM_ECS

レスポンスフィールド

フィールド

説明

object

DescribePolicyBindingsResponse

PolicyBindings

array<object>

ポリシーバインディングのリストです。

array<object>

ポリシーバインディングの詳細です。

CreatedTime

integer

ポリシーバインディングが作成された時刻です。この値は UNIX タイムスタンプです。単位:秒。

1661399570

UpdatedTime

integer

ポリシーバインディングが最後に更新された時刻です。この値は UNIX タイムスタンプです。単位:秒。

1653611573

PolicyBindingId

string

ポリシーバインディングの ID です。

pd-000************slc

PolicyBindingDescription

string

ポリシーバインディングの説明です。

po-000************eslc-i-uf6************y5g

PolicyId

string

ポリシー ID です。

po-000************56y

DataSourceId

string

データソース ID です。

i-8vb************5ly

Disabled

boolean

データソースに対してポリシーが一時停止されているかどうかを示します。

  • true:ポリシーは一時停止されています。

  • false:ポリシーは一時停止されていません。

true

Source

string

  • SourceType が OSS に設定されている場合、このパラメーターはバックアップするオブジェクトのプレフィックスを指定します。このパラメーターを指定しない場合、バケット全体がバックアップされます。

  • SourceType が ECS_FILE または File に設定されている場合、このパラメーターはバックアップするファイルのパスを指定します。このパラメーターを指定しない場合、すべてのディレクトリがバックアップされます。

backup/

Include

string

このパラメーターは、SourceTypeECS_FILE または File に設定されている場合にのみ必須です。このパラメーターは、バックアップするファイルタイプを指定します。指定されたタイプのすべてのファイルがバックアップされます。このパラメーターは最大 255 文字をサポートします。

[\"*.doc\",\"*.xltm\"]

Exclude

string

このパラメーターは、SourceTypeECS_FILE または File に設定されている場合にのみ必須です。このパラメーターは、バックアップから除外するファイルタイプを指定します。指定されたタイプのすべてのファイルはバックアップされません。このパラメーターは最大 255 文字をサポートします。

[\"*.doc\",\"*.xltm\"]

SpeedLimit

string

このパラメーターは、SourceTypeECS_FILE または File に設定されている場合にのみ必須です。このパラメーターは、バックアップのトラフィックシェーピング設定を指定します。フォーマットは {start}:{end}:{bandwidth} です。複数の設定を指定できます。コンマ (,) で区切ります。時間帯は重複できません。

  • start:開始時間。

  • end:終了時間。

  • bandwidth:帯域幅制限。単位:KB/s。

0:24:10240

AdvancedOptions

object

詳細オプションです。

UdmDetail

object

ECS インスタンスのバックアップに関する詳細オプションです。

ExcludeDiskIdList

array

バックアップから除外するディスク ID のリストです。`DiskIdList` が空でない場合、このパラメーターは無視されます。

string

バックアップから除外するディスクの ID です。

d-bp1************apo

DiskIdList

array

バックアップするディスク ID のリストです。すべてのディスクをバックアップする場合は、このパラメーターを空のままにします。

string

バックアップするディスクの ID です。

d-bp1************apo

SnapshotGroup

boolean

スナップショット整合性グループを作成するかどうかを示します。スナップショット整合性グループは、インスタンスのすべてのディスクが ESSD (Enhanced SSD) である場合にのみ作成できます。

true

AppConsistent

boolean

アプリケーション整合性スナップショットを作成するかどうかを示します。アプリケーション整合性スナップショットは、インスタンスのすべてのディスクが ESSD である場合にのみ作成できます。

false

RamRoleName

string

このパラメーターは、AppConsistenttrue に設定されている場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットの作成に必要な RAM ロールの名前を指定します。

AliyunECSInstanceForHbrRole

PreScriptPath

string

このパラメーターは、AppConsistenttrue に設定されている場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットが作成される前に実行されるフリーズ前スクリプトのパスを指定します。

/tmp/prescript.sh

PostScriptPath

string

このパラメーターは、AppConsistenttrue に設定されている場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットが作成された後に実行される解凍後スクリプトのパスを指定します。

/tmp/postscript.sh

EnableFsFreeze

boolean

このパラメーターは、AppConsistenttrue に設定されている場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットを作成する前に、Linux オペレーティングシステムの `fsfreeze` コマンドを使用してファイルシステムを読み取り専用状態にするかどうかを示します。デフォルト値は true です。

true

TimeoutInSeconds

integer

このパラメーターは、AppConsistenttrue に設定されている場合にのみ必須です。このパラメーターは、I/O フリーズのタイムアウト期間を指定します。デフォルト値は 30 秒です。

30

EnableWriters

boolean

このパラメーターは、AppConsistenttrue に設定されている場合にのみ必須です。アプリケーション整合性スナップショットを作成するかどうかを示します:

  • true:アプリケーション整合性スナップショットを作成します。

  • false:ファイルシステム整合性スナップショットを作成します。

デフォルト値:true。

true

DestinationKmsKeyId

string

ターゲットリージョンにあるカスタマーマスターキー (CMK) の ID です。クロスリージョンレプリケーションを有効にし、このパラメーターを指定すると、リージョン間バックアップは指定されたキーを使用して暗号化されます。

4ed37b1e-da51-4187-aceb-9db4f9b7148b

OssDetail

object

OSS バックアップの詳細オプションです。

InventoryId

string

OSS インベントリの名前です。このパラメーターを指定すると、パフォーマンスの最適化のために OSS インベントリが使用されます。

  • インベントリファイルのストレージ料金は OSS によって課金されます。

  • OSS インベントリファイルの生成には時間がかかります。インベントリファイルが生成される前にバックアップジョブが失敗する場合があります。次のバックアップサイクルが実行されるのを待つことができます。

inventory_test

InventoryCleanupPolicy

string

バックアップ後にインベントリファイルを削除するかどうかを示します。このパラメーターは、OSS インベントリが使用されている場合にのみ有効です。有効な値:

  • NO_CLEANUP:インベントリファイルは削除されません。

  • DELETE_CURRENT:現在のインベントリファイルが削除されます。

  • DELETE_CURRENT_AND_PREVIOUS:すべてのインベントリファイルが削除されます。

DELETE_CURRENT_AND_PREVIOUS

IgnoreArchiveObject

boolean

バックアップジョブの統計情報と失敗したファイルのリストからアーカイブオブジェクトを除外するかどうかを示します。

true

FileDetail

object

ファイルバックアップの詳細オプションです。

UseVSS

boolean

ボリュームシャドウコピーサービス (VSS) 機能を有効にするかどうかを示します。この機能は Windows インスタンスでのみ利用可能です。有効な値:

  • true:VSS 機能を有効にします。

  • false:VSS 機能を無効にします。

false

AdvPolicy

boolean

詳細ポリシーを使用するかどうかを示します。有効な値:

  • true:詳細ポリシーを使用します。

  • false:詳細ポリシーを使用しません。

false

CommonNasDetail

object

オンプレミス NAS の詳細オプションです。

FullOnIncrementFail

boolean

増分バックアップが失敗した場合に完全バックアップを実行するかどうかを示します。有効な値:

  • true:完全バックアップを実行します。

  • false:完全バックアップを実行しません。

true

FetchSliceSize

integer

バックアップシャードのサイズ (ファイル数) です。

100000

ClientId

string

バックアップクライアント ID です。

c-0001eg6mcvjs93f46s2d

ClusterId

string

クライアントグループ ID です。

cl-000gkcofngi04j6k680a

CommonFileSystemDetail

object

大規模ファイルシステムバックアップの詳細オプションです。

FullOnIncrementFail

boolean

増分バックアップが失敗した場合に完全バックアップを実行するかどうかを示します。有効な値:

  • true:完全バックアップを実行します。

  • false:完全バックアップを実行しません。

true

FetchSliceSize

integer

バックアップシャードのサイズ (ファイル数) です。

100000

SourceType

string

データソースのタイプです。有効な値:

  • UDM_ECS:ECS インスタンスのバックアップ

UDM_ECS

CrossAccountType

string

クロスアカウントバックアップのタイプです。有効な値:

  • SELF_ACCOUNT:同じアカウント内でデータをバックアップします。

  • CROSS_ACCOUNT:アカウント間でデータをバックアップします。

CROSS_ACCOUNT

CrossAccountUserId

integer

クロスアカウントバックアップのソースアカウントの ID です。

1480************

CrossAccountRoleName

string

クロスアカウントバックアップのためにソースアカウントで作成された RAM ロールの名前です。

hbrcrossrole

CreatedByTag

boolean

データソースがタグに基づいてバックアップポリシーに自動的にバインドされるかどうかを示します。

false

HitTags

array<object>

一致したタグのルールです。

object

Key

string

タグキーです。

env

Value

string

タグ値です。

prod

Operator

string

タグの照合ルールです。

  • EQUAL:タグキーとタグ値が一致します。

  • NOT:タグキーは一致しますが、タグ値は一致しません。

EQUAL

NextToken

string

ポリシーバインディングの次のページを取得するために使用されるトークンです。

caeba0bbb2be03f84eb48b699f0a

MaxResults

integer

各クエリで返される結果の数です。

有効値:10~100。デフォルト値:10。

10

TotalCount

integer

レコードの総数です。

38

Success

boolean

リクエストが成功したかどうかを示します。

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

Code

string

リターンコードです。値が 200 の場合は、リクエストが成功したことを示します。

200

Message

string

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

successful

RequestId

string

リクエスト ID です。

5225929A-4EBD-55EE-9FE1-4A130E582A76

成功レスポンス

JSONJSON

{
  "PolicyBindings": [
    {
      "CreatedTime": 1661399570,
      "UpdatedTime": 1653611573,
      "PolicyBindingId": "pd-000************slc",
      "PolicyBindingDescription": "po-000************eslc-i-uf6************y5g",
      "PolicyId": "po-000************56y",
      "DataSourceId": "i-8vb************5ly",
      "Disabled": true,
      "Source": "backup/",
      "Include": "[\\\"*.doc\\\",\\\"*.xltm\\\"]",
      "Exclude": "[\\\"*.doc\\\",\\\"*.xltm\\\"]",
      "SpeedLimit": "0:24:10240",
      "AdvancedOptions": {
        "UdmDetail": {
          "ExcludeDiskIdList": [
            "d-bp1************apo\n"
          ],
          "DiskIdList": [
            "d-bp1************apo\n"
          ],
          "SnapshotGroup": true,
          "AppConsistent": false,
          "RamRoleName": "AliyunECSInstanceForHbrRole",
          "PreScriptPath": "/tmp/prescript.sh",
          "PostScriptPath": "/tmp/postscript.sh",
          "EnableFsFreeze": true,
          "TimeoutInSeconds": 30,
          "EnableWriters": true,
          "DestinationKmsKeyId": "4ed37b1e-da51-4187-aceb-9db4f9b7148b"
        },
        "OssDetail": {
          "InventoryId": "inventory_test",
          "InventoryCleanupPolicy": "DELETE_CURRENT_AND_PREVIOUS",
          "IgnoreArchiveObject": true
        },
        "FileDetail": {
          "UseVSS": false,
          "AdvPolicy": false
        },
        "CommonNasDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000,
          "ClientId": "c-0001eg6mcvjs93f46s2d",
          "ClusterId": "cl-000gkcofngi04j6k680a"
        },
        "CommonFileSystemDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000
        }
      },
      "SourceType": "UDM_ECS",
      "CrossAccountType": "CROSS_ACCOUNT",
      "CrossAccountUserId": 0,
      "CrossAccountRoleName": "hbrcrossrole",
      "CreatedByTag": false,
      "HitTags": [
        {
          "Key": "env",
          "Value": "prod",
          "Operator": "EQUAL"
        }
      ]
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 38,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "5225929A-4EBD-55EE-9FE1-4A130E582A76"
}

エラーコード

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

変更履歴

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