如果你已创建应用,你可以查询指定 AppId 对应应用的相关信息。你可以使用 ListApps 这个 OpenAPI 实现这一功能。
你可以调用 ListApps 这个 OpenAPI 获取当前账号已创建的 App 的相关信息:
如果传递了参数 AppId,则查询该 AppId 的信息(仅支持传单个 AppId);
如果未传递参数 AppId,则查询当前账户下的所有 AppId 的信息。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
QPS 不得超过 20。
使用 POST 方式发起请求。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListApps | 接口名称 |
| Version | String | 是 | 2020-12-01 | OpenAPI 版本 |
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | String | 否 | Your_AppId | 已创建的应用的 ID |
| Reverse | Int32 | 否 | 1 | |
| Offset | String | 否 | 50 | |
| Limit | String | 否 | 100 | 返回条目数的上限,默认为 50,最大为 100 |
https://rtc.volcengineapi.com?Action=ListApps&Version=2020-12-01
postscript{
// 以下均为可选参数
"AppId": "Your_AppId",
"Reverse": "Your_Reverse",
"Offset": "Your_Offset",
"Limit": "Your_Limit"
}
json返回结果参看 BaseResponse。
其中 Result 的结构如下:
| 参数名 | 类型 | 描述 |
|---|---|---|
| Total | Int | 当前条件查询到的 App 数量 |
| Offset | Int | 偏移量,单位为条 |
| Limit | Int | 返回条目数的限制 |
| Applist | Array of App | 见下表 |
| 参数名 | 类型 | 描述 |
|---|---|---|
| AppId | String | 应用 ID |
| AppName | String | 应用名称 |
| CreatedAt | String | 创建时间 |
| Status | Int | 0: 创建中——指 AppID 在初始化1: 运行中——指当前 AppID 为正常服务状态6: 欠费关停98: 已停用——指调用服务端停用接口,当前 AppID 被设置为不可用状态 |
| AppKey | String | 主 AppKey,用于生成 Token |
| SecondaryAppKey | String | 副 AppKey,启用后可用于生成 Token |
查询的指定 AppId 的信息在
Result中显示。
{
"ResponseMetadata": {
"RequestId": "2021081717484101022524310002120A9F",
"Action": "ListApps",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"AppList": [
{
"AppId": "600000000000000000000000",
"AppName": "myApp",
"CreateAt": "",
"Status": 1,
"AppKey": "a00000000000000000000000000000000",
"SecondaryAppKey": "b00000000000000000000000000000000",
},
{
...
}
],
"Limit": "",
"Offset": "",
"Total": ""
}
}
json