# 获取云DBA实例列表 - GetInstanceList #### 功能介绍 获取云DBA实例列表。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-das/das_01_0130.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | das::listInstances | list | instance | - | - | - | #### URI POST /v3/{project_id}/instance/get-instance-list 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-das/das_01_0036.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | engine_type | 否 | String | **参数解释：** 数据库引擎类型。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | instance_status | 否 | String | **参数解释：** 实例状态。 **约束限制：** 不涉及。 **取值范围：** - normal：正常 - abnormal：异常 - metricAbnormal：指标异常 - dataDiskFull：磁盘不足 - all：所有 **默认取值：** 不涉及。 | | cur_page | 否 | Integer | **参数解释：** 页数。 **约束限制：** 不涉及。 **取值范围：** \[1, 2\^31-1\]，取决于实际查询。 **默认取值：** 不涉及。 | | page_size | 否 | Integer | **参数解释：** 页大小。 **约束限制：** 不涉及。 **取值范围：** \[1, 2\^31-1\]，取决于实际查询。 **默认取值：** 不涉及。 | | instance_type | 否 | String | **参数解释：** 实例类型。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | engine_version | 否 | String | **参数解释：** 实例版本。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | transaction_flag | 否 | Boolean | **参数解释：** 历史事务是否开启。 **约束限制：** 不涉及。 **取值范围：** - true：已开启 - false：已关闭 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_infos | Array of [表4 DASInstanceInfo]object | **参数解释：** 实例列表。 | | total_count | Integer | **参数解释：** 总数。 **取值范围：** \[0,10000\] | 表4DASInstanceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释：** 实例ID，实例的唯一标识。可通过查看实例列表或者实例详情获取实例ID信息。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 | | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | instance_status | String | **参数解释：** 实例状态。 **取值范围：** 不涉及。 | | version | String | **参数解释：** 实例版本号。 **取值范围：** 不涉及。 | | engine_type | String | **参数解释：** 引擎类型。 **取值范围：** 不涉及。 | | ip | String | **参数解释：** 客户端IP。 **取值范围：** 不涉及。 | | port | Integer | **参数解释：** 客户端端口号。 **取值范围：** 不涉及。 | | cpu | Integer | **参数解释：** 实例cpu核数。 **取值范围：** 不涉及。 | | mem | Integer | **参数解释：** 实例内存大小。 **取值范围：** 不涉及。 | | login_flag | Boolean | **参数解释：** 实例登录是否启用。 **取值范围：** 不涉及。 | | slow_sql_flag | Boolean | **参数解释：** 慢sql是否启用。 **取值范围：** 不涉及。 | | dead_lock_flag | Boolean | **参数解释：** 死锁分析是否启用。 **取值范围：** 不涉及。 | | lock_blocking_flag | Boolean | **参数解释：** 锁阻塞是否启用。 **取值范围：** 不涉及。 | | charge_flag | Boolean | **参数解释：** 当前实例是否计费。 **取值范围：** 不涉及。 | | instance_type | String | **参数解释：** 实例类型。 **取值范围：** 不涉及。 | | full_sql_flag | Boolean | **参数解释：** 全量sql是否启用。 **取值范围：** 不涉及。 | #### 请求示例 ``` POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instance/get-instance-list { "engine_type": "mysql", "instance_status": "all", "page_size": 10, "cur_page": 1 } ``` #### 响应示例 **状态码： 200** Success. ``` { "instance_infos" : [ { "instance_id" : "bcfa975193f1402fa11a6d4fd6baf5fbin01", "instance_name" : "rds-sql", "instance_status" : "ACTIVE", "version" : "5.7", "ip" : "192.168.0.84", "port" : 3306, "cpu" : 2, "mem" : 8, "login_flag" : true, "slow_sql_flag" : true, "dead_lock_flag" : false, "lock_blocking_flag" : false, "charge_flag" : true, "instance_type" : "Single", "full_sql_flag" : true } ], "total_count" : 2 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-das/das_01_0035.html)。