使用DescribeAppAttributes API查询APP列表信息-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

查询APP列表及基本信息。

接口说明

此功能面向调用 API 的用户
AppId 可选择性传入

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:DescribeAppAttributes

get

*App

acs:apigateway:{#regionId}:{#accountId}:app/*

无

请求参数

名称	类型	必填	描述	示例值
AppId	integer	否	App 的编号	20112314518278
AppName	string	否	APP 名称	testApp
PageNumber	integer	否	指定要查询的页码，默认是 1，起始是 1	1
PageSize	integer	否	指定分页查询时每页行数，最大值 100，默认值为 10	10
AppCode	string	否	应用的 APPCode 编码	23552160
AppKey	string	否	App 的 Key，用于调用 API 时使用	203708622
Sort	string	否	排序，默认值是 desc，可选 asc，desc asc：按修改时间升序排列； desc：按修改时间降序排列	desc
EnableTagAuth	boolean	否	是否启用标签验证	true
Tag	array<object>	否	指定规则所适用的对象标签，可设置多个。	Key， Value
	object	否	指定规则所适用的对象标签，可设置多个。
Key	string	是	标签值。 n 的取值范围为 `[1, 20]`	env
Value	string	否	标签键。 n 的取值范围为 `[1, 20]`	' '
Extend	string	否	扩展信息	110243810311

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	返回指定的页码	1
RequestId	string	请求 ID	8883AC74-259D-4C0B-99FC-0B7F9A588B2F
PageSize	integer	返回指定的每页条数	10
TotalCount	integer	返回结果的总条数	1
Apps	object
AppAttribute	array<object>	由 AppAttribute 组成的数组格式，返回 app 的信息
	array<object>
AppName	string	APP 名称	CreateApptest
ModifiedTime	string	修改时间(格林威治时间)	2016-07-31T04:10:19Z
Description	string	APP 描述信息	App test
CreatedTime	string	创建时间(格林威治时间)	2016-07-31T04:10:19Z
AppId	integer	APP 编号	20112314518278
Extend	string	扩展信息	110461946884
Disabled	boolean
Tags	object
TagInfo	array<object>	标签列表
	object
Key	string	标签键	appid
Value	string	标签值	123

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "8883AC74-259D-4C0B-99FC-0B7F9A588B2F",
  "PageSize": 10,
  "TotalCount": 1,
  "Apps": {
    "AppAttribute": [
      {
        "AppName": "CreateApptest",
        "ModifiedTime": "2016-07-31T04:10:19Z",
        "Description": "App test",
        "CreatedTime": "2016-07-31T04:10:19Z",
        "AppId": 20112314518278,
        "Extend": "110461946884",
        "Disabled": true,
        "Tags": {
          "TagInfo": [
            {
              "Key": "appid",
              "Value": "123"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。