# 获取DAS云DBA实例列表 - ViewTheInstanceListOnTheIntelligentO\&MPage #### 功能介绍 获取DAS云DBA实例列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DAS/doc?api=ListCloudDbaInstances)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-das/das_01_0130.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | das::listInstances | list | - | - | das:connections:list | - | #### URI GET /v3/{project_id}/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-das/das_01_0036.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | datastore_type | 是 | String | **参数解释：** 数据库类型。 **约束限制：** 不涉及。 **取值范围：** - mysql：云数据库 RDS for MySQL - sqlserver：云数据库 RDS for SQLServer - postgresql：云数据库 RDS for PostgreSQL - mariadb：云数据库 RDS for MariaDB - mysql-turbo: 云数据库 RDS for TaurusDB - taurus：云数据库 TaurusDB - gaussdbv5：云数据库 GaussDB - mongodb：文档数据库服务 DDS - ddm：分布式数据库中间件 DDM **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第2\~11条数据。 **约束限制：** 不涉及。 **取值范围**： \[0, 5000\] **默认取值：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释：** 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 **约束限制：** 不涉及。 **取值范围：** \[0, 100\] **默认取值：** 默认为20。 | #### 请求参数 无。 #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_list | Array of [表4] | **参数解释：** 实例列表。 | | total_count | Integer | **参数解释：** 总数。 **取值范围：** \[0,10000\] | 表4DASInstanceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释：** 实例ID，实例的唯一标识。可通过查看实例列表或者实例详情获取实例ID信息。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 | | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | instance_status | String | **参数解释：** 实例状态。 **取值范围：** - normal：实例正常 - abnormal：实例异常 - creating：实例正在创建 - createfail：实例创建失败 - data_disk_full：实例磁盘空间满 - deleted：实例已删除 - shutdown：实例已关机 | | version | String | **参数解释：** 实例版本号。 **取值范围：** 不涉及。 | | engine_type | String | **参数解释：** 引擎类型。 **取值范围：** - mysql：云数据库 RDS for MySQL - sqlserver：云数据库 RDS for SQLServer - postgresql：云数据库 RDS for PostgreSQL - mariadb：云数据库 RDS for MariaDB - mysql-turbo: 云数据库 RDS for TaurusDB - taurus：云数据库 TaurusDB - gaussdbv5：云数据库 GaussDB - mongodb：文档数据库服务 DDS - ddm：分布式数据库中间件 DDM | | ip | String | **参数解释：** 客户端IP。 **取值范围：** 不涉及。 | | port | Integer | **参数解释：** 客户端端口号。 **取值范围：** 不涉及。 | | cpu | Integer | **参数解释：** 实例cpu核数。 **取值范围：** 不涉及。 | | mem | Integer | **参数解释：** 实例内存大小。 **取值范围：** 不涉及。 | | login_flag | Boolean | **参数解释：** 实例登录是否启用。 **取值范围：** 不涉及。 | | slow_sql_flag | Boolean | **参数解释：** 慢sql是否启用。 **取值范围：** 不涉及。 | | deadlock_flag | Boolean | **参数解释：** 死锁分析是否启用。 **取值范围：** 不涉及。 | | lock_blocking_flag | Boolean | **参数解释：** 锁阻塞是否启用。 **取值范围：** 不涉及。 | | charge_flag | Boolean | **参数解释：** 当前实例是否计费。 **取值范围：** 不涉及。 | | full_sql_flag | Boolean | **参数解释：** 全量sql是否启用。 **取值范围：** 不涉及。 | #### 请求示例 获取DAS云DBA实例列表。 ``` GET https://das.cn-north-1.myhuaweicloud.com/v3/054c630ff780d4cc2f40c00d7f6fb21d/instances?datastore_type=mysql ``` #### 响应示例 ``` { "instance_list" : [ { "instance_id" : "bcfa975193f1402fa11a6d4fd6baf5fbin01", "instance_name" : "rds-sql", "instance_status" : "normal", "engine_type": "mysql", "version" : "5.7", "ip" : "192.168.0.84", "port" : 3306, "cpu" : 2, "mem" : 8, "login_flag" : true, "slow_sql_flag" : true, "deadlock_flag" : false, "lock_blocking_flag" : false, "charge_flag" : true, "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)。