查询API下绑定的插件
功能介绍
查询指定API下绑定的插件信息。
-
用于查询指定API下已经绑定的插件列表信息
-
支持分页返回
-
支持插件名称模糊查询
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}/attached-plugins
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID，在API网关控制台的“实例信息”中获取。 |
|
api_id |
是 |
String |
API编号 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Long |
偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 |
|
limit |
否 |
Integer |
每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 |
|
env_id |
否 |
String |
发布的环境编号 |
|
plugin_name |
否 |
String |
插件名称 |
|
plugin_id |
否 |
String |
插件编号 |
|
env_name |
否 |
String |
环境名称 |
|
plugin_type |
否 |
String |
插件类型 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
size |
Integer |
本次返回的列表长度 |
|
total |
Long |
满足条件的记录数 |
|
plugins |
Array of AttachedPluginInfo objects |
绑定API的插件列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
plugin_attach_id |
String |
插件绑定编码。 |
|
plugin_id |
String |
插件编码。 |
|
plugin_name |
String |
插件名称。支持汉字，英文，数字，中划线，下划线，且只能以英文和汉字开头，3-255字符  说明：
中文字符必须为UTF-8或者unicode编码。
|
|
plugin_type |
String |
插件类型。
|
|
plugin_scope |
String |
插件可见范围。global：全局可见。 |
|
env_id |
String |
绑定API的环境编码。 |
|
env_name |
String |
api授权绑定的环境名称 |
|
attached_time |
String |
绑定时间。 |
|
plugin_content |
String |
插件定义内容，支持json。 最大长度：65535 |
|
remark |
String |
插件描述，255字符。 说明：
中文字符必须为UTF-8或者unicode编码。
最大长度：255 |
|
create_time |
String |
创建时间。 |
|
update_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 |
错误描述 |
请求示例
无
响应示例
状态码：200
OK
{
"total" : 1,
"size" : 1,
"plugins" : [ {
"plugin_attach_id" : "8aa097b00e9843efacb9c593d11b769e",
"plugin_id" : "5b729aa252764739b3s237ef0d66dc63",
"plugin_name" : "跨域插件",
"plugin_type" : "cors",
"plugin_scope" : "global",
"plugin_content" : "{\"allow_origin\": \"*\",\"allow_methods\": \"GET,POST,PUT\",\"allow_headers\": \"Content-Type,Accept,Accept-Ranges,Cache-Control\",\"expose_headers\": \"X-Request-Id,X-Apig-Latency\",\"max_age\": 172800,\"allow_credentials\": true}",
"remark" : "CORS跨域资源访问",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"env_name" : "RELEASE",
"attached_time" : "2022-11-02T12:31:23.353Z",
"create_time" : "2022-11-02T12:31:23.353Z",
"update_time" : "2022-11-02T12:31:23.353Z"
} ]
}状态码：400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:instance_id. 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.3002",
"error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}状态码：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 |
错误码
请参见错误码。
