文档

DescribeAppAttributes - 查询APP列表信息

更新时间:

查询APP列表及基本信息。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

App 的编号

20112314518278
AppNamestring

APP 名称

testApp
PageNumberinteger

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

1
PageSizeinteger

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

10
AppCodestring

应用的 APPCode 编码

23552160
AppKeystring

App 的 Key,用于调用 API 时使用

203708622
Sortstring

排序,默认值是 desc,可选 asc,desc

  • asc:按修改时间升序排列;
  • desc:按修改时间降序排列
desc
EnableTagAuthboolean

是否启用标签验证

true
Tagarray<object>

指定规则所适用的对象标签,可设置多个。

Key, Value
object

指定规则所适用的对象标签,可设置多个。

Keystring

标签值。

n 的取值范围为 [1, 20]

env
Valuestring

标签键。

n 的取值范围为 [1, 20]

' '
Extendstring

扩展信息

110243810311

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求 ID

8883AC74-259D-4C0B-99FC-0B7F9A588B2F
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

1
Appsarray<object>

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

AppAttributeobject
AppNamestring

APP 名称

CreateApptest
ModifiedTimestring

修改时间(格林威治时间)

2016-07-31T04:10:19Z
Descriptionstring

APP 描述信息

App test
CreatedTimestring

创建时间(格林威治时间)

2016-07-31T04:10:19Z
AppIdlong

APP 编号

20112314518278
Extendstring

扩展信息

110461946884
Tagsarray<object>

标签列表

TagInfoobject
Keystring

标签键

appid
Valuestring

标签值

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",
        "Tags": {
          "TagInfo": [
            {
              "Key": "appid",
              "Value": "123"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-28OpenAPI 描述信息更新、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情