应用与数据集成平台 ROMA Connect-查询插件下绑定的API:响应参数
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
size |
Integer |
本次返回的列表长度 |
total |
Long |
满足条件的记录数 |
apis |
Array of PluginApiInfo objects |
绑定插件的API列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
api_id |
String |
API编号 |
api_name |
String |
API名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。
说明:
中文字符必须为UTF-8或者unicode编码。 |
type |
Integer |
API类型
|
req_protocol |
String |
API的请求协议
缺省值:HTTPS |
req_method |
String |
API的请求方式 |
req_uri |
String |
请求地址。可以包含请求参数,用{}标识,比如/getUserInfo/{userId},支持 * / %- _ .等特殊字符,总长度不超过512,且满足URI规范。 支持环境变量,使用环境变量时,每个变量名的长度为3 ~ 32位的字符串,字符串由英文字母、数字、中划线、下划线组成,且只能以英文开头。
说明:
需要服从URI规范。 |
auth_type |
String |
API的认证方式
|
match_mode |
String |
API的匹配方式
|
remark |
String |
API描述。 |
group_id |
String |
API所属的分组编号 |
group_name |
String |
API所属分组的名称 |
roma_app_id |
String |
归属集成应用编码 |
env_id |
String |
绑定API的环境编码。 |
env_name |
String |
绑定API的环境名称 |
publish_id |
String |
发布编码。 |
plugin_attach_id |
String |
插件绑定编码。 |
attached_time |
String |
绑定时间。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |