ListWebSDKDomainConfigs - 获取 Web SDK 域名配置列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

ListWebSDKDomainConfigs - 获取 Web SDK 域名配置列表

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

调用 ListWebSDKDomainConfigs接口，获取 Web SDK 域名配置列表。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListWebSDKDomainConfigs`	接口名称。当前 API 的名称为 `ListWebSDKDomainConfigs`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
Domain	String	否	`*.test.com`	按域名 URL 筛选。不包含协议头。例如 `www.example.com` 或泛域名 `*.example.com`。支持模糊搜索。
PageNumber	Integer	否	`1`	分页查询页码。默认值为 `1`。取值大于等于 1。
PageSize	Integer	否	`10`	分页查询数量。默认值为 `10`。取值范围为 [1,500]。
Status	Integer	否	`1`	按域名配置状态筛选。默认值为`0`。取值如下： `0`：全部状态 `1`：配置中，即已添加 Web SDK 域名配置，但域名尚未加入白名单。 `2`：已生效，即域名已加入白名单。 `3`：已失效，即域名白名单已过期或出现异常。

返回参数

参数	类型	示例值	描述
DomainConfigs	Array of DomainConfigs	`-`	域名配置列表。
TotalCount	Long	`20`	域名配置总数。

DomainConfigs

参数	类型	示例值	描述
Domain	String	`bytecadwa.edaw.com`	域名 URL，不包含协议头。
Status	Integer	`1`	域名配置状态。取值如下： `1`：配置中，即已添加 Web SDK 域名配置，但域名尚未加入白名单。 `2`：已生效，即域名已加入白名单。 `3`：已失效，即域名白名单已过期或出现异常。
CreateTime	Long	`1753156192`	域名配置的创建时间。 Unix 时间戳，单位为秒。
UpdateTime	Long	`1753156806`	域名配置的最后更新时间。Unix 时间戳，单位为秒。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListWebSDKDomainConfigs&Version=2023-08-01&Domain=*.test.com&PageNumber=1&PageSize=10&Status=1

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListWebSDKDomainConfigs",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "DomainConfigs": [
            {
                "Domain": "bytecadwa.edaw.com",
                "Status": 1,
                "CreateTime": 1753156192,
                "UpdateTime": 1753156806
            }
        ],
        "TotalCount": 20
    }
}

错误码

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