# 查询数据库列表\[待下线\] - ListAuditDatabases #### 功能介绍 查询数据库列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DBSS/doc?api=ListAuditDatabases)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dbss/dbss_01_0428.html)。 #### URI GET /v1/{project_id}/{instance_id}/dbss/audit/databases 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。可通过IAM服务\[查询指定IAM用户的项目列表\]接口获取。 **约束限制**： 不涉及 **取值范围**： 以IAM服务接口返回值为准，字符长度32-64。 **默认取值**： 不涉及 | | instance_id | 是 | String | **参数解释**： 实例ID。可通过查询实例列表接口ID字段获取 **约束限制**： 不涉及 **取值范围**： 以查询实例列表接口值为准，字符长度32-64。 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | status | 否 | String | 实例状态 - ON :开启 - OFF : 关闭 | | offset | 否 | String | **参数解释**： 分页偏移量，从第一条数据偏移offset条数据后开始查询 **约束限制**： 仅支持大于等于0的整数 **取值范围**： 大于等于0 **默认取值**： 默认值为0 | | limit | 否 | String | **参数解释**： 每页查询记录数。 **约束限制**： 仅支持大于0的整数 **取值范围**： 大于0小于等于10000 **默认取值**： 默认值为100 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及 **取值范围**： IAM服务查询用户Token接口为准 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | databases | Array of [DataBaseBean] objects | 数据库信息列表 | | total | Integer | 总数 | 表5DataBaseBean | 参数 | 参数类型 | 描述 | |:---|:---|:---| | database | [DataBase] object | 数据库信息 | 表6DataBase | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 数据库ID | | name | String | 数据库名称 | | type | String | 添加的数据库类型： - MYSQL：MySQL - ORACLE：Oracle - POSTGRESQL：PostgreSQL - SQLSERVER：SqlServer - DAMENG：Dameng - TAURUS：Taurus - DWS：Dws - KINGBASE：Kingbase - GAUSSDBOPENGAUSS：GaussDB(for openGauss) - GREENPLUM：Greenplum - HIGHGO：HighGo - SHENTONG：ShenTong - GBASE8A：GBase 8a - GBASE8S：GBase 8s - GBASEXDM：GBase XDM - MONGODB：MongoDB - DDS：DDS（Document Database Service） | | version | String | 数据库版本 | | charset | String | 数据库字符集 - GBK：GBK - UTF8：UTF8 | | ip | String | 数据库IP | | port | String | 数据库端口 | | os | String | 数据库操作系统 | | status | String | 实例状态 - ON：开启 - OFF： 关闭 | | instance_name | String | 数据库实例名 | | audit_status | String | 数据库的运行状态 - ACTIVE：运行中 - SHUTOFF：已关闭 - ERROR：故障 | | agent_url | Array of strings | agent的唯一ID | | db_classification | String | 数据库分类 - RDS：表示RDS数据库 - ECS：自建数据库 | | rds_audit_switch_mismatch | Boolean | rds实例审计开关状态不匹配。当数据库审计开启且rds侧日志上传开关关闭时该字段为true。 | | rds_id | String | RDS数据库的ID。 | | rds_obj_info | String | RDS数据库信息。 | | dws_obj_info | String | DWS数据库信息。 | | clouddb_obj_info | String | 云数据库信息，该字段已废弃。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表8DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表10DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表12DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | #### 请求示例 ``` /v1/{project_id}/{instance_id}/dbss/audit/databases ``` #### 响应示例 **状态码：200** 成功 ``` { "databases" : [ { "database" : { "id" : "zLKv83gBCwCqSg3BJt0m", "name" : "db01", "type" : "MYSQL", "version" : "5.0", "charset" : "UTF8", "ip" : "192.168.0.204", "port" : "3306", "os" : "LINUX64", "status" : "OFF", "instance_name" : "", "audit_status" : null, "agent_url" : [ "zrKw83gBCwCqSg3Bkt1P" ], "db_classification" : "ECS" } } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | | 400 | 请求参数错误 | | 403 | 认证失败 | | 500 | 服务器内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dbss/ErrorCode.html)。