调用API查询防勒索策略下服务器的备份状态-云安全中心-阿里云-云安全中心(Security Center)-阿里云帮助中心

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribeBackupMachineStatus

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PolicyId	integer	是	防勒索备份策略的 ID。说明调用 DescribeBackupPolicies 接口可以获取该参数。	123
Uuid	string	是	要查询的服务器的 UUID。说明调用 DescribeBackupPolicy 接口可以获取该参数。	eb2c782e-64f2-4590-a86c-d90164df****
PolicyVersion	string	否	防护策略的版本。取值： 1.0.0：表示防护策略的版本为 1.0.0 2.0.0：表示防护策略的版本为 2.0.0	2.0.0

返回参数

名称	类型	描述	示例值
	object	请求返回数据。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	09969D2C-4FAD-429E-BFBF-9A60DEF8****
BackupMachineStatus	object	服务器备份状态。
Status	string	防勒索客户端状态。取值： NOT_INSTALLED：未安装 CLIENT_CONNECTION_ERROR：客户端状态异常 ACTIVATED：正常	ACTIVATED
Uuid	string	服务器 UUID。	eb2c782e-64f2-4590-a86c-d90164df****
VaultId	string	备份数据存入的仓库的 ID。	v-0005i2qh5fcr6seo****
ErrorCode	string	异常状态返回的错误码。	CLIENT_CONNECTION_ERROR
SavedBackupCount	integer	可恢复版本数。	7
InstanceId	string	服务器实例的 ID。	i-2zeaqkb80vloxjcj****
ClientStatus	string	服务状态。取值： ONLINE：状态正常 CLIENT_CONNECTION_ERROR：客户端连接异常 UNINSTALLING：卸载中 UNINSTALL_FAILED：卸载失败 UPGRADING：升级中 UPGRADE_FAILED：升级失败	ONLINE
RegionId	string	服务器所在的地域的 ID。	cn-shenzhen
ClientVersion	string	防勒索客户端版本号。	2.11.0
ClientId	string	防勒索客户端 ID。	c-000dbefaw9f7gnbw****
ErrorList	array<object>	备份服务器上报的错误信息列表。
	object	备份服务器上报的错误信息。
ErrorCode	string	错误码。	TARGET_NOT_EXIST
ErrorStatus	string	错误状态信息。	FAILED
ServiceStatus	string	服务状态。取值： 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	错误码	错误信息	描述
500	ServerError	ServerError
403	NoPermission	caller has no permission

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

变更历史

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