DescribeUniBackupPolicies - 查询防勒索策略 - 云安全中心

查询数据库防勒索策略列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribeUniBackupPolicies

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PolicyName	string	否	数据库防勒索备份策略的名称。	auto_oracle_Hpm
PageSize	integer	否	指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 20 条数据。说明建议 PageSize 取值不要为空。	20
CurrentPage	integer	否	设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。	1

返回参数

名称	类型	描述	示例值
	object	请求返回数据。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	ACF97412-FD09-4D1F-994F-34DF12BR****
PageInfo	object	页面显示信息。
CurrentPage	integer	分页查询时，显示的当前页的页码。	1
PageSize	integer	分页查询时，每页显示的数据库防勒索策略的数量。	20
TotalCount	integer	查询到的数据库防勒索策略的总数量。	100
Count	integer	当前页面显示的数据库防勒索策略的数量。	20
UniBackupPolicies	array<object>	数据库防勒索备份策略集合。
	object	数据库防勒索备份策略信息。
PolicyStatus	string	数据库防勒索备份策略状态，取值： initiating：初始化中 opening：开启中 closing：关闭中 deleting：删除中 enabled：已启用 disabled：已禁用	opening
ErrorMessage	string	备份策略的错误信息。	AttachRamRoleError
LatestBackResult	string	最新备份计划执行结果。	completed
UniRegionId	string	数据库服务器所在的地域 ID。	cn-hangzhou
PlanStatus	string	备份计划状态，取值如下： init：初始化中 running：执行中 completed：执行完成 restoring：恢复中 creating：创建中 created：创建成功	creating
InstanceUuid	string	服务器数据库备份客户端唯一标识。	cf1bcad4063f11ed800000163e0e****
PolicyName	string	数据库防勒索备份策略的名称。	auto_oracle_37f
AgentErrorMessage	string	客户端异常错误信息。	INSTALL_TIMEOUT
InstanceId	string	服务器的实例 ID。	i-9dp7mubt5wit6g0h****
AgentStatus	string	数据库客户端代理的状态。取值包括： UNKNOWN：未知 INSTALLED：已安装 INSTALL_FAILED：安装失败 UNINSTALL_FAILED：卸载失败	INSTALLED
DatabaseType	string	数据库类型，取值如下： MYSQL MSSQL Oracle	MYSQL
ErrorCode	string	备份计划执行失败返回错误 Code 信息。	EXPIRED
DatabaseName	string	数据库名称。	abc123
InstanceName	string	服务器实例名称。	sql-test-001
LatestBackupTime	string	最新备份计划执行时间。	2022-01-01 00:00:11
InstanceStatus	string	ECS 实例状态。取值： Stopped：已停止 Running：运行中	Running
PolicyId	integer	数据库防勒索备份策略的 ID。	123

示例

正常返回示例

JSON格式

{
  "RequestId": "ACF97412-FD09-4D1F-994F-34DF12BR****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  },
  "UniBackupPolicies": [
    {
      "PolicyStatus": "opening",
      "ErrorMessage": "AttachRamRoleError",
      "LatestBackResult": "completed",
      "UniRegionId": "cn-hangzhou",
      "PlanStatus": "creating",
      "InstanceUuid": "cf1bcad4063f11ed800000163e0e****",
      "PolicyName": "auto_oracle_37f",
      "AgentErrorMessage": "INSTALL_TIMEOUT",
      "InstanceId": "i-9dp7mubt5wit6g0h****",
      "AgentStatus": "INSTALLED",
      "DatabaseType": "MYSQL",
      "ErrorCode": "EXPIRED",
      "DatabaseName": "abc123",
      "InstanceName": "sql-test-001",
      "LatestBackupTime": "2022-01-01 00:00:11",
      "InstanceStatus": "Running",
      "PolicyId": 123
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
500	ServerError	ServerError
403	NoPermission	caller has no permission

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

变更历史

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