你可以在控制台上管理 AppID,也可以通过 OpenAPI 实现应用管理。你可以使用 CreateApp 这个 OpenAPI 实现这一功能。
你可以使用 CreateApp 接口,创建 AppID。
使用此接口创建 AppID 的效果和在控制台上手动创建一致。关于手动获取 AppID,参看:获取 AppID。
在你使用该接口创建应用后,应用默认为启用状态。
你必须已在控制台上开通了 RTC 服务,完成实名认证,并确定了计费类型。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
使用 POST 方式发起请求。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateApp | 接口名称 |
| Version | String | 是 | 2020-12-01 | OpenAPI 版本 |
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| AppName | String | 是 | myApp |
https://rtc.volcengineapi.com?Action=CreateApp&Version=2020-12-01
postscript{
"AppName": "Your_AppName"
}
json返回结果参看 BaseResponse。
其中 Result 的结构如下:
| 参数名 | 类型 | 描述 |
|---|---|---|
| AppId | String | 应用 ID |
| AppKey | String | 主 AppKey,用于生成 Token |
| SecondaryAppKey | String | 副 AppKey,启用后可用于生成 Token |
| Name | String | 应用名称 |
| Owner | String | 应用所属的账号 ID |
| InstanceStatus | Int | 0: 创建中——指 AppID 在初始化1: 运行中——指当前 AppID 为正常服务状态6: 欠费关停98: 已停用——指调用服务端停用接口,当前 AppID 被设置为不可用状态 |
| CreateDate | String | 创建时间 |
| InstanceId | String | 计费实例 ID |
创建的 app 信息在
Result中显示。
{
"ResponseMetadata": {
"RequestId": "2021081717484101022524310002120A9F",
"Action": "CreateApp",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"AppId": "6000000000000000000000000",
"AppKey": "a0000000000000000000000000000000",
"SecondaryAppKey":"b0000000000000000000000000000000",
"Name": "myApp",
"Owner": "2000000000",
"InstanceStatus": 1,
"CreateDate": "2021-08-17T17:48:41.973243689+08:00",
"InstanceId": "VeRTC0000000000000000000"
}
}
json