调用DescribePluginApis查询插件绑定的API列表_API 网关(API Gateway)-阿里云帮助中心

查询插件绑定的API列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
PluginId	string	是	指定要查询的 API 网关插件的 ID。	bf6583efcef44c51adb00c4e********
GroupId	string	否	指定要查询的 API 所属分组 ID。	231a4bb81ee94da785733c29********
ApiId	string	否	指定要查询的 API 编号。	c6b0dd188b0e4e408e12f926********
ApiName	string	否	API 名称。	API名称
Path	string	否	API 请求路径。	/sendVerifyCode
Method	string	否	API 的请求 HTTP Method。	GET
Description	string	否	API 描述信息。	API描述信息
PageSize	integer	否	分页参数，每页显示条数，默认值 10。	10
PageNumber	integer	否	指定要查询的页码，默认是 1，起始是 1。	1

返回参数

名称	类型	描述	示例值
	object	请求的返回数据
PageNumber	integer	返回指定的页码	1
RequestId	string	请求 ID	F9C5C4A5-BC6C-57A3-839F-AB08********
PageSize	integer	分页参数：每页显示条数。	10
TotalCount	integer	返回结果总数	7
ApiSummarys	array<object>	API 信息集合
ApiPluginSummary	object	API 信息
ApiId	string	API 编号	accc8c68b7294b1cb4928741********
Description	string	API 描述信息	API描述信息
GroupName	string	API 所属的分组名称	myGroup2
GroupId	string	API 分组编号	5f51f89261854fd9ad5116be********
Path	string	API 的请求路径	/mqTest
Method	string	API 的请求 HTTP Method	GET
StageName	string	环境名称，可选值： RELEASE：线上 PRE：预发 TEST：测试	RELEASE
ApiName	string	API 名称	fhosQueryDayOfStock_V2
RegionId	string	API 所在地域 ID	cn-shanghai
StageAlias	string	环境别名	线上

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-03-21	OpenAPI 返回结构发生变更	查看变更详情