获取区域列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取区域列表

最近更新时间：2025.01.10 10:53:37首次发布时间：2025.01.10 10:53:37

调用 ListAreaConfig 接口，获取内网加速配置中的区域列表，包括区域名称、负载均衡策略、公网出口 IP 等信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListAreaConfig`	接口名称。当前 API 的名称为 `ListAreaConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
PageNumber	Integer	否	`1`	分页查询页码。默认值为 `1`。取值大于等于 1。
PageSize	Integer	否	`10`	分页查询数量。默认值为 `10`。取值范围为 [1,500]。
AreaName	String	否	`A`	区域名称。长度为 1 到 100 个字符。支持模糊搜索，英文大小写不敏感。例如，当参数值为 `A` 时，返回`区域 A`、`区域 abc` 等名称的区域。
AreaId	String	否	`srg123`	区域 ID。长度为 1 到 100 个字符。支持模糊搜索，英文大小写不敏感。例如，当参数值为 `srg123` 时，返回 `Srg123`、`srg1234` 等 ID 的区域。您可以在调用 CreateAreaConfig 接口新增区域时获取区域 ID。

返回参数

参数	类型	示例值	描述
Areas	Object of Areas	`-`	区域信息。
TotalCount	Integer	`1`	查询结果总数。

Areas

参数	类型	示例值	描述
AreaId	String	`srg123`	区域 ID。
AreaName	String	`北京 A`	区域名称。
CreateTime	Long	`1733738464`	创建时间。Unix 时间戳，单位为秒。
AreaIp	Object of AreaIp	`-`	区域的公网地址。
LBStrategy	String	`Default`	负载均衡策略。取值如下： `Default`：区域内发出的请求指向一台默认的后端服务器，即不使用负载均衡策略 `Weight`：区域内发出的请求按照一定的时间顺序分配至多台后端服务器进行处理。如果某一后端服务器因异常而停止运行，则系统会自动剔除该服务器，由其他服务器继续使用轮询模式保证负载均衡
EnableExtranetUrl	Boolean	`true`	是否允许外网拉流。取值如下： `true`：允许。当内网节点发生故障时，当前区域内的用户可以从外网拉流。该方式可能造成出口带宽被占满进而影响办公网络。因此您在允许外网拉流之前，需要结合工区的实际情况评估出口带宽和观看人数 `false`：不允许。如果内网节点发生故障，则可能导致当前区域内的用户无法观看直播
EnableStreamRouterList	Array of String	`["123.12.23.21", "123.12.23.22"]`	可用的路由 IP，即部署路由的机器 IP 地址。
EnableOfficeList	Array of String	`["z123","z234"]`	当前区域内已启用工区的 ID。

AreaIp

参数	类型	示例值	描述
NetworkSegment	Array of String	`["123.12.23.21/24","123.12.23.21/26"]`	公网网段。
Ip	Array of String	`["123.12.23.21","123.12.23.20"]`	公网出口 IP。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListAreaConfig&Version=2023-08-01&PageNumber=1&PageSize=10&AreaName=A&AreaId=srg123

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListAreaConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Areas": {
            "AreaId": "srg123",
            "AreaIp": {
                "NetworkSegment": [
                    "123.12.23.21/24",
                    "123.12.23.21/26"
                ],
                "Ip": [
                    "123.12.23.21",
                    "123.12.23.20"
                ]
            },
            "CreateTime": 1733738464,
            "EnableExtranetUrl": true,
            "EnableStreamRouterList": [
                "123.12.23.21",
                "123.12.23.22"
            ],
            "EnableOfficeList": [
                "z123",
                "z234"
            ],
            "AreaName": "北京 A",
            "LBStrategy": "Default"
        },
        "TotalCount": 1
    }
}

错误码

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