ポリシーにバインドされた 1 つ以上のデータソース、またはデータソースにバインドされた 1 つ以上のポリシーを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
hbr:DescribePolicyBindings |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| NextToken |
string |
任意 |
ポリシーとデータソースの関連付けの次のページを取得するために必須のトークン。 |
caeba0bbb2be03f84eb48b699f0a |
| MaxResults |
integer |
任意 |
各クエリの結果数。 |
10 |
| PolicyId |
string |
任意 |
ポリシー ID。 |
po-000************hky |
| DataSourceIds |
array |
任意 |
データソース ID のリスト。 |
|
|
string |
任意 |
データソース ID。 |
i-uf6************68n |
|
| SourceType |
string |
任意 |
データソースタイプ。有効な値: |
UDM_ECS |
| Filters |
array<object> |
任意 |
クエリフィルター。 |
|
|
object |
任意 |
クエリフィルター。 |
||
| Key |
string |
任意 |
クエリフィルターのキー。有効な値: |
DataSourceType |
| Operator |
string |
任意 |
マッチングメソッド。デフォルト値: IN。フィルター内のキーと値でサポートされるマッチング操作 (Operator)。有効な値: |
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 |
| Source |
string |
|
バックアップ/ |
| Include |
string |
このパラメーターは、SourceType が ECS_FILE または File に設定されている場合にのみ必須です。バックアップ対象のファイルタイプを指定します。これらのタイプのすべてのファイルがバックアップされます。最大 255 文字。 |
[\"*.doc\",\"*.xltm\"] |
| Exclude |
string |
このパラメーターは、SourceType が ECS_FILE または File に設定されている場合にのみ必須です。バックアップから除外するファイルタイプを指定します。これらのタイプのファイルはバックアップされません。最大 255 文字。 |
[\"*.doc\",\"*.xltm\"] |
| SpeedLimit |
string |
このパラメーターは、SourceType が ECS_FILE または File に設定されている場合にのみ必須です。バックアップトラフィックコントロールを指定します。フォーマット: |
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 |
このパラメーターは、AppConsistent が true に設定されている場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットの作成に必要な RAM ロールの名前を指定します。 |
AliyunECSInstanceForHbrRole |
| PreScriptPath |
string |
このパラメーターは、AppConsistent が true に設定されている場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットが作成される前に実行されるフリーズ前スクリプトのパスを指定します。 |
/tmp/prescript.sh |
| PostScriptPath |
string |
このパラメーターは、AppConsistent が true に設定されている場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットが作成された後に実行される解凍後スクリプトのパスを指定します。 |
/tmp/postscript.sh |
| EnableFsFreeze |
boolean |
このパラメーターは、AppConsistent が true に設定されている場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットを作成する前に、Linux オペレーティングシステムの `fsfreeze` コマンドを使用してファイルシステムを読み取り専用状態にするかどうかを示します。デフォルト値は true です。 |
true |
| TimeoutInSeconds |
integer |
このパラメーターは、AppConsistent が true に設定されている場合にのみ必須です。このパラメーターは、I/O フリーズのタイムアウト期間を指定します。デフォルト値は 30 秒です。 |
30 |
| EnableWriters |
boolean |
このパラメーターは、AppConsistent が true に設定されている場合にのみ必須です。アプリケーション整合性スナップショットを作成するかどうかを示します：
デフォルト値：true。 |
true |
| DestinationKmsKeyId |
string |
ターゲットリージョンにあるカスタマーマスターキー (CMK) の ID です。クロスリージョンレプリケーションを有効にし、このパラメーターを指定すると、リージョン間バックアップは指定されたキーを使用して暗号化されます。 |
4ed37b1e-da51-4187-aceb-9db4f9b7148b |
| OssDetail |
object |
OSS バックアップの詳細オプションです。 |
|
| InventoryId |
string |
OSS インベントリの名前です。このパラメーターを指定すると、パフォーマンスの最適化のために OSS インベントリが使用されます。
|
inventory_test |
| InventoryCleanupPolicy |
string |
バックアップ後にインベントリファイルを削除するかどうかを示します。このパラメーターは、OSS インベントリが使用されている場合にのみ有効です。有効な値：
|
DELETE_CURRENT_AND_PREVIOUS |
| IgnoreArchiveObject |
boolean |
バックアップジョブの統計情報と失敗したファイルのリストからアーカイブオブジェクトを除外するかどうかを示します。 |
true |
| FileDetail |
object |
ファイルバックアップの詳細オプションです。 |
|
| UseVSS |
boolean |
ボリュームシャドウコピーサービス (VSS) 機能を有効にするかどうかを示します。この機能は Windows インスタンスでのみ利用可能です。有効な値：
|
false |
| AdvPolicy |
boolean |
詳細ポリシーを使用するかどうかを示します。有効な値：
|
false |
| CommonNasDetail |
object |
オンプレミス NAS の詳細オプションです。 |
|
| FullOnIncrementFail |
boolean |
増分バックアップが失敗した場合に完全バックアップを実行するかどうかを示します。有効な値：
|
true |
| FetchSliceSize |
integer |
バックアップシャードのサイズ (ファイル数) です。 |
100000 |
| ClientId |
string |
バックアップクライアント ID です。 |
c-0001eg6mcvjs93f46s2d |
| ClusterId |
string |
クライアントグループ ID です。 |
cl-000gkcofngi04j6k680a |
| CommonFileSystemDetail |
object |
大規模ファイルシステムバックアップの詳細オプションです。 |
|
| FullOnIncrementFail |
boolean |
増分バックアップが失敗した場合に完全バックアップを実行するかどうかを示します。有効な値：
|
true |
| FetchSliceSize |
integer |
バックアップシャードのサイズ (ファイル数) です。 |
100000 |
| SourceType |
string |
データソースタイプ。有効な値: |
UDM_ECS |
| CrossAccountType |
string |
クロスアカウントバックアップタイプ。有効な値: |
CROSS_ACCOUNT |
| CrossAccountUserId |
integer |
クロスアカウントバックアップのソースアカウントの ID。 |
1480************ |
| CrossAccountRoleName |
string |
クロスアカウントバックアップのためにソースアカウントで作成された RAM ロール名。 |
hbrクロスロール |
| CreatedByTag |
boolean |
リソースがバックアップポリシーのリソースタグを通じて自動的にに関連付けられているかどうかを示します。 |
false |
| HitTags |
array<object> |
一致したタグルール。 |
|
|
object |
|||
| Key |
string |
タグキーです。 |
env |
| Value |
string |
タグ値です。 |
prod |
| Operator |
string |
タグの照合ルールです。
|
EQUAL |
| NextToken |
string |
ポリシーとデータソースのバインディングの次のページを取得するために必須のトークン。 |
caeba0bbb2be03f84eb48b699f0a |
| MaxResults |
integer |
各クエリの結果数。 |
10 |
| TotalCount |
integer |
レコードの総数。 |
38 |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
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"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。