如何查询定义中的 API 列表？

查询定义中的API列表功能是为开放API用户设计的，旨在提供一个接口来检索所有正处于编辑状态的API定义列表及其概况信息。此操作与具体运行环境无关，展示的是API最新的编辑版本，可能与实际部署环境中运行的API有所差异。以下是该接口的详细说明：

请求参数

• Action: 必填，类型为String，固定值DescribeApis，表示要执行的操作接口名称。
• GroupId: 可选，类型为String，指定查询的API所属分组编号。
• ApiId: 可选，类型为String，指定查询的特定API编号。
• ApiName: 可选，类型为String，用于模糊匹配API名称。
• CatalogId: 可选，类型为String，指定API所在的目录编号。
• PageSize: 可选，类型为Integer，默认值为10，最大值100，指定每页返回的结果数量。
• PageNumber: 可选，类型为Integer，默认值为1，指定查询的页码起始位置。

返回参数

• RequestId: String类型，标识本次请求的唯一编号。
• TotalCount: Integer类型，返回查询结果的总条数。
• PageNumber: Integer类型，返回当前查询页码。
• PageSize: Integer类型，返回每页显示的条目数量。
• ApiSummarys: 由多个ApiSummary对象组成的数组，每个对象包含如下字段：
  • Visibility: API的可见性，可为PUBLIC（公开）或PRIVATE（私有）。
  • ApiId: API的唯一标识。
  • ModifiedTime: API最后修改的时间（格林威治时间）。
  • Description: API的描述信息。
  • GroupName: 所属API分组的名称。
  • GroupId: 所属API分组的编号。
  • CreatedTime: API创建时间（格林威治时间）。
  • ApiName: API的名称。
  • RegionId: API所在地域ID。
  • ApiPath: API的请求路径。
  • ApiMethod: API的HTTP请求方法。
  • DeployedInfos: 包含API在不同环境下的部署状态信息，如环境名称、已部署版本及部署状态等。
  • TagList: 标签信息列表，包括标签键和值。

示例

具体的请求示例和响应结构请参考知识库中提供的文档资料，其中包含了如何构造请求以及预期的返回数据格式。

请注意，调用此接口前确保您拥有相应的权限，即apigateway:DescribeApis操作的读取权限。此外，通过合理设置PageSize和PageNumber参数，可以有效管理和浏览大量API定义。