文档

DescribeUniBackupPolicies - 查询防勒索策略

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PolicyNamestring

数据库防勒索备份策略的名称。

auto_oracle_Hpm
PageSizeinteger

指定分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1

返回参数

名称类型描述示例值
object

请求返回数据。

RequestIdstring

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

ACF97412-FD09-4D1F-994F-34DF12BR****
PageInfoobject

页面显示信息。

CurrentPageinteger

分页查询时,显示的当前页的页码。

1
PageSizeinteger

分页查询时,每页显示的数据库防勒索策略的数量。

20
TotalCountinteger

查询到的数据库防勒索策略的总数量。

100
Countinteger

当前页面显示的数据库防勒索策略的数量。

20
UniBackupPoliciesarray<object>

数据库防勒索备份策略集合。

object

数据库防勒索备份策略信息。

PolicyStatusstring

数据库防勒索备份策略状态,取值:

  • initiating:初始化中
  • opening:开启中
  • closing:关闭中
  • deleting:删除中
  • enabled:已启用
  • disabled:已禁用
opening
ErrorMessagestring

备份策略的错误信息。

AttachRamRoleError
LatestBackResultstring

最新备份计划执行结果。

completed
UniRegionIdstring

数据库服务器所在的地域 ID。

cn-hangzhou
PlanStatusstring

备份计划状态,取值如下:

  • init:初始化中
  • running:执行中
  • completed:执行完成
  • restoring:恢复中
  • creating:创建中
  • created:创建成功
creating
InstanceUuidstring

服务器数据库备份客户端唯一标识。

cf1bcad4063f11ed800000163e0e****
PolicyNamestring

数据库防勒索备份策略的名称。

auto_oracle_37f
AgentErrorMessagestring

客户端异常错误信息。

INSTALL_TIMEOUT
InstanceIdstring

服务器的实例 ID。

i-9dp7mubt5wit6g0h****
AgentStatusstring

数据库客户端代理的状态。取值包括:

  • UNKNOWN:未知
  • INSTALLED:已安装
  • INSTALL_FAILED:安装失败
  • UNINSTALL_FAILED:卸载失败
INSTALLED
DatabaseTypestring

数据库类型,取值如下:

  • MYSQL
  • MSSQL
  • Oracle
MYSQL
ErrorCodestring

备份计划执行失败返回错误 Code 信息。

EXPIRED
DatabaseNamestring

数据库名称。

abc123
InstanceNamestring

服务器实例名称。

sql-test-001
LatestBackupTimestring

最新备份计划执行时间。

2022-01-01 00:00:11
InstanceStatusstring

ECS 实例状态。取值:

  • Stopped:已停止
  • Running:运行中
Running
PolicyIdlong

数据库防勒索备份策略的 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错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
暂无变更历史