如果你已创建应用，你可以查询指定 AppId 对应应用的相关信息。你可以使用 ListApps 这个 OpenAPI 实现这一功能。

使用说明
接口行为

你可以调用 ListApps 这个 OpenAPI 获取当前账号已创建的 App 的相关信息：

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

注意事项

请求频率：QPS 不得超过 20。

请求说明
请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query
参数名称
数据类型
是否必选
示例值
描述
Action
String
是
ListApps
接口名称。当前 API 的名称为 ListApps。
Version
String
是
2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
Body
参数
类型
是否必选
示例值
描述
AppId
String
否
Your_AppId
已创建的应用的 ID
Reverse
Integer
否
1
  • 默认按照 App 创建时间升序返回；
  • 设置为 1 时，降序返回；
Offset
String
否
50
  • 偏移量，单位为条；
  • 因单次查询返回结果数量有限，如果需要大量查询，需要借助偏移量实现分页查询；
Limit
String
否
100
返回条目数的上限，默认为 50，最大为 100
ProjectName
String
否
default
传入项目名称，接口只返回传入项目包含的应用
返回参数

下表仅列出本接口特有的返回参数。公共返回参数请参见返回结构。

参数
类型
示例值
描述
AppList
Object[]
-
应用详细信息
AppId
String
Your_AppId
应用 ID
AppName
String
myApp
应用名称
CreateAt
String
2021-08-17T17:48:41.973243689+08:00
创建时间
Status
Integer
1
服务状态。枚举值为：
0: 创建中——指 AppID 在初始化
1: 运行中——指当前 AppID 为正常服务状态
6: 欠费关停
98: 已停用——指调用服务端停用接口，当前 AppID 被设置为不可用状态
AppKey
String
Your_AppKey
主 AppKey，用于生成 Token
SecondaryAppKey
String
Your_SecondaryAppKey
副 AppKey，启用后可用于生成 Token
Limit
Integer
100
返回条目数的限制
Offset
Integer
50
偏移量，单位为条
Total
Integer
20
当前条件查询到的 App 数量
请求示例 
POST https://rtc.volcengineapi.com?Action=ListApps&Version=2023-11-01
{
    // 以下均为可选参数
    "AppId": "Your_AppId",
    "Reverse": 1,
    "Offset": 50,
    "Limit": 100
}

json
返回示例 
{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "ListApps",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "AppList": [
            {
                "AppId": "Your_AppId",
                "AppName": "myApp",
                "CreateAt": "2021-08-17T17:48:41.973243689+08:00",
                "Status": 1,
                "AppKey": "Your_AppKey",
                "SecondaryAppKey": "Your_SecondaryAppKey"
            }
        ],
        "Limit": 100,
        "Offset": 50,
        "Total": 20
    }
}

json
错误码

您可访问公共错误码，获取更多错误码信息。