DescribeApps - 查询应用信息

查询已经创建的应用信息。

调试

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

授权信息

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

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

请求参数

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

应用 ID 列表。

string

应用 ID。

1234
AppNamestring

应用名称。

应用名称
Statusstring

应用状态。

枚举值:
  • FAILED创建失败
  • NORMAL正常
  • CREATING创建中
NORMAL
InstallationStatusstring

应用的安装/卸载状态。

枚举值:
  • INSTALLFAILED安装失败
  • UNINSTALLING卸载中
  • INSTALLING安装中
  • UNINSTALLED卸载完成
  • INSTALLED安装完成
  • UNINSTALLFAILED卸载失败
INSTALLING
MaxResultsinteger

分页查询时每页的最大条目数。取值范围 1~100,默认值为 10。

10
NextTokenstring

用来表示当前开始读取的位置。置空表示从头开始。

AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

CB95E410-FD1D-53C5-9F7D-93CC44D7****
TotalCountstring

总条目数。

10
NextTokenstring

用来表示当前调用返回读取到的位置。空代表数据已经读取完毕。

AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****
Dataarray<object>

返回结果对象。

appInfoModelobject
AppNamestring

应用名称。

testapp
AppIdinteger

应用 ID。

10404
AndroidAppVersionstring

应用版本。

1.0.0
IconUrlstring

应用图标地址。

https://test.png
InstanceGroupListarray

应用已经安装的实例组列表。

instanceGroupListstring

应用安装的实例组 ID。

ag-fasf****
GmtCreatestring

创建时间。

2022-08-11 17:45:03
GmtModifiedstring

最近一次修改时间。

2022-08-11 17:45:03
Descriptionstring

应用描述。

应用描述信息
Statusstring

应用状态。

枚举值:
  • FAILED创建失败
  • NORMAL正常
  • CREATING创建中
NORMAL
InstallationStatusstring

应用的安装/卸载状态。

枚举值:
  • INSTALLFAILED安装失败
  • UNINSTALLING卸载中
  • INSTALLING安装中
  • UNINSTALLED卸载完成
  • INSTALLED安装完成
  • UNINSTALLFAILED卸载失败
INSTALLING

示例

正常返回示例

JSON格式

{
  "RequestId": "CB95E410-FD1D-53C5-9F7D-93CC44D7****",
  "TotalCount": "10",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****",
  "Data": [
    {
      "AppName": "testapp",
      "AppId": 10404,
      "AndroidAppVersion": "1.0.0",
      "IconUrl": "https://test.png",
      "InstanceGroupList": [
        "ag-fasf****"
      ],
      "GmtCreate": "2022-08-11 17:45:03",
      "GmtModified": "2022-08-11 17:45:03",
      "Description": "应用描述信息",
      "Status": "NORMAL",
      "InstallationStatus": "INSTALLING",
      "BizRegionId": "",
      "PackageName": ""
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-10-16OpenAPI 返回结构发生变更查看变更详情
2024-06-26OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情