你可以在控制台上管理 AppID,也可以通过 OpenAPI 实现应用管理。你可以使用 CreateApp 这个 OpenAPI 实现这一功能。
你可以使用 CreateApp 接口,创建 AppID。
使用此接口创建 AppID 的效果和在控制台上手动创建一致。关于手动获取 AppID,参看:获取 AppID。
在你使用该接口创建应用后,应用默认为启用状态。
你必须已在控制台上开通了 RTC 服务,完成实名认证,并确定了计费类型。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数名称 | 数据类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | CreateApp | 接口名称。当前 API 的名称为 CreateApp。 |
Version | String | 是 | 2023-11-01 | 接口版本。当前 API 的版本为 2023-11-01。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
AppName | String | 是 | myApp |
|
下表仅列出本接口特有的返回参数。公共返回参数请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
AppId | String | Your_AppId | 应用 ID |
AppKey | String | Your_AppKey | 主 AppKey,用于生成 Token |
SecondaryAppKey | String | Your_SecondaryAppKey | 副 AppKey,启用后可用于生成 Token |
Name | String | myApp | 应用名称 |
Owner | String | Your_Owner | 应用所属的账号 ID |
InstanceStatus | Integer | 1 |
|
CreateDate | String | 2021-08-17T17:48:41.973243689+08:00 | 创建时间 |
InstanceId | String | Your_InstanceId | 计费实例 ID |
POST https://rtc.volcengineapi.com?Action=CreateApp&Version=2023-11-01
{
"AppName": "Your_AppName"
}
json{
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "CreateApp",
"Version": "2023-11-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"AppId": "Your_AppId",
"AppKey": "Your_AppKey",
"SecondaryAppKey":"Your_SecondaryAppKey",
"Name": "myApp",
"Owner": "Your_Owner",
"InstanceStatus": 1,
"CreateDate": "2021-08-17T17:48:41.973243689+08:00",
"InstanceId": "Your_InstanceId"
}
}
json您可访问公共错误码,获取更多错误码信息。