描述
查询定义中的API列表。
名称 | 类型 | 是否必须 | 描述 |
Action | String | 是 | 操作接口名,系统规定参数,取值:DescribeApis |
GroupId | String | 否 | 指定的分组编号 |
ApiId | String | 否 | 指定的API编号 |
ApiName | String | 否 | API名称(模糊匹配) |
CatalogId | String | 否 | 所在目录编号 |
PageSize | Integer | 否 | 指定分页查询时每页行数,最大值100,默认值为10 |
PageNumber | Integer | 否 | 指定要查询的页码,默认是1,起始是1 |
名称 | 类型 | 描述 |
RequestId | String | 本次请求编号 |
TotalCount | Integer | 返回结果的总条数 |
PageNumber | Integer | 返回指定的页码 |
PageSize | Integer | 返回指定的每页条数 |
ApiSummarys | ApiSummary | 由 ApiSummary 组成的数组格式,返回API的定义信息 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
查询定义中的API列表功能是为开放API用户设计的,旨在提供一个接口来检索所有正处于编辑状态的API定义列表及其概况信息。此操作与具体运行环境无关,展示的是API最新的编辑版本,可能与实际部署环境中运行的API有所差异。以下是该接口的详细说明:
DescribeApis
,表示要执行的操作接口名称。ApiSummary
对象组成的数组,每个对象包含如下字段:
PUBLIC
(公开)或PRIVATE
(私有)。具体的请求示例和响应结构请参考知识库中提供的文档资料,其中包含了如何构造请求以及预期的返回数据格式。
请注意,调用此接口前确保您拥有相应的权限,即apigateway:DescribeApis
操作的读取权限。此外,通过合理设置PageSize
和PageNumber
参数,可以有效管理和浏览大量API定义。