ListProtectionPolicies - 获取保护策略列表

获取保护策略列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bdrc:ListProtectionPolicieslist
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
ProtectionPolicyRegionIdstring

保护策略地域 ID

cn-hangzhou
MaxResultsinteger

最大返回结果数

10
NextTokenstring

分页游标

cae**********699
ProtectionPolicyIdstring

保护策略 ID

p-123***7890

返回参数

名称类型描述示例值
object

响应结构体

RequestIdstring

请求唯一标识

5B2F09BF-CEBD-5A7E-AC01-E7F86169A5E5
Dataobject

响应数据

Contentarray<object>

响应内容

contentobject

本次请求所返回的记录集合

ProtectionPolicyRegionIdstring

保护策略地域 ID

cn-hangzhou
ProtectionPolicyIdstring

保护策略 ID

p-123***7890
ProtectionPolicyNamestring

保护策略名

MyProtectionPolicy
BoundResourceCategoryIdsarray

绑定的资源分类 ID

boundResourceCategoryIdstring

关联的资源分类 ID 列表

rc-123***7890
SubProtectionPoliciesarray<object>

子保护策略

subProtectionPolicyobject

子保护策略

SubProtectionPolicyTypestring

子保护策略类型

ECS_AUTO_SNAPSHOT_POLICY
Configstring

子保护策略配置

{\"autoSnapshotPolicyId\":\"sp-123***7890\"}
LatestApplyTimelong

最近一次应用时间

1742167218
LatestTaskIdstring

最近应用策略的任务 ID

t-123***7890
LatestApplySummaryobject

最近一次应用结果总结

CompleteTimelong

任务完成时间。Unix 时间戳格式,单位:秒。

1742167218
ResourceCountarray<object>

各类型资源数量

resourceCountobject

各类型资源数量

ResourceTypestring

资源类型

ACS::OTS::Instance
Countlong

各类型资源数量

1
ApplyStatusCountarray<object>

应用状态统计计数

applyStatusCountobject
ApplyStatusstring

应用状态

FAILED
Countlong

各类型资源数量

3
NextTokenstring

分页游标

CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAOTzWWYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3NTcwMzY2MjMwNzY2ODcyMzAzMTY2Nzg3ODY5MzY=
MaxResultsinteger

请求的最大结果数

10
TotalCountlong

结果总数

5

示例

正常返回示例

JSON格式

{
  "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
  }
}

错误码

访问错误中心查看更多错误码。