调用DescribeApisByBackend根据后端查询API列表_API 网关(API Gateway)-阿里云帮助中心

查询使用该后端服务创建的草稿态API，或已发布在某个环境上的API。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
BackendId	string	是	后端服务 ID	4ac69b7a17524781b275ed4c5eb25c54
StageName	string	否	指定要查询 API 的环境 RELEASE: 线上 PRE: 预发 TEST: 测试不填写查询的是草稿态 API	PRE
PageSize	integer	否	分页参数：每页显示条数。	10
PageNumber	integer	否	分页参数：当前页码。	1

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	分页参数：当前页码。	1
RequestId	string	请求 ID	CEB6EC62-B6C7-5082-A45A-45A204724AC2
PageSize	integer	分页参数：每页显示条数。	10
TotalCount	integer	总条数。	1
ApiInfoList	array<object>	返回的 API 列表信息
ApiInfo	object
ApiId	string	API 的 ID	20bcdc9453524b78a8beb1f6de21edb7
Description	string	API 的描述信息	test
GroupName	string	api 分组名称	testApiGroup
GroupId	string	api 分组 ID	15bcdc9453524b7gs8beb1f6de21edb7
Path	string	API 的请求路径	/test
Method	string	API 的请求方法	GET
ApiName	string	API 名称	testApi

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEB6EC62-B6C7-5082-A45A-45A204724AC2",
  "PageSize": 10,
  "TotalCount": 1,
  "ApiInfoList": {
    "ApiInfo": [
      {
        "ApiId": "20bcdc9453524b78a8beb1f6de21edb7",
        "Description": "test",
        "GroupName": "testApiGroup",
        "GroupId": "15bcdc9453524b7gs8beb1f6de21edb7",
        "Path": "/test",
        "Method": "GET",
        "ApiName": "testApi"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史