- 文档首页
实时音视频
实时音视频
服务端 API 参考
应用管理
查询应用 ListApps
查询应用 ListApps
本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本。 调用 ListApps 接口,查询当前账号下的单个或所有应用的详细信息,包括应用 ID、名称、状态及密钥等。
注意事项
- 该接口请求接入地址仅支持 rtc.volcengineapi.com。
请求说明
- 请求地址:https://rtc.volcengineapi.com?Action=ListApps&Version=2023-11-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。 Action String 必选 示例值:ListApps
接口名称。当前 API 的名称为 ListApps。
Version String 必选 示例值:2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
AppId String 可选 示例值:66****3cf
应用的 ID。不填则查询当前账户下的所有 AppId 的信息。
Reverse Integer 可选 示例值:1
信息返回顺序:
Offset String 可选 示例值:50
分页偏移量,单位为条,表示从第几条数据开始返回。
如果需要查询大量数据,可设置该参数和 Limit 实现分页查询。
Limit String 可选 示例值:100
设置单次查询返回的数据量,默认为 50,最大为 100。
ProjectName String 可选 示例值:default
项目名称,接口只返回传入项目包含的应用。
返回参数
下表仅列出本接口特有的返回参数。公共返回参数请参见返回结构。 AppList Object[] 示例值:-
应用详细信息。
AppId String 示例值:661e****543cf
应用 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 示例值:AKLTMzV****NDcyNjU
主 AppKey,可用于生成 Token。
SecondaryAppKey String 示例值:AKLTMzV****NDcyNda
副 AppKey,启用后可用于生成 Token。
Limit Integer 示例值:100
每页返回条目数。
Offset Integer 示例值:50
分页偏移量,单位为条。表示从第几条数据开始返回。
Total Integer 示例值:20
当前条件查询到的 App 数量。
请求示例
返回示例
错误码
最近更新时间:2026.03.13 10:26:40