You need to enable JavaScript to run this app.
文档中心
API 网关

API 网关

复制全文
下载 pdf
插件管理
GetPlugin - 查询插件详情
复制全文
下载 pdf
GetPlugin - 查询插件详情
查询插件配置详情。​
请求说明​
API 网关已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apig.cn-beijing.volcengineapi.com?Action=GetPlugin&Version=2022-11-12​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
GetPlugin​
接口名称。当前 API 的名称为 GetPlugin。​
Version​
String​
是​
2022-11-12​
接口版本。当前 API 的版本为 2022-11-12。​
PluginName​
String​
是​
native-cluster-rate-limit​
插件名称,取值:​
  • native-cluster-rate-limit:全局限流插件。​
  • geoip:GeoIP 地理定位插件。​
GatewayId​
String​
是​
gd8****​
网关实例 ID。您可以通过 ListGateways 查询网关实例 ID。​
​
请求示例​
​
POST https://apig.cn-beijing.volcengineapi.com?Action=GetPlugin&Version=2022-11-12​
Content-Type: application/json​
{​
"PluginName": "native-cluster-rate-limit",​
"GatewayId": "gd8****"​
}​
​
返回参数​
​
参数​
类型​
示例值​
描述​
PluginID​
String​
pl-zsxa****​
插件 ID。​
PluginName​
String​
native-cluster-rate-limit​
插件名称。​
PluginConfig​
String​
-​
插件配置。​
GatewayId​
String​
gd8****​
网关实例 ID。​
Enable​
Boolean​
true​
插件是否开启。取值:​
  • true:开启。​
  • false:不开启。​
CreateTime​
String​
2025-01-01T00:00:00+08:00​
插件创建时间。​
标准 RFC3339 格式的 UTC+8 时间。​
UpdateTime​
String​
2025-01-01T00:00:00+08:00​
插件更新时间。​
标准 RFC3339 格式的 UTC+8 时间。​
AddonStatus​
String​
HEALTHY​
插件状态,取值:​
  • HEALTHY:正常。​
  • RECONCILING:创建中或更新中。​
  • ERROR:错误。​
Message​
String​
-​
插件状态错误时的错误信息。​
​
返回示例​
​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "GetPlugin",​
"Version": "2022-11-12",​
"Service": "apig",​
"Region": "cn-beijing"​
},​
"Result": {​
"PluginID": "pl-zsxa****",​
"PluginName": "native-cluster-rate-limit",​
"PluginConfig": "",​
"GatewayId": "gd8****",​
"Enable": true,​
"CreateTime": "2025-01-01T00:00:00+08:00",​
"UpdateTime": "2025-01-01T00:00:00+08:00",​
"AddonStatus": "HEALTHY",​
"Message": "-"​
}​
}​
​
错误码​
本接口无特有的错误码。更多信息请参见 公共错误码。​
最近更新时间:2026.07.29 10:20:07
这个页面对您有帮助吗?
有用
有用
无用
无用