DescribePoliciesV2 API リファレンス（バックアップポリシー取得）- Cloud Backup - Alibaba Cloud -

1 つ以上のポリシーを照会します。

今すぐお試しください

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

list

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	string	任意	次のページのポリシーを取得するために必須のトークン。	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	任意	クエリあたりの結果数。有効な値: 10～100。デフォルト値: 10。	10
PolicyId	string	任意	ポリシーの ID。	po-000************2l6

レスポンスフィールド

フィールド	型	説明	例
	object	DescribePoliciesResponse。
Policies	array<object>	ポリシーのリスト。
	array<object>	ポリシーの詳細。
CreatedTime	integer	作成時刻。UNIX タイムスタンプ (秒単位)。	1650248136
UpdatedTime	integer	更新時刻。UNIX タイムスタンプ (秒単位)。	1662080404
PolicyId	string	ポリシーの ID。	po-000************bkz
PolicyName	string	ポリシー名。	毎日バックアップ + 地理冗長バックアップ
PolicyDescription	string	ポリシーの説明。	毎日午前 10:00 にバックアップし、上海にレプリケーション
Rules	array<object>	ポリシールールのリスト。
	array<object>	ポリシールールの詳細。
RuleId	string	ルールの ID。	ルール-000************f1e
RuleType	string	ルールのタイプ。各ポリシーには、少なくとも 1 つの BACKUP ルールと、正確に 1 つの TRANSITION ルールが必要です。有効な値: BACKUP: バックアップルール。 TRANSITION: ライフサイクルルール。 REPLICATION: レプリケーションルール。	BACKUP
Schedule	string	このパラメーターは、RuleType が BACKUP に設定されている場合にのみ必須です。バックアップスケジュール。オプションのフォーマット: `I\|{startTime}\|{interval}`。これは、{startTime} から {interval} ごとにバックアップジョブが実行されることを示します。過去の期間のバックアップジョブは補償されません。前のバックアップジョブが完了していない場合、次のバックアップジョブはトリガーされません。たとえば、`I\|1631685600\|P1D` は、2021-09-15 14:00:00 から 1 日に 1 回バックアップが実行されることを示します。 startTime: バックアップの開始時刻。UNIX タイムスタンプ (秒単位)。 interval: ISO 8601 時間間隔。たとえば、PT1H は 1 時間の間隔を示し、P1D は 1 日の間隔を示します。	I\|1648647166\|P1D
BackupType	string	このパラメーターは、RuleType が BACKUP に設定されている場合にのみ必須です。バックアップタイプ。値は COMPLETE で、完全バックアップを示します。	COMPLETE
VaultId	string	このパラメーターは、RuleType が BACKUP に設定されている場合にのみ必須です。バックアップボールトの ID。	v-000**************kgm
ReplicationRegionId	string	このパラメーターは、RuleType が REPLICATION に設定されている場合にのみ必須です。レプリケーションのターゲットリージョン ID。	cn-shanghai
Retention	integer	このパラメーターは、RuleType が TRANSITION または REPLICATION に設定されている場合にのみ必須です。 RuleType が TRANSITION に設定されている場合: バックアップの保持期間。最小値: 1。単位: 日。 RuleType が REPLICATION に設定されている場合: ジオレダンシーバックアップの保持期間。最小値: 1。単位: 日。	7
RetentionRules	array<object>	このパラメーターは、RuleType が TRANSITION に設定されている場合にのみ必須です。特別な保持ルールのリスト。
	object	特別な保持ルール。
AdvancedRetentionType	string	特別な保持ルールのタイプ。有効な値: WEEKLY: 週次バックアップ。 MONTHLY: 月次バックアップ。 YEARLY: 年次バックアップ。	YEARLY
WhichSnapshot	integer	ルールが適用されるバックアップ。現在、最初のバックアップのみがサポートされています。値は 1 です。	1
Retention	integer	バックアップの特別な保持期間。最小値: 1。単位: 日。	730
ArchiveDays	integer	このパラメーターは、RuleType が TRANSITION に設定されている場合にのみ必須です。バックアップがアーカイブストレージに変換されるまでの日数。単位: 日。	30
KeepLatestSnapshots	integer	少なくとも 1 つのバックアップバージョンを保持するかどうかを指定します。有効な値: 0: 無効。 1: 有効。	1
DataSourceFilters	array<object>	このパラメーターは、RuleType が TAG に設定されている場合にのみ必須です。データソースフィルタールール。
	object
