ListProtectionPolicies - Backup and Disaster Recovery Center - Alibaba Cloud ドキュメントセンター

保護ポリシーのリストを取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

bdrc:ListProtectionPolicies

list

*All Resource

*

なし

リクエスト構文

GET /api/v1/protection-policies HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProtectionPolicyRegionId	string	任意	保護ポリシーのリージョン ID。	cn-hangzhou
MaxResults	integer	任意	返される結果の最大値。	10
NextToken	string	任意	ページネーショントークン。	cae**********699
ProtectionPolicyId	string	任意	保護ポリシー ID。	p-123***7890

レスポンスフィールド

フィールド	型	説明	例
	object	The response struct.
RequestId	string	The request ID.	5B2F09BF-CEBD-5A7E-AC01-E7F86169A5E5
Data	object	The data returned.
Content	array<object>	The response parameters.
	array<object>	The collection of records returned by this request.
ProtectionPolicyRegionId	string		cn-hangzhou
ProtectionPolicyId	string		p-123***7890
ProtectionPolicyName	string		MyProtectionPolicy
BoundResourceCategoryIds	array
	string		rc-123***7890
SubProtectionPolicies	array<object>
	object
SubProtectionPolicyType	string		ECS_AUTO_SNAPSHOT_POLICY
Config	string		{\"autoSnapshotPolicyId\":\"sp-123***7890\"}
LatestApplyTime	integer		1742167218
LatestTaskId	string		t-123***7890
LatestApplySummary	object
CompleteTime	integer		1742167218
ResourceCount	array<object>
	object
ResourceType	string		ACS::OTS::Instance
Count	integer		1
ApplyStatusCount	array<object>
	object
ApplyStatus	string		FAILED
Count	integer		3
NextToken	string	The paging token.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAOTzWWYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3NTcwMzY2MjMwNzY2ODcyMzAzMTY2Nzg3ODY5MzY=
MaxResults	integer	The maximum number of results requested.	10
TotalCount	integer	The total number of entries returned.	5

例

成功レスポンス

JSONJSON

{
  "RequestId": "5B2F09BF-CEBD-5A7E-AC01-E7F86169A5E5",
  "Data": {
    "Content": [
      {
        "ProtectionPolicyRegionId": "cn-hangzhou",
        "ProtectionPolicyId": "p-123***7890",
        "ProtectionPolicyName": "MyProtectionPolicy",
        "BoundResourceCategoryIds": [
          "rc-123***7890"
        ],
        "SubProtectionPolicies": [
          {
            "SubProtectionPolicyType": "ECS_AUTO_SNAPSHOT_POLICY",
            "Config": "{\\\"autoSnapshotPolicyId\\\":\\\"sp-123***7890\\\"}"
          }
        ],
        "LatestApplyTime": 1742167218,
        "LatestTaskId": "t-123***7890",
        "LatestApplySummary": {
          "CompleteTime": 1742167218,
          "ResourceCount": [
            {
              "ResourceType": "ACS::OTS::Instance",
              "Count": 1
            }
          ],
          "ApplyStatusCount": [
            {
              "ApplyStatus": "FAILED",
              "Count": 3
            }
          ]
        }
      }
    ],
    "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAOTzWWYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3NTcwMzY2MjMwNzY2ODcyMzAzMTY2Nzg3ODY5MzY=",
    "MaxResults": 10,
    "TotalCount": 5
  }
}

エラーコード

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

変更履歴

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