华为云首页用户手册

API网关 APIG-查询可绑定当前插件的API:响应参数

API网关 APIG-查询可绑定当前插件的API:响应参数

时间：2024-11-11 18:22:32

API网关 APIG

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
size	Integer	本次返回的列表长度
total	Long	满足条件的记录数
apis	Array of PluginApiInfo objects	绑定插件的API列表。

表5 PluginApiInfo
参数	参数类型	描述
api_id	String	API编号
api_name	String	API名称。支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号，且只能以英文、汉字和数字开头，3-255个字符。说明：中文字符必须为UTF-8或者unicode编码。
type	Integer	API类型 1：公有API 2：私有API
req_protocol	String	API的请求协议 HTTP HTTPS BOTH：同时支持HTTP和HTTPS 缺省值：HTTPS
req_method	String	API的请求方式
req_uri	String	请求地址。可以包含请求参数，用{}标识，比如/getUserInfo/{userId}，支持 * / %- _ . 等特殊字符，总长度不超过512，且满足URI规范。支持环境变量，使用环境变量时，每个变量名的长度为3 ~ 32位的字符串，字符串由英文字母、数字、中划线、下划线组成，且只能以英文开头。说明：需要服从URI规范。
auth_type	String	API的认证方式 NONE：无认证 APP：APP认证 IAM ：IAM认证 AUTHORIZER：自定义认证
match_mode	String	API的匹配方式 SWA：前缀匹配 NORMAL：正常匹配（绝对匹配）默认：NORMAL
remark	String	API描述。
group_id	String	API所属的分组编号
group_name	String	API所属分组的名称
roma_app_id	String	归属集成应用编码,兼容roma实例的字段，一般为空
env_id	String	绑定API的环境编码。
env_name	String	绑定API的环境名称
publish_id	String	发布编码。
plugin_attach_id	String	插件绑定编码。
attached_time	String	绑定时间。
tags	Array of strings	API绑定的标签，标签配额默认10条，可以联系技术调整。最小长度：1 最大长度：128 数组长度：0 - 10

状态码： 400

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

状态码： 401

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

状态码： 403

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

状态码： 404

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

状态码： 500

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

上一篇：API网关 APIG-查询可绑定当前插件的API:响应示例

下一篇：API网关 APIG-查询可绑定当前插件的API:URI

华为云11.11 2核1G 2M 云服务器

29元/年

立即注册领万元上云礼券

抽奖赢11111元免单

续费同价 L实例 2核2G 4M

98元/年

热门域名 1元随心购

1元/年

API网关 APIG-查询可绑定当前插件的API:响应参数

意见反馈

0/200

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

推荐文章

解决方案
相关专题