SourceType	string	データソースのタイプ。有効な値: UDM_ECS: ECS インスタンスバックアップ。 OSS: OSS バックアップ。 NAS: Alibaba Cloud NAS バックアップ。 ECS_FILE: ECS ファイルバックアップ。 OTS: Tablestore バックアップ。	UDM_ECS
DataSourceIds `deprecated`	array	非推奨。	Deprecated
`deprecated`	string	非推奨。	Deprecated
TagFilters	array<object>	このパラメーターは、RuleType が TAG に設定されている場合にのみ必須です。リソースタグフィルタールール。
	object
Key	string	タグキー。	env
Value	string	タグ値。空の値は任意の値を示します。	prod
Operator	string	タグマッチングルール。有効な値: EQUAL: タグキーとタグ値の両方に一致します。 NOT: タグキーには一致しますが、タグ値には一致しません。	EQUAL
Immutable	boolean	このパラメーターは、PolicyType が UDM_ECS_ONLY に設定されている場合にのみ有効です。バックアップロックを有効にするかどうかを指定します。	true
PolicyBindingCount	integer	ポリシーにバインドされているデータソースの数。	5
PolicyType	string	ポリシーのタイプ。有効な値: STANDARD: 一般的なバックアップポリシー。ECS インスタンスバックアップ以外のデータソースのバックアップをサポートします。 UDM_ECS_ONLY: ECS インスタンスバックアップポリシー。ECS インスタンスのバックアップのみをサポートします。	STANDARD
BusinessStatus	string	ユーザーのビジネスステータス。	ACTIVE
NextToken	string	次のページのポリシーを取得するために必須のトークン。	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	クエリあたりの結果数。有効な値: 10～100。デフォルト値: 10。	10
TotalCount	integer	レコードの総数。	12
Success	boolean	リクエストが成功したかどうかを示します。有効な値: true: 成功。 false: 失敗。	true
Code	string	応答コード。200 は成功を示します。	200
Message	string	返されるメッセージ。リクエストが成功した場合、値 "successful" が返されます。リクエストが失敗した場合、エラーメッセージが返されます。	successful
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "Policies": [
    {
      "CreatedTime": 1650248136,
      "UpdatedTime": 1662080404,
      "PolicyId": "po-000************bkz",
      "PolicyName": "毎日バックアップ + オフサイトバックアップ",
      "PolicyDescription": "データは毎日 10:00:00 にバックアップされ、中国 (上海) リージョンにレプリケートされます。",
      "Rules": [
        {
          "RuleId": "ルール-000************f1e",
          "RuleType": "BACKUP",
          "Schedule": "I|1648647166|P1D",
          "BackupType": "COMPLETE",
          "VaultId": "v-000**************kgm",
          "ReplicationRegionId": "cn-shanghai",
          "Retention": 7,
          "RetentionRules": [
            {
              "AdvancedRetentionType": "YEARLY",
              "WhichSnapshot": 1,
              "Retention": 730
            }
          ],
          "ArchiveDays": 30,
          "KeepLatestSnapshots": 1,
          "DataSourceFilters": [
            {
              "SourceType": "UDM_ECS",
              "DataSourceIds": [
                "Deprecated"
              ]
            }
          ],
          "TagFilters": [
            {
              "Key": "env",
              "Value": "prod",
              "Operator": "EQUAL"
            }
          ],
          "Immutable": true
        }
      ],
      "PolicyBindingCount": 5,
      "PolicyType": "STANDARD",
      "BusinessStatus": "ACTIVE"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 12,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

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

変更履歴

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