开发者社区 问答 正文

如何查询 API 的应用授权列表(DescribeAuthorizedApps)?



查询 API 的应用授权列表(DescribeAuthorizedApps)



描述


用于查询当前可访问API的应用(app)列表

  • 此功能面向API提供者
  • 查询当前可访问指定API的应用应用(app)列表
  • 查询结果返回的所有应用(app)均可访问指定的API


请求参数


名称类型是否必须描述
ActionString接口名称,系统规定参数,取值:DescribeAuthorizedApps
GroupIdStringAPI分组 ID,系统生成,全局唯一
ApiIdStringAPI编号,系统生成,全局唯一
StageNameString环境名称,取值为:
  • RELEASE: 线上
  • TEST: 测试
PageNumberInteger指定要查询的页码,默认是1,起始是1
PageSizeInteger指定分页查询时每页行数,最大值100,默认值为10


返回参数


名称类型描述
RequestIdString请求唯一标识
TotalCountInteger返回结果的总条数
PageNumberInteger返回指定的页码
PageSizeInteger返回指定的每页条数
AuthorizedAppsAuthorizedApp返回分组集合


示例



请求示例





展开
收起
轩墨 2017-10-26 14:40:33 1768 分享 版权
阿里云 AI 助理回答

查询 API 的应用授权列表(DescribeAuthorizedApps)功能允许API提供者获取当前能够访问指定API的所有应用程序(APP)列表。以下是该操作的详细说明:

功能描述

此API主要服务于API提供者,帮助他们了解哪些应用已经获得了访问特定API的权限。通过调用DescribeAuthorizedApps接口,用户可以获取到一个包含所有授权应用的列表,这些应用均具备访问指定API的能力。

请求参数

  • Action: 必填,字符串类型,固定值为DescribeAuthorizedApps,表示要执行的操作。
  • GroupId: 必填,字符串类型,指定了API所属的分组ID,这是系统生成的全局唯一标识。
  • ApiId: 必填,字符串类型,代表目标API的编号,也是系统生成的全局唯一值。
  • StageName: 可选,字符串类型,指定查询API的环境阶段,可选值包括RELEASE(线上)、TEST(测试)等。
  • PageNumber: 可选,整型,用于指定查询结果的页码,默认为1。
  • PageSize: 可选,整型,定义每页返回的结果数量,最大限制为100,默认为10。

返回参数

  • RequestId: 字符串类型,请求的唯一标识符。
  • TotalCount: 整型,返回结果的总条数。
  • PageNumber: 整型,返回的当前页码。
  • PageSize: 整型,每页实际返回的条目数量。
  • AuthorizedApps: 对象数组,包含了每个授权应用的详细信息,如应用名称(AppName)、授权来源(AuthorizationSource)、授权有效时间(AuthVaildTime)等。

示例

具体的请求示例和响应结构请参考给出的知识库资料中的示例部分。其中展示了如何构造请求以及成功响应中包含的数据格式。

注意事项

  • 确保提供的GroupIdApiId是有效的,并且你有权限查询这些资源。
  • 调用时注意分页参数的合理设置,以避免数据量过大导致的性能问题。
  • 请注意API调用频率限制,避免因频繁调用而触发限流策略。

通过上述说明,您可以根据具体需求调用DescribeAuthorizedApps接口来获取API的授权应用列表。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答
问答分类:
问答地址: