# 查询审计实例列表\[待下线\] - ListAuditInstances #### 功能介绍 查询审计实例列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DBSS/doc?api=ListAuditInstances)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dbss/dbss_01_0428.html)。 #### URI GET /v1/{project_id}/dbss/audit/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。可通过IAM服务\[查询指定IAM用户的项目列表\]接口获取。 **约束限制**： 不涉及 **取值范围**： 以IAM服务接口返回值为准，字符长度32-64。 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | String | **参数解释**： 分页偏移量，从第一条数据偏移offset条数据后开始查询 **约束限制**： 仅支持大于等于0的整数 **取值范围**： 大于等于0 **默认取值**： 默认值为0 | | limit | 否 | String | 查询记录数 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及 **取值范围**： IAM服务查询用户Token接口为准 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | servers | Array of [AuditInstanceListBean] objects | 实例信息列表 | | total | Integer | 总数 | 表5AuditInstanceListBean | 参数 | 参数类型 | 描述 | |:---|:---|:---| | charge_model | String | 付费模式 - Period：包周期 - Demand：按需。 | | comment | String | 备注信息。 | | config_num | Integer | 配置的数据库总数。 | | connect_ip | String | 连接地址。 | | connect_ipv6 | String | ipv6连接地址。 | | cpu | Integer | CPU个数 | | created | String | 创建时间 | | database_limit | Integer | 支持的数据库总数 | | effect | Integer | 实例结果状态 - 1：冻结可释放 - 2：冻结不可释放 - 3：冻结后不可续费 | | expired | String | 过期时间 | | id | String | ID | | keep_days | String | 剩余天数 | | 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参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表7DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 错误信息 | 表9DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 错误信息 | 表11DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | #### 请求示例 ``` /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 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | | 400 | 失败 | | 403 | 认证失败 | | 500 | 服务端错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dbss/ErrorCode.html)。