文档首页/ 数据库安全服务 DBSS/ API参考/ API说明/ 待下线接口/ 查询审计实例列表[待下线] - ListAuditInstancesNew
更新时间：2026-07-10 GMT+08:00
查看PDF
分享

查询审计实例列表[待下线] - ListAuditInstancesNew

功能介绍

查询审计实例列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/audit/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-64。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

参数解释：

分页偏移量，从第一条数据偏移offset条数据后开始查询

约束限制：

仅支持大于等于0的整数

取值范围：

大于等于0

默认取值：

默认值为0

limit

否

String

参数解释：

每页查询记录数。

约束限制：

仅支持大于0的整数

取值范围：

大于0小于等于1000

默认取值：

默认值为100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

instances

Array of ResponseAuditV2 objects

实例列表

total

Integer

总记录数
表5 ResponseAuditV2

参数

参数类型

描述

binding_db_type

String

绑定数据库类型

charge_model

String

付费模式

  • Period：包周期

  • Demand：按需。

comment

String

备注

config_num

Integer

已配置数据库数量

connectIpv6

String

IPV6

connect_ip

String

IPV4

cpu

Integer

CPU数量

created

String

创建时间

database_limit

Integer

数据库数量限额

effect

Integer

实例结果状态

  • 1：冻结可释放

  • 2：冻结不可释放

  • 3：冻结后不可续费

enterprise_project_id

String

企业项目ID

expired

String

过期时间

failed_reason

String

失败原因

instance_id

String

实例ID

keep_days

String

在线天数

name

String

实例名称

new_version

String

最新版本

port_id

String

端口ID

ram

Integer

内存大小

region

String

所属区域

remain_days

String

剩余天数

resource_id

String

资源ID

resource_spec_code

String

资源规格编码

scene

String

冻结场景

  • POLICE: 公安冻结

  • ILLEGAL: 违规冻结

  • VERIFY: 未实名认证冻结

  • PARTNER: 合作伙伴冻结

  • ARREARS: 普通冻结（普通）

security_group_id

String

安全组ID

specification

String

规格

status

String

实例状态

  • SHUTOFF: 已关闭

  • ACTIVE: 运行中，允许任何操作

  • DELETING: 删除中，不允许任何操作

  • BUILD: 创建中，不允许任何操作

  • DELETED: 已删除，不需要展示

  • ERROR: 故障，只允许删除

  • HAWAIT: 等待备机创建成功，不允许任何操作

  • FROZEN: 已冻结，只允许续费、绑定/解绑

  • UPGRADING: 升级中，不允许升级操作

subnet_id

String

子网ID

supported_feature

Array of strings

功能列表

task

String

任务状态

  • powering-on: 正在开启，实例可以绑定、解绑

  • powering-off: 正在关闭，实例可以绑定、解绑

  • rebooting: 正在重启，实例可以绑定、解绑

  • delete_wait: 等待删除，集群与实例不允许任何操作

  • NO_TASK: 不展示

timezone

String

时区

upgrade_log

String

升级日志

version

String

实例版本

vpc_id

String

VPC私有云ID

zone

String

可用区

状态码：400

表6 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表7 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：403

表8 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表9 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：500

表10 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表11 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

/v1/{project_id}/audit/instances

响应示例

状态码：200

成功

{
  "instances" : [ {
    "name" : "DBSS-Test",
    "comment" : "",
    "connect_ipv6" : null,
    "status" : "ACTIVE",
    "task" : "NO_TASK",
    "instance_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
}

状态码

状态码

描述

200

成功

400

失败

403

认证失败

500

服务端错误

错误码

请参见错误码。

父主题： 待下线接口