首页 API 网关 开发指南 API参考指南 API目录 应用 DescribeAuthorizedApps - 查询可访问APP列表

DescribeAuthorizedApps - 查询可访问APP列表

查询当前的应用(APP)列表。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeAuthorizedAppsRead
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

名称类型必填描述示例值
GroupIdstring

API分组ID,系统生成,全局唯一

523e8dc7bbe04613b5b1d726c2a7889d
StageNamestring

环境名称,取值为:

  • RELEASE:线上
  • TEST:测试
RELEASE
ApiIdstring

API编号,系统生成,全局唯一

baacc592e63a4cb6a41920d9d3f91f38
PageNumberinteger

指定要查询的页码,默认是1,起始是1

1
PageSizeinteger

指定分页查询时每页行数,最大值100,默认值为10

10
AppIdlong

App编号

20112314518278
AppNamestring

App名称

CreateApptest
AppOwnerIdlong

App拥有者的阿里云账号ID

1546564

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求ID

D6E46F10-F26C-4AA0-BB69-FE2743D9AE62
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

2
AuthorizedAppsarray

返回分组集合

object
AppNamestring

应用名称

天气
AuthorizationSourcestring

授权来源,取值:

  • CONSOLE:控制台
  • API:API
CONSOLE
AuthVaildTimestring

应用名称

2018-10-05T16:00:00Z
Descriptionstring

授权说明

根据地区名称查询天气情况
AuthorizedTimestring

授权操作的时间,格林威治时间

2016-07-21T06:17:20Z
AppIdlong

编号,系统生成,全局唯一

2386789
StageNamestring

环境名称,取值:

  • RELEASE
  • TEST
RELEASE
Operatorstring

授权的人,取值:

  • PROVIDER:API所有者
  • CONSUMER:API调用者
PROVIDER

示例

正常返回示例

JSON格式

{
    "TotalCount": "2",
    "PageNumber": "1",
    "PageSize": "10",
    "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
    "AuthorizedApps": {
    "AuthorizedApp": [
        {
        "StageName": "RELEASE",
        "AppId": 2386789,
        "AppName": "天气app",
        "Operator": "PROVIDER",
        "AuthorizationSource": "CONSOLE",
        "Description": "根据地区名称查询天气情况",
        "AuthorizedTime": "2016-07-21T06:17:20Z",
        "AuthVaildTime " : "2018-10-05T16:00:00Z"
        },
        {
        "StageName": "TEST",
        "AppId": 2386789,
        "AppName": "天气app",
        "Operator": "CONSUMER",
        "AuthorizationSource": "API",
        "Description": "根据地区名称查询天气情况",
        "AuthorizedTime": "2016-07-21T06:17:20Z",
        "AuthVaildTime " : ""
        }
    ]
    }
}

XML格式

<DescribeAuthorizedAppsResponse>
    <TotalCount>2</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>
    <AuthorizedApps>
        <AuthorizedApp>
            <StageName>RELEASE</StageName>
            <AppId>2386789</AppId>
            <AppName>天气app</AppName>
            <Operator>PROVIDER</Operator>
            <AuthorizationSource>CONSOLE</AuthorizationSource>
            <Description>根据地区名称查询天气情况</Description>
            <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
            <AuthVaildTime>2018-10-05T16:00:00Z</AuthVaildTime> 
        </AuthorizedApp>
        <AuthorizedApp>
            <StageName>TEST</StageName>
            <AppId>2386789</AppId>
            <AppName>天气app</AppName>
            <Operator>CONSUMER</Operator>
            <AuthorizationSource>API</AuthorizationSource>
            <Description>根据地区名称查询天气情况</Description>
            <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
            <AuthVaildTime></AuthVaildTime>
        </AuthorizedApp>
    </AuthorizedApps>    
</DescribeAuthorizedAppsResponse>

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 API 网关 相关技术圈