文档

DescribeApps - 查询应用列表

更新时间:

调用DescribeApps查询应用列表。

接口说明

使用说明

本接口用于查询应用列表。例如:在查询列表中您可以获取应用 ID、应用名称、应用类型等数据。

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

应用 ID,通过控制台创建和查询,仅支持传单个 ID。

参数为空表示查询所有应用 ID。

yourAppId
Statusstring

应用状态,参数为空表示查询所有状态。取值:

  • 1:可用。

  • 2:停用。

  • 3:欠费停用。

1
Orderstring

排序方式。取值:

  • asc:递增。

  • desc(默认值):递减。

asc
PageNuminteger

第几页,默认查询第 1 页。

1
PageSizeinteger

每页显示个数,默认为 10

2

返回参数

名称类型描述示例值
object
TotalPageinteger

返回分页数。

1
RequestIdstring

请求 id。

231470C1-ACFB-4C9F-844F-4CFE1E3804C6
TotalNuminteger

返回结果数。

1
AppListobject []

应用列表。

Statusinteger

应用状态。取值:

  • 1:可用。

  • 2:停用。

  • 3:欠费停用。

1
AppNamestring

应用名称。

Default AppName
AppIdstring

应用 ID。

rgf1****"
CreateTimestring

创建时间

2020-01-09T02:02:29Z
BillTypestring

计费类型。

PayByCR
AppTypestring

应用类型。取值:

  • conference:会议。

  • universal:通用型。

universal
ServiceAreasarray

服务区域:CN(中国)。

string

服务区域:CN(中国)。

CN
Versionstring

版本。

3.0

示例

正常返回示例

JSON格式

{
  "TotalPage": 1,
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C6",
  "TotalNum": 1,
  "AppList": {
    "App": [
      {
        "Status": 1,
        "AppName": "Default AppName",
        "AppId": "rgf1****\"",
        "CreateTime": "2020-01-09T02:02:29Z",
        "BillType": "PayByCR",
        "AppType": "universal",
        "ServiceAreas": {
          "ServiceArea": [
            "CN"
          ]
        },
        "Version": "3.0"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
404InvalidAppId.NotFound%s
500InternalError%s

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

变更历史

变更时间变更内容概要操作
2024-01-31OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2024-01-31OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更