AddWebSDKDomain - 新增 Web SDK 域名配置--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

AddWebSDKDomain - 新增 Web SDK 域名配置

最近更新时间：2025.08.01 17:51:19首次发布时间：2025.08.01 17:51:19

调用 AddWebSDKDomain接口，新增 Web SDK 域名配置，将您使用的域名 URL 加入白名单，从而保证 Web 观播 SDK 的正常使用。

注意事项

请求频率：单用户请求频率限制为 1 次/秒。
前提条件：确保您拥有火山引擎主账号或具备超管角色的子账号。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=AddWebSDKDomain&Version=2023-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Domain	String	是	`*.test.com`	需要加入白名单的域名 URL，不包含协议头。例如 `www.example.com` 或泛域名 `*.example.com`。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	域名配置是否新增成功。成功返回 `true`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=AddWebSDKDomain&Version=2023-08-01
{
    "Domain": "*.test.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "AddWebSDKDomain",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

访问公共错误码和错误码获取详细信息。