描述
查询已经发布到某指定环境中的API列表,即查询指定环境中正在运行的API列表。
名称 | 类型 | 是否必须 | 描述 |
Action | String | 是 | 操作接口名,系统规定参数,取值:DescribeDeployedApis |
GroupId | String | 否 | 指定的分组编号 |
StageName | String | 是 | 环境名称,可选值:
|
ApiId | String | 否 | 指定的API编号 |
ApiName | String | 否 | API名称(模糊匹配) |
PageSize | Integer | 否 | 指定分页查询时每页行数,最大值100,默认值为10 |
PageNumber | Integer | 否 | 指定要查询的页码,默认是1,起始是1 |
名称 | 类型 | 描述 |
RequestId | String | 本次请求编号 |
TotalCount | Integer | 返回结果的总条数 |
PageNumber | Integer | 返回指定的页码 |
PageSize | Integer | 返回指定的每页条数 |
DeployedApis | DeployedApiItem | 由 DeployedApiItem 组成的数组格式,返回API的信息 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
查询已发布到指定环境中的API列表功能,是专为开放API用户设计的,旨在帮助您获取正在特定环境中运行的所有API详情。此操作对于监控和管理您的API部署状态尤为关键。以下是该功能的详细说明:
Action: DescribeDeployedApis
类型: String
是否必须: 是
描述: 指定的操作接口名称,用于查询已发布的API列表。
GroupId:
类型: String
是否必须: 否
描述: 您可以指定API分组的编号来筛选结果。
StageName:
类型: String
是否必须: 是
可选值: RELEASE
(线上), TEST
(测试)
描述: 指定查询的环境名称。
ApiId:
类型: String
是否必须: 否
描述: 如果需要查询特定API,可以提供其编号。
ApiName:
类型: String
是否必须: 否
描述: 支持API名称的模糊匹配查询。
PageSize:
类型: Integer
是否必须: 否
默认值: 10
最大值: 100
描述: 分页查询时每页显示的API数量。
PageNumber:
类型: Integer
是否必须: 否
默认值: 1
描述: 指定查询的页码,起始页为1。
要执行此查询,您可以通过调用阿里云OpenAPI Explorer来直接运行DescribeDeployedApis
接口,无需手动计算签名,该工具还会自动生成相应的SDK代码示例供您参考。在调用时,请根据实际需求填写上述参数,比如指定环境名称(StageName
),以获取该环境下所有已部署API的列表。
请注意,为了成功调用此接口,确保您的RAM权限策略中包含了必要的授权信息,即允许执行apigateway:DescribeDeployedApis
操作。
通过以上步骤,您可以有效地管理和监控部署在指定环境中的API,进一步优化您的API管理流程。
参考文献: [1] DescribeDeployedApis - 查询已发布 API 列表