文档

DescribeApps - 查询应用列表

更新时间:

查询应用列表,非APP拥有者会隐藏APP的信息。

接口说明

  • 此功能面向开放 API 的用户
  • API 开放者可通过 AppId 或者阿里云登录账号查询 app 信息,进而操作授权
  • 每个用户在每个 Region 每天调用次数上限为 200 次

调试

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

授权信息

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

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

请求参数

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

App 的唯一标识

20112314518278
AppOwnerlong

App 拥有者的阿里云账号 ID(账号 ID 请到账号管理页面查看)

1546564
PageNumberinteger

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

1
PageSizeinteger

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

10

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求 ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

1
Appsobject []

由 AppItem 组成的数组格式,返回 app 的信息

AppNamestring

APP 名称

CreateApptest
Descriptionstring

APP 描述信息

App test
AppIdlong

APP 编号

20112314518278

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "PageSize": 10,
  "TotalCount": 1,
  "Apps": {
    "AppItem": [
      {
        "AppName": "CreateApptest",
        "Description": "App test",
        "AppId": 20112314518278
      }
    ]
  }
}

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "PageSize": 10,
  "TotalCount": 1,
  "Apps": {
    "AppItem": [
      {
        "AppName": "CreateApptest",
        "Description": "App test",
        "AppId": 20112314518278
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