# 查询分组列表 - ListApiGroupsV2 #### 功能介绍 查询API分组列表。 如果是租户操作，则查询该租户下所有的分组；如果是管理员操作，则查询的是所有租户的分组。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ROMA/doc?api=ListApiGroupsV2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-roma/roma_06_0018.html)。 #### URI GET /v2/{project_id}/apic/instances/{instance_id}/api-groups 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方式请参见API参考的"附录 \> 获取项目ID"章节。 | | instance_id | 是 | String | 实例ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Long | 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 | | limit | 否 | Integer | 每页显示的条目数量 | | id | 否 | String | API分组编号 | | name | 否 | String | API分组名称 | | roma_app_id | 否 | String | 集成应用编号 | | precise_search | 否 | String | 指定需要精确匹配查找的参数名称，多个参数需要支持精确匹配时参数之间使用","隔开。 当前支持name，domain_name。 | | domain_name | 否 | String | 域名 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | size | Integer | 本次返回的列表长度 | | total | Long | 满足条件的记录数 | | groups | Array of [ApiGroupInfo] objects | 分组列表 | 表5ApiGroupInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编号 | | name | String | API分组名称 | | status | Integer | 状态 - 1： 有效 - 2: 锁定 | | sl_domain | String | 系统默认分配的子域名 | | register_time | String | 创建时间 | | update_time | String | 最近修改时间 | | on_sell_status | Integer | 是否已上架云市场： - 1：已上架 - 2：未上架 - 3：审核中 ROMA Connect暂未对接云市场，此字段默认返回2 | | url_domains | Array of [UrlDomain] objects | 分组上绑定的独立域名列表 | | sl_domain_access_enabled | Boolean | 调试域名是否可以访问，true表示可以访问，false表示禁止访问 | | sl_domains | Array of strings | 系统默认分配的子域名列表 | | remark | String | 描述 | | call_limits | Integer | 流控时长内分组下的API的总访问次数限制，默认不限，请根据服务的负载能力自行设置 暂不支持 | | time_interval | Integer | 流控时长 暂不支持 | | time_unit | String | 流控的时间单位 暂不支持 | | is_default | Integer | 是否为默认分组 | | version | String | 分组版本 - V1：全局分组 - V2：应用级分组 | | roma_app_id | String | 分组归属的集成应用编号。 分组版本V2时必填。 | | roma_app_name | String | 分组归属的集成应用名称 | 表6UrlDomain | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 域名编号 | | domain | String | 访问域名 | | cname_status | Integer | 域名cname状态： - 1：未解析 - 2：解析中 - 3：解析成功 - 4：解析失败 | | ssl_id | String | SSL证书编号 | | ssl_name | String | SSL证书名称 | | min_ssl_version | String | 最小ssl协议版本号。支持TLSv1.1或TLSv1.2 | | verified_client_certificate_enabled | Boolean | 是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。 | | is_has_trusted_root_ca | Boolean | 是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。 | | ssl_infos | Array of [SslInfo] objects | SSL证书列表 | 表7SslInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ssl_id | String | SSL证书编号 | | ssl_name | String | SSL证书名称 | | algorithm_type | String | 证书算法类型： - RSA - ECC - SM2 | | type | String | 证书可见范围： - instance：当前实例 - global：全局 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 无 #### 响应示例 **状态码：200** OK ``` { "total" : 2, "size" : 2, "groups" : [ { "update_time" : "2020-07-31T06:55:55Z", "name" : "api_group_001", "on_sell_status" : 2, "remark" : "group1", "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ], "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "register_time" : "2020-07-31T06:55:55Z", "status" : 1, "is_default" : 2, "version" : "V1", "sl_domain_access_enabled" : true }, { "update_time" : "2020-06-24T15:29:42.421926Z", "name" : "api_group_002", "on_sell_status" : 2, "remark" : "group2", "sl_domain" : "02a8ab3cb2784de5a096852829671ae7.apic.****.com", "sl_domains" : [ "02a8ab3cb2784de5a096852829671ae7.apic.****.com", "02a8ab3cb2784de5a096852829671ae7.apic.****.cn" ], "id" : "02a8ab3cb2784de5a096852829671ae7", "register_time" : "2020-06-24T15:29:42.421926Z", "status" : 1, "is_default" : 2, "version" : "V1", "sl_domain_access_enabled" : true } ] } ``` **状态码：400** Bad Request ``` { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" } ``` **状态码：401** Unauthorized ``` { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } ``` **状态码：403** Forbidden ``` { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } ``` **状态码：404** Not Found ``` { "error_code" : "APIG.3030", "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec" } ``` **状态码：500** Internal Server Error ``` { "error_code" : "APIG.9999", "error_msg" : "System error" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-roma/ErrorCode.html)。