ListAppInfo - 获取应用信息列表

调用本接口根据查询条件获取有权限的应用信息列表。

接口说明

使用说明

支持按应用状态过滤查询。

QPS 限制

本接口的单用户 QPS 限制为 30 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

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

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

请求参数

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

应用状态,可查询指定状态的应用。应用创建后默认为 Normal,取值范围:

  • Normal(正常)
  • Disable(停用)
Normal
PageNointeger

页码。默认值为 1

1
PageSizeinteger

每页返回的数据条数。默认值为 10,最大值为 100

10
ResourceGroupIdstring

资源组 ID。

rg-aekzko7fsuj****

返回参数

名称类型描述示例值
object

返回结果。

Totalinteger

总条目。

10
RequestIdstring

请求 ID。

25818875-5F78-4A13-4D5C-D7393642****
AppInfoListarray<object>

应用信息列表。

AppInfoobject

应用信息详情。

Typestring

应用类型。取值范围:

  • System(系统默认)
  • Custom(用户创建)
System
Statusstring

应用状态。取值范围:

  • Normal(正常)
  • Disable(停用)
Normal
CreationTimestring

UTC 创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-03-01T08:00:00Z
AppNamestring

应用名称。

test
Descriptionstring

应用描述。

my first app.
AppIdstring

应用 ID。

app-****
ModificationTimestring

UTC 更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-03-01T09:00:00Z
RegionIdstring

地域。

cn-shanghai
ResourceGroupIdstring

资源组 ID。

rg-aekzko7fsuj****

示例

正常返回示例

JSON格式

{
  "Total": 10,
  "RequestId": "25818875-5F78-4A13-4D5C-D7393642****",
  "AppInfoList": [
    {
      "Type": "System",
      "Status": "Normal",
      "CreationTime": "2019-03-01T08:00:00Z",
      "AppName": "test",
      "Description": "my first app.",
      "AppId": "app-****",
      "ModificationTime": "2019-03-01T09:00:00Z",
      "RegionId": "cn-shanghai",
      "ResourceGroupId": "rg-aekzko7fsuj****"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-02OpenAPI 返回结构发生变更查看变更详情
2024-07-31OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情

接口错误码

下表列举了本接口特有的错误码。

错误代码错误信息HTTP 状态码说明
OperationDenied.NotOpenAppServiceThe app service is not open.403多应用服务未开通。