All Products
Search
Document Center

API Gateway:DescribePluginApis

Last Updated:Jul 31, 2025

Queries the APIs to which a specified plug-in is bound.

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:DescribePluginApisget
*Plugin
acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PluginIdstringYes

The ID of the gateway plug-in.

bf6583efcef44c51adb00c4e********
GroupIdstringNo

The ID of the API group.

231a4bb81ee94da785733c29********
ApiIdstringNo

The ID of the API.

c6b0dd188b0e4e408e12f926********
ApiNamestringNo

The name of the API.

API
PathstringNo

The request path of the API.

/sendVerifyCode
MethodstringNo

The request HTTP method of the API.

GET
DescriptionstringNo

The description of the API.

API description
PageSizeintegerNo

The number of entries returned per page. Default value:10.

10
PageNumberintegerNo

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

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

PageNumberinteger

The page number of the page to return.

1
RequestIdstring

The request ID.

F9C5C4A5-BC6C-57A3-839F-AB08********
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

7
ApiSummarysarray<object>

The information about APIs.

ApiPluginSummaryobject
ApiIdstring

The API ID.

accc8c68b7294b1cb4928741********
Descriptionstring

The API description.

API description
GroupNamestring

The API group to which the API belongs.

myGroup2
GroupIdstring

The ID of the API group.

5f51f89261854fd9ad5116be********
Pathstring

The request path of the API.

/mqTest
Methodstring

The HTTP method of the API.

GET
StageNamestring

The environment to which the API is published. Valid values:

  • RELEASE: the production environment
  • PRE: the pre-release environment
  • TEST: the test environment
RELEASE
ApiNamestring

The API name.

fhosQueryDayOfStock_V2
RegionIdstring

The ID of the region in which the API resides.

cn-shanghai
StageAliasstring

The environment alias.

Production

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "F9C5C4A5-BC6C-57A3-839F-AB08********",
  "PageSize": 10,
  "TotalCount": 7,
  "ApiSummarys": {
    "ApiPluginSummary": [
      {
        "ApiId": "accc8c68b7294b1cb4928741********",
        "Description": "API description",
        "GroupName": "myGroup2",
        "GroupId": "5f51f89261854fd9ad5116be********",
        "Path": "/mqTest",
        "Method": "GET",
        "StageName": "RELEASE",
        "ApiName": "fhosQueryDayOfStock_V2",
        "RegionId": "cn-shanghai",
        "StageAlias": "Production\n"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-03-21The response structure of the API has changedView Change Details