文档首页/ 数据管理服务 DAS/ API参考/ API(公测中)/ 云DBA/ 查询实例组列表 - ListInstanceGroup
更新时间:2025-12-24 GMT+08:00
分享

查询实例组列表 - ListInstanceGroup

功能介绍

查询实例组列表。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    das::showBatchInspection

    read

    -

    -

    -

    -

URI

GET /v3/{project_id}/batch-inspection/instance-group

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

datastore_type

String

参数解释:

数据库类型。

约束限制:

支持MySQL、TaurusDB、GaussDB、MariaDB。

取值范围:

  • MySQL
  • TaurusDB
  • GaussDB
  • MariaDB

默认取值:

不涉及。

group_name

String

参数解释

实例组名称。

约束限制:

不涉及。

取值范围:

长度不超过64个字符。

默认取值:

不涉及。

offset

Integer

参数解释:

偏移量。从第一条数据偏移offset条数据后开始查询。例如:该参数指定为1,limit指定为10,则只展示第2~11条数据。

约束限制:

不涉及。

取值范围

[0, 5000]

默认取值:

默认为0(偏移0条数据,表示从第一条数据开始查询)。

limit

Integer

参数解释:

查询记录数。例如该参数设定为10,则查询结果最多只显示10条记录。

约束限制:

不涉及。

取值范围:

[1, 200]

默认取值:

默认为20。

请求参数

无。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总数。

取值范围:

不涉及。

instance_group_list

Array of 表4 objects

参数解释:

实例组列表。

取值范围:

不涉及。

表4 InstanceGroup

参数

参数类型

描述

group_id

Integer

参数解释:

实例组ID。

取值范围:

不涉及。

group_name

String

参数解释:

实例组名称。

取值范围:

不涉及。

description

String

参数解释:

描述。

取值范围:

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/batch-inspection/instance-group

响应示例

状态码:200

Success.

{ 
  "check_result" : true 
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档