All Products
Search
Document Center

API Gateway:DescribePlugins

Last Updated:Mar 01, 2024

Queries plug-ins and their details.

Operation description

  • This operation supports pagination.
  • This operation allows you to query plug-ins by business type.
  • This operation allows you to query plug-ins by ID.
  • This operation allows you to query plug-ins by name.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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:DescribePluginsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PluginIdstringNo

The ID of the plug-in.

a96926e82f994915a8da40a119374537
PluginTypestringNo

The business type of the plug-in.

cors
PluginNamestringNo

The name of the plug-in.

testPlugin
PageNumberintegerNo

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

1
PageSizeintegerNo

The number of entries per page. Maximum value: 100. Default value: 10.

10
Tagobject []No

The tag of objects that match the lifecycle rule. You can specify multiple tags.

Key, Value
KeystringNo

The key of the tag.

N can be an integer from 1 to 20.``

env
ValuestringNo

The value of the tag.

N can be an integer from 1 to 20.``

' '

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
Pluginsobject []

The returned information about the plug-in. It is an array consisting of PluginAttribute data.

PluginIdstring

The ID of the plug-in.

9a3f1a5279434f2ba74ccd91c295af9f
ModifiedTimestring

The last modification time (UTC) of the plug-in.

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

The definition statement of the plug-in.

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

The plug-in description.

Throttling
PluginNamestring

The name of the plug-in.

firstPlugin
CreatedTimestring

The creation time (UTC) of the plug-in.

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

The type of the plug-in.

trafficControl
RegionIdstring

The region where the plug-in is located.

cn-qingdao
Tagsobject []

The tags.

Keystring

The key of the tag.

testkey
Valuestring

The value of the tag.

tetstvalue

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": "Throttling\n",
        "PluginName": "firstPlugin",
        "CreatedTime": "2019-01-11T09:29:58Z",
        "PluginType": "trafficControl",
        "RegionId": "cn-qingdao",
        "Tags": {
          "TagInfo": [
            {
              "Key": "testkey",
              "Value": "tetstvalue"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2021-12-31The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.