文档

ListApplications - 查询应用列表

更新时间:

列出创建的应用列表。

接口说明

本文将提供一个示例,查询当前账号下的应用列表。返回结果显示,当前账号下只有一个名为myapp的应用。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
当前API无需请求参数

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

CE458B58-8C40-46F7-A9D4-CB85136B0C06
Applicationsobject []

应用信息。

DisplayNamestring

应用的显示名称。

myapp
AccessTokenValidityinteger

访问令牌有效期。单位:秒。

3600
SecretRequiredboolean

是否需要应用密钥。

true
AccountIdstring

应用所属的阿里云账号 ID。

177242285274****
CreateDatestring

创建时间。

2020-10-23T09:33:22Z
AppNamestring

应用名称。

myapp
RedirectUrisarray

回调地址。

string

回调地址。

https://www.example.com
UpdateDatestring

更新时间。

2020-10-23T09:33:22Z
DelegatedScopeobject

应用权限范围信息。

PredefinedScopesobject []

应用权限范围信息。

Descriptionstring

范围描述。

用于获取用户的OpenID(默认权限范围,不可移除)
Namestring

范围名称。

openid
Requiredboolean

安装应用时,此权限范围是否默认必选。取值:

  • true:必选。
  • false:非必选。

其中openid默认为必选。

true
AppIdstring

应用 ID。

441442900344560****
RefreshTokenValidityinteger

刷新令牌有效期。单位:秒。

7776000
IsMultiTenantboolean

是否允许被其他账号安装。

true
AppTypestring

应用类型。取值:

  • WebApp:指基于浏览器交互的网络应用。
  • NativeApp:指操作系统中运行的本地应用,主要为运行在桌面操作系统或移动操作系统中的应用。
  • ServerApp:指直接访问阿里云服务,而无需依赖用户登录的应用,目前仅支持基于 SCIM 协议的用户同步应用。
WebApp

示例

正常返回示例

JSON格式

{
  "RequestId": "CE458B58-8C40-46F7-A9D4-CB85136B0C06",
  "Applications": {
    "Application": [
      {
        "DisplayName": "myapp",
        "AccessTokenValidity": 3600,
        "SecretRequired": true,
        "AccountId": "177242285274****",
        "CreateDate": "2020-10-23T09:33:22Z",
        "AppName": "myapp",
        "RedirectUris": {
          "RedirectUri": [
            "https://www.example.com"
          ]
        },
        "UpdateDate": "2020-10-23T09:33:22Z",
        "DelegatedScope": {
          "PredefinedScopes": {
            "PredefinedScope": [
              {
                "Description": "用于获取用户的OpenID(默认权限范围,不可移除)",
                "Name": "openid",
                "Required": true
              }
            ]
          }
        },
        "AppId": "441442900344560****",
        "RefreshTokenValidity": 7776000,
        "IsMultiTenant": true,
        "AppType": "WebApp"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-23OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)