华为云首页用户手册

API网关 APIG-查询分组列表:响应参数

API网关 APIG-查询分组列表:响应参数

时间：2024-06-27 11:06:20

API网关 APIG

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
size	Integer	本次返回的列表长度
total	Long	满足条件的记录数
groups	Array of ApiGroupInfo objects	分组列表

表5 ApiGroupInfo
参数	参数类型	描述
id	String	编号
name	String	API分组名称
status	Integer	状态 1：有效枚举值： 1
sl_domain	String	系统默认分配的子域名
register_time	String	创建时间
update_time	String	最近修改时间
on_sell_status	Integer	是否已上架云商店： 1：已上架 2：未上架 3：审核中
url_domains	Array of UrlDomain objects	分组上绑定的独立域名列表
sl_domain_access_enabled	Boolean	调试域名是否可以访问，true表示可以访问，false表示禁止访问缺省值：true
sl_domains	Array of strings	系统默认分配的子域名列表
remark	String	描述
call_limits	Integer	流控时长内分组下的API的总访问次数限制，默认不限，请根据服务的负载能力自行设置暂不支持
time_interval	Integer	流控时长暂不支持
time_unit	String	流控的时间单位暂不支持
is_default	Integer	是否为默认分组
version	String	分组版本 V1：全局分组 V2：应用级分组暂不支持，默认为V1
roma_app_id	String	分组归属的集成应用编号。分组版本V2时必填。暂不支持
roma_app_name	String	分组归属的集成应用名称暂不支持

表6 UrlDomain
参数	参数类型	描述
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 缺省值：TLSv1.1 枚举值： TLSv1.1 TLSv1.2
verified_client_certificate_enabled	Boolean	是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。缺省值：false
is_has_trusted_root_ca	Boolean	是否存在信任的根证书CA。当绑定证书存在trusted_root_ca时为true。缺省值：false
ingress_http_port	Integer	访问该域名绑定的http协议入方向端口，-1表示无端口且协议不支持，可使用80默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTP协议的自定义入方向端口。当创建域名时，该参数未填表示用默认80端口；若填写该参数，则必须同时填写https_port；若要http_port和https_port同时使用默认端口，则两个参数都不填。当修改域名时，该参数未填表示不修改该端口。最小值：-1 最大值：49151
ingress_https_port	Integer	访问该域名绑定的https协议入方向端口，-1表示无端口且协议不支持，可使用443默认端口，其他有效端口允许的取值范围为1024~49151，需为实例已开放的HTTPS协议的自定义入方向端口。当创建域名时，该参数未填表示用默认443端口；若填写该参数，则必须同时填写http_port；若要http_port和https_port同时使用默认端口，则两个参数都不填。当修改域名时，该参数未填表示不修改该端口。最小值：-1 最大值：49151

状态码： 400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 401

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 403

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码： 500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

上一篇：API网关 APIG-查询分组列表:响应示例

下一篇：API网关 APIG-查询分组列表:URI

API网关 APIG-查询分组列表:响应参数

意见反馈

0/200

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

推荐文章

解决方案
相关专题