创建应用 CreateApp--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

创建应用 CreateApp

最近更新时间：2024.02.29 19:30:22首次发布时间：2021.09.10 09:58:01

你可以在控制台上管理 AppID，也可以通过 OpenAPI 实现应用管理。你可以使用 CreateApp 这个 OpenAPI 实现这一功能。

使用说明

接口行为

你可以使用 CreateApp 接口，创建 AppID。
使用此接口创建 AppID 的效果和在控制台上手动创建一致。关于手动获取 AppID，参看：获取 AppID。

在你使用该接口创建应用后，应用默认为启用状态。

前置条件

你必须已在控制台上开通了 RTC 服务，完成实名认证，并确定了计费类型。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

请求频率：QPS 不超过 20。
AppID 数量：单个账号最多可以创建 100 个 AppID。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=CreateApp&Version=2020-12-01

请求参数

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

Query

参数名称	数据类型	是否必选	示例值	描述
Action	String	是	`CreateApp`	接口名称。当前 API 的名称为 `CreateApp`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppName	String	是	`myApp`	应用名称命名规则：字符串中只能包含中文字符、英文大小写字符、数字和下划线；长度不能超过24个字符。

返回参数

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

参数	类型	示例值	描述
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`	服务状态。枚举值为： `0`: 创建中——指 AppID 在初始化 `1`: 运行中——指当前 AppID 为正常服务状态 `6`: 欠费关停 `98`: 已停用——指调用服务端停用接口，当前 AppID 被设置为不可用状态
CreateDate	String	`2021-08-17T17:48:41.973243689+08:00`	创建时间
InstanceId	String	`Your_InstanceId`	计费实例 ID

请求示例

POST https://rtc.volcengineapi.com?Action=CreateApp&Version=2020-12-01
{
    "AppName": "Your_AppName"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "CreateApp",
        "Version": "2020-12-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"
    }
}

错误码

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