备案控制台
文档
产品文档
输入文档关键字查找
首页 云安全中心 开发参考 API参考指南 API目录 防勒索 DescribeBackupMachineStatus - 查询备份机器状态

DescribeBackupMachineStatus - 查询备份机器状态

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

查询防勒索备份策略的服务器备份状态。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
PolicyIdlong是

防勒索备份策略的 ID。

说明 调用 DescribeBackupPolicies 接口可以获取该参数。
123
Uuidstring是

要查询的服务器的 UUID。

说明 调用 DescribeBackupPolicy 接口可以获取该参数。
eb2c782e-64f2-4590-a86c-d90164df****
PolicyVersionstring否

防护策略的版本。取值：

  • 1.0.0：表示防护策略的版本为 1.0.0
  • 2.0.0：表示防护策略的版本为 2.0.0
2.0.0

返回参数

名称类型描述示例值
object

请求返回数据。

RequestIdstring

本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

09969D2C-4FAD-429E-BFBF-9A60DEF8****
BackupMachineStatusobject

服务器备份状态。

Statusstring

防勒索客户端状态。取值：

  • NOT_INSTALLED：未安装
  • CLIENT_CONNECTION_ERROR：客户端状态异常
  • ACTIVATED：正常
ACTIVATED
Uuidstring

服务器 UUID。

eb2c782e-64f2-4590-a86c-d90164df****
VaultIdstring

备份数据存入的仓库的 ID。

v-0005i2qh5fcr6seo****
ErrorCodestring

异常状态返回的错误码。

CLIENT_CONNECTION_ERROR
SavedBackupCountinteger

可恢复版本数。

7
InstanceIdstring

服务器实例的 ID。

i-2zeaqkb80vloxjcj****
ClientStatusstring

服务状态。取值：

  • ONLINE：状态正常
  • CLIENT_CONNECTION_ERROR：客户端连接异常
  • UNINSTALLING：卸载中
  • UNINSTALL_FAILED：卸载失败
  • UPGRADING：升级中
  • UPGRADE_FAILED：升级失败
ONLINE
RegionIdstring

服务器所在的地域的 ID。

cn-shenzhen
ClientVersionstring

防勒索客户端版本号。

2.11.0
ClientIdstring

防勒索客户端 ID。

c-000dbefaw9f7gnbw****
ErrorListobject []

备份服务器上报的错误信息列表。

ErrorCodestring

错误码。

TARGET_NOT_EXIST
ErrorStatusstring

错误状态信息。

FAILED
ServiceStatusstring

服务状态。取值：

  • SERVICE_EXCEPTION：服务异常
  • RESTORING：恢复中
  • BACKING_UP：备份中
RESTORING

示例

正常返回示例

JSON格式

{
  "RequestId": "09969D2C-4FAD-429E-BFBF-9A60DEF8****",
  "BackupMachineStatus": {
    "Status": "ACTIVATED",
    "Uuid": "eb2c782e-64f2-4590-a86c-d90164df****",
    "VaultId": "v-0005i2qh5fcr6seo****",
    "ErrorCode": "CLIENT_CONNECTION_ERROR",
    "SavedBackupCount": 7,
    "InstanceId": "i-2zeaqkb80vloxjcj****",
    "ClientStatus": "ONLINE",
    "RegionId": "cn-shenzhen",
    "ClientVersion": "2.11.0",
    "ClientId": "c-000dbefaw9f7gnbw****",
    "ErrorList": [
      {
        "ErrorCode": "TARGET_NOT_EXIST",
        "ErrorStatus": "FAILED"
      }
    ],
    "ServiceStatus": "RESTORING"
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障，请稍后重试！

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

变更历史

变更时间变更内容概要操作
2023-12-06OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
  • 本页导读 （1）
文档反馈