DescribeUniBackupDatabase - 查询防勒索数据库

查询数据库防护策略中数据库的详细信息。

调试

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

授权信息

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

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

请求参数

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

ECS 实例名称。

test
DatabaseTypestring

数据库类型,取值如下:

  • MYSQL
  • MSSQL
  • Oracle
MYSQL
PageSizeinteger

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

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

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

1
QueryTypestring

数据库查询类型,取值:

  • create:新建
  • restore:恢复
create
UniRegionIdstring

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

cn-hongkong

返回参数

名称类型描述示例值
object
RequestIdstring

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

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

页面显示的信息。

CurrentPageinteger

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

1
PageSizeinteger

分页查询时,每页显示的数据库的数量。

20
TotalCountinteger

查询到的数据库的总数量。

25
Countinteger

当前页面显示的数据库的数量。

20
DatabaseListarray<object>

数据库详情列表。

Databaseobject

数据库详情。

Statusstring

ECS 实例状态。取值:

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

数据库类型,取值如下:

  • MYSQL
  • MSSQL
  • Oracle
MYSQL
DatabaseVersionstring

数据库版本。

12.0.4100.1
DatabaseNamestring

数据库名称。

apns_tt180
InstanceNamestring

数据库所属实例名称。

sql-test-001
InstanceUuidstring

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

85878b284df911ec800000163e19****
CreatedByProductstring

数据库的创建方式。取值:

  • HBR:云备份
  • AEGIS:云安全中心
AEGIS
InstanceIdstring

服务器的实例 ID。

i-bp15aho9hhftvmhw****
PolicyIdlong

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

123
AgentStatusstring

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

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

示例

正常返回示例

JSON格式

{
  "RequestId": "09969D2C-4FAD-429E-BFBF-9A60DEF8****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 25,
    "Count": 20
  },
  "DatabaseList": [
    {
      "Status": "Running",
      "DatabaseType": "MYSQL",
      "DatabaseVersion": "12.0.4100.1",
      "DatabaseName": "apns_tt180",
      "InstanceName": "sql-test-001",
      "InstanceUuid": "85878b284df911ec800000163e19****",
      "CreatedByProduct": "AEGIS",
      "InstanceId": "i-bp15aho9hhftvmhw****",
      "PolicyId": 123,
      "AgentStatus": "INSTALLED"
    }
  ]
}

错误码

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

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