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

API 网关

复制全文
下载 pdf
插件管理
GetPlugin - 查询插件详情
复制全文
下载 pdf
GetPlugin - 查询插件详情
查询插件详情。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:GetPlugin​
要执行的操作,取值: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。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
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 示例值:-​
插件状态错误时的错误信息。​
​
​
​
请求示例​
​
POST https://apig.cn-beijing.volcengineapi.com?Action=GetPlugin&Version=2022-11-12​
Content-Type: application/json​
{​
"PluginName": "native-cluster-rate-limit",​
"GatewayId": "gd8****"​
}​
​
返回示例​
​
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": "-"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
The specified parameter %s is invalid.​
请求参数值不合法。请确认参数后重试。​
400​
MissingParameter​
The required parameter %s is missing.​
缺少必要的请求参数。请确认参数后重试。​
500​
InternalError​
The request has failed due to an unknown error.​
未知错误。请稍后重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2026.10.28 14:59:50
这个页面对您有帮助吗?
有用
有用
无用
无用