All Products
Search
Document Center

API Gateway:DescribePluginsByApi

Last Updated:Jul 31, 2025

Queries the plug-ins that are bound to a running API in a specified environment.

Operation description

  • This operation is intended for API callers.
  • This operation supports pagination.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:DescribePluginsByApiget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringYes

The ID of the group to which the API belongs.

3c7a38392e764718ad7673e7b7f535d4
ApiIdstringYes

The ID of the API.

93f4ead4080c4b2da70b7f81f50ae459
StageNamestringYes

The environment in which the API is running. Valid values:

  • RELEASE: production
  • PRE: staging
  • TEST: test
RELEASE
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries returned per page.

10

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

46373DC4-19F1-4DC8-8C31-1107289BB5E0
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

1
Pluginsarray<object>

The plug-in information. The information is an array that consists of PluginAttribute data.

PluginAttributeobject
PluginIdstring

The plug-in ID.

9a3f1a5279434f2ba74ccd91c295af9f
ModifiedTimestring

The time when the plug-in was last modified. The time is displayed in UTC.

2019-01-11T09:29:58Z
PluginDatastring

The definition statement of the plug-in.

{\"unit\":\"MINUTE\",\"apiDefault\":20}
Descriptionstring

The plug-in description.

Traffic throttling
PluginNamestring

The plug-in name.

firstPlugin
CreatedTimestring

The time when the plug-in was created. The time is displayed in UTC.

2019-01-11T09:29:58Z
PluginTypestring

The plug-in type.

trafficControl
RegionIdstring

The region where the plug-in resides.

cn-qingdao

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "46373DC4-19F1-4DC8-8C31-1107289BB5E0",
  "PageSize": 10,
  "TotalCount": 1,
  "Plugins": {
    "PluginAttribute": [
      {
        "PluginId": "9a3f1a5279434f2ba74ccd91c295af9f",
        "ModifiedTime": "2019-01-11T09:29:58Z",
        "PluginData": "{\\\"unit\\\":\\\"MINUTE\\\",\\\"apiDefault\\\":20}",
        "Description": "Traffic throttling\n",
        "PluginName": "firstPlugin",
        "CreatedTime": "2019-01-11T09:29:58Z",
        "PluginType": "trafficControl",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-12-06The internal configuration of the API is changed, but the call is not affectedView Change Details