文档首页/ 数据库安全服务 DBSS/ API参考 (巴黎、阿姆斯特丹区域) / API说明/ 审计实例/ 查询审计实例列表
更新时间：2026-03-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询审计实例列表

功能介绍

查询审计实例列表

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/dbss/audit/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

偏移量

limit

否

String

查询记录数

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

servers

Array of AuditInstanceListBean objects

实例信息列表

total

Integer

总数
表5 AuditInstanceListBean

参数

参数类型

描述

charge_model

String

付费模式

  • Period：包周期
  • Demand：按需。

comment

String

备注信息。

config_num

Integer

当前实例已经配置的数据库总数。

connect_ip

String

实例挂载的租户网卡上的IPv4地址。

connect_ipv6

String

实例挂载的租户网卡上的IPv6地址。

cpu

Integer

CPU个数

created

String

创建时间

database_limit

Integer

支持的数据库总数

effect

Integer

实例冻结状态

  • 1:冻结可释放
  • 2:冻结不可释放
  • 3:冻结后不可续费

expired

String

过期时间

id

String

ID

name

String

实例别名

new_version

String

如果有返回，则需要升级，如果没有，则为null。

port_id

String

绑定弹性IP的port ID

ram

Integer

内存

region

String

实例所在region

remain_days

String

到期天数

resource_id

String

资源ID

resource_spec_code

String

实例的规格

scene

String

场景

security_group_id

String

安全组

specification

String

实例规格

status

String

实例状态

  • SHUTOFF :已关闭
  • ACTIVE: 运行中，允许任何操作
  • DELETING: 删除中，不允许任何操作
  • BUILD: 创建中，不允许任何操作
  • DELETED: 已删除，不需要展示
  • ERROR: 故障，只允许删除
  • HAWAIT: 等待备机创建成功，不允许任何操作
  • FROZEN: 已冻结，只允许续费、绑定/解绑
  • UPGRADING: 升级中，不允许升级操作

subnet_id

String

子网ID

task

String

任务状态

  • powering-on: 正在开启，实例可以绑定、解绑
  • powering-off: 正在关闭，实例可以绑定、解绑
  • rebooting: 正在重启，实例可以绑定、解绑
  • delete_wait: 等待删除，集群与实例不允许任何操作
  • NO_TASK: 不展示

version

String

实例的当前版本

vpc_id

String

虚拟私有云

zone

String

可用区

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表7 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表9 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表11 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

请求示例

/v1/{project_id}/dbss/audit/instances

响应示例

状态码： 200

成功

{
  "servers" : [ {
    "name" : "DBSS-Test",
    "comment" : "",
    "connect_ipv6" : null,
    "status" : "ACTIVE",
    "task" : "NO_TASK",
    "id" : "8c53ed03-8ed7-4ff2-ad97-7b2d6d1dd364",
    "specification" : "Low | 3 Proxy",
    "zone" : "cn-cmcc1a-01",
    "created" : "2021-04-21 04:37:54",
    "expired" : null,
    "subnet_id" : "97ef0bb5-3759-4db4-aa49-0d087ed49ce5",
    "cpu" : 4,
    "ram" : 16384,
    "region" : "cn-cmcc1",
    "version" : "21.04.16.164614",
    "charge_model" : "Demand",
    "remain_days" : null,
    "config_num" : 1,
    "effect" : null,
    "scene" : null,
    "connect_ip" : "192.168.0.229",
    "port_id" : "dc4bd420-e01c-4d12-a7ff-814f17c63079",
    "resource_id" : "062212d8-8e30-4783-9671-43f3f1f3bb1e",
    "vpc_id" : "76d98391-5abc-46ed-b8a8-f664202cb166",
    "security_group_id" : "f0fbec06-bcf6-4c7e-99fa-f0ddfbb1d9bd",
    "resource_spec_code" : "dbss.bypassaudit.low",
    "keep_days" : null,
    "new_version" : null,
    "database_limit" : 3
  } ],
  "total" : 1
}

状态码： 400

失败

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

状态码

状态码

描述

200

成功

400

失败

403

认证失败

500

服务端错误

错误码

请参见错误码。

父主题： 审计实例