调用DescribeBackupClients查询指定地域下已安装防勒索客户端的服务器

查询指定地域下已安装防勒索客户端的服务器。

接口说明

该接口用于查询指定地域下已安装防勒索客户端的服务器。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribeBackupClients	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
SupportRegionId	string	是	要查询的防勒索支持的地域。您可以调用 DescribeSupportRegion 查询防勒索支持的地域。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	已安装防勒索客户端的服务器返回数据。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	E3ED094C-9EB7-4239-962B-D0FB3D5F23C7
Clients	array<object>	防勒索客户端信息。
BackupMachineDTO	object	安装防勒索客户端的服务器信息。
Uuid	string	已安装防勒索客户端的 ECS 服务器的 UUID。	22f6550d-f294-449b-b6e6-90638fd1****
InstanceId	string	已安装防勒索客户端的 ECS 服务器的实例 ID。	i-bp15hyph4aci99dv****
ClientStatus	string	防勒索客户端的状态。取值： INSTALLING：客户端安装中 ONLINE：正常在线 UNINSTALLING：客户端卸载中 NOT_INSTALLED：客户端未安装 ACTIVATED：客户端已启用 CLIENT_CONNECTION_ERROR：客户端连接错误	ONLINE
ClientId	string	防勒索客户端 ID。	c-000az2f537r73dyh****
ClientVersion	string	防勒索客户端版本号。	2.0.0

示例

正常返回示例

JSON格式

{
  "RequestId": "E3ED094C-9EB7-4239-962B-D0FB3D5F23C7",
  "Clients": [
    {
      "Uuid": "22f6550d-f294-449b-b6e6-90638fd1****",
      "InstanceId": "i-bp15hyph4aci99dv****",
      "ClientStatus": "ONLINE",
      "ClientId": "c-000az2f537r73dyh****",
      "ClientVersion": "2.0.0"
    }
  ]
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史