文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 勒索防护/ 查询指定备份信息 - ShowBackupInfoByBackupId
更新时间:2025-10-31 GMT+08:00
分享

查询指定备份信息 - ShowBackupInfoByBackupId

功能介绍

查询指定备份信息

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/ransomware/backup/{backup_id}/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

backup_id

String

参数解释:

备份ID

约束限制:

不涉及

取值范围:

字符长度0-64位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释

备份ID

取值范围

字符长度0-65535位

name

String

参数解释

备份名称

取值范围

字符长度0-65535位

image_type

String

参数解释

备份类型

取值范围

字符长度0-65535位

vault_id

String

参数解释

备份所在的存储库ID

取值范围

字符长度0-65535位

created_at

Long

参数解释

创建时间

取值范围

取值0-9223372036854775807

status

String

参数解释

备份状态

取值范围

字符长度0-65535位

resource_size

Integer

参数解释

创建时间

取值范围

取值0-2147483647

resource_id

String

参数解释

资源ID 对应host主机ID

取值范围

字符长度0-65535位

resource_type

String

参数解释

资源类型

取值范围

字符长度0-65535位

resource_name

String

参数解释

资源名称 对应host主机名称

取值范围

字符长度0-65535位

children

Array of BackupResp objects

参数解释

子备份就是卷备份信息

取值范围

字符长度0-65535位

表5 BackupResp

参数

参数类型

描述

id

String

参数解释

卷备份ID

取值范围

字符长度0-65535位

name

String

参数解释

磁盘备份名称

取值范围

字符长度0-65535位

image_type

String

参数解释

备份类型

取值范围

字符长度0-65535位

vault_id

String

参数解释

备份所在的存储库ID

取值范围

字符长度0-65535位

status

String

参数解释

备份状态

取值范围

字符长度0-65535位

resource_size

Integer

参数解释

创建时间

取值范围

取值0-2147483647

resource_id

String

参数解释

资源ID 对应host主机ID

取值范围

字符长度0-65535位

resource_type

String

参数解释

资源类型

取值范围

字符长度0-65535位

resource_name

String

参数解释

资源名称 对应host主机名称

取值范围

字符长度0-65535位

请求示例

查询指定备份IDxxxxxx信息

GET https://{endpoint}/v5/{project_id}/ransomware/backup/{backup_id}/detail?enterprise_project_id=all_granted_ep&backup_id=xxxxxx

响应示例

状态码:200

请求已成功

{
  "id" : "id",
  "name" : "name",
  "resource_id" : "resource_id",
  "children" : {
    "id" : "id_children",
    "name" : "dev1"
  }
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档