使用 ListProtectedResources API 列出受保护资源 - 云备份 -Alibaba Cloud - 云备份

查询已保护的资源列表

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hbr:ListProtectedResources

list

*全部资源

*

无

请求语法

GET  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	下一页开始的 Token，NextToken 为空说明没有下一页。	aWQj********MCMy
MaxResults	integer	否	每次查询结果的个数。取值范围：10~100。默认值：10。	10
CreatedByProduct	string	否	所属产品能力，支持： HBR：云备份标准能力。 BASIC：ECS 文件备份基础版。	BASIC
SourceType	string	否	备份功能类型，支持： ECS_FILE：ECS 文件备份。 COMMON_FILE_SYSTEM：CPFS 备份。 COMMON_NAS：本地 NAS 备份。 File：本地文件备份。 NAS：阿里云 NAS 备份。 OSS：OSS 备份。枚举值： NAS : NAS COMMON_FILE_SYSTEM : COMMON_FILE_SYSTEM ECS_FILE : ECS_FILE COMMON_NAS : COMMON_NAS File : File OSS : OSS	ECS_FILE
ResourceId	string	否	资源 ID。 SourceType=ECS_FILE：表示 ECS 实例 ID。 SourceType=COMMON_FILE_SYSTEM：表示 CPFS 数据源 ID。 SourceType=COMMON_NAS：表示本地 NAS 数据源 ID。 SourceType=File：表示本地服务器客户端 ID。 SourceType=NAS：表示阿里云 NAS 文件系统 ID。 SourceType=OSS：表示 OSS Bucket。	i-wz95************7zrd
Skip	integer	否	分页查询时跳过的条目数。当跳过的条目数超过符合条件的条目总数时，会返回空列表。跳过的条目数需要是 MaxResults 的倍数。	10
HasSnapshot	boolean	否	是否有备份点	true

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	EB09**----******6C38
Code	string	返回码，200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
Success	boolean	请求是否成功。 true 表示成功。 false 表示失败。	true
TotalCount	integer	已保护的资源总数。	3
ProtectedResources	array<object>	已保护的资源列表。
	object	已保护的资源。
SourceType	string	备份功能类型，支持： ECS_FILE：ECS 文件备份。 COMMON_FILE_SYSTEM：CPFS 备份。 COMMON_NAS：本地 NAS 备份。 File：本地文件备份。 NAS：阿里云 NAS 备份。 OSS：OSS 备份。	ECS_FILE
ResourceId	string	资源 ID。 SourceType=ECS_FILE：表示 ECS 实例 ID。 SourceType=COMMON_FILE_SYSTEM：表示 CPFS 数据源 ID。 SourceType=COMMON_NAS：表示本地 NAS 数据源 ID。 SourceType=File：表示本地服务器客户端 ID。 SourceType=NAS：表示阿里云 NAS 文件系统 ID。 SourceType=OSS：表示 OSS Bucket。	i-wz95************7zrd
ResourceOwnerId	integer	资源所属的用户 UID。	1024********0703
CreatedByProduct	string	所属产品能力，支持： HBR：云备份标准能力。 BASIC：ECS 文件备份基础版。	BASIC
SnapshotCount	integer	备份的个数。	30
ProtectedResourceId	string	已保护的资源 ID。	pr-0004************gs61
ProtectedDataSize	integer	已保护的数据量，单位 Byte，目前仅支持 ECS 文件备份基础版。 SourceType=ECS_FILE：表示已备份的块存储容量。	107374182400
ResourceRegionId	string	资源所属地域 ID	cn-hangzhou
BackupPlanCount	integer	备份计划数量	1
MaxResults	integer	每次查询结果的个数。取值范围：10~100。默认值：10。	10
NextToken	string	下一页开始的 Token，NextToken 为空说明没有下一页。	eyJJ************MX0=

示例

正常返回示例

JSON格式

{
  "RequestId": "EB09****-****-****-****-********6C38",
  "Code": "200",
  "Message": "successful",
  "Success": true,
  "TotalCount": 3,
  "ProtectedResources": [
    {
      "SourceType": "ECS_FILE",
      "ResourceId": "i-wz95************7zrd",
      "ResourceOwnerId": 0,
      "CreatedByProduct": "BASIC",
      "SnapshotCount": 30,
      "ProtectedResourceId": "pr-0004************gs61",
      "ProtectedDataSize": 107374182400,
      "ResourceRegionId": "cn-hangzhou",
      "BackupPlanCount": 1
    }
  ],
  "MaxResults": 10,
  "NextToken": "eyJJ************MX0="
}

错误码

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

变更历史

更多信息，参考变更详情。