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

文档中心

立即注册

导航

获取工区列表

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

调用 ListOfficeConfig 接口，获取内网加速配置中的工区列表，包括工区 ID、负载均衡策略、可选清晰度等信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListOfficeConfig`	接口名称。当前 API 的名称为 `ListOfficeConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
PageNumber	Integer	否	`1`	分页查询页码。默认值为 `1`。取值大于等于 1。
PageSize	Integer	否	`10`	分页查询数量。默认值为 `10`。取值范围为 [1,500]。
AreaId	String	否	`srg123`	区域 ID。长度为 1 到 100 个字符，英文大小写不敏感。该参数用于获取指定区域内的所有工区。例如，当参数值为 `srg123` 时，返回 ID 为 `srg123`、`Srg123`等区域内的所有工区。您可通过调用 ListAreaConfig 接口获取 ID。
OfficeName	String	否	`A`	工区名称。长度为 1 到 100 个字符。支持模糊搜索，英文大小写不敏感。例如，当参数值为 `A` 时，返回`工区 A`、`工区 abc` 等名称的工区。
OfficeId	String	否	`z123`	工区 ID。长度为 1 到 100 个字符。支持模糊搜索，英文大小写不敏感。例如，当参数值为 `z123` 时，返回 `Z123`、`z1234` 等 ID 的工区。您可以在调用 CreateOfficeConfig 接口新增工区时获取工区 ID。
OfficeStatus	String	否	`Enable`	工区状态。默认获取所有状态的工区。取值如下： `Enable`：已启用。该状态下工区配置正常生效 `Disable`：已关闭。该状态下工区配置不生效 `Testing`：测试中 `NotDeployed`：未部署

返回参数

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

Offices

参数	类型	示例值	描述
AreaId	String	`srg123`	工区所属区域的 ID。
OfficeId	String	`z123`	工区 ID。
OfficeName	String	`北京海淀 A`	工区名称。
CreateTime	Long	`1733738464`	创建时间。Unix 时间戳，单位为秒。
OfficeIp	Object of OfficeIp	`-`	工区的内网地址。
LBStrategy	String	`Default`	负载均衡策略。取值如下： `Default`：工区内发出的请求指向一台默认的后端服务器，即不使用负载均衡策略 `Weight`：工区内发出的请求按照一定的时间顺序分配至多台后端服务器进行处理。如果某一后端服务器因异常而停止运行，则系统会自动剔除该服务器，由其他服务器继续使用轮询模式保证负载均衡
EnableExtranetUrl	Boolean	`true`	是否允许外网拉流。取值如下： `true`：允许。当内网节点发生故障时，当前工区内的用户可以从外网拉流。该方式可能造成出口带宽被占满进而影响办公网络。因此您在允许外网拉流之前，需要结合工区的实际情况评估出口带宽和观看人数 `false`：不允许。如果内网节点发生故障，则可能导致当前工区内的用户无法观看直播
OfficeStatus	String	`Enable`	工区状态。取值如下： `Enable`：已启用。该状态下工区配置正常生效 `Disable`：已关闭。该状态下工区配置不生效 `Testing`：测试中 `NotDeployed`：未部署
RecommendedSize	String	`sd`	智能线路的起始清晰度，即工区观看的默认清晰度。取值如下： `bd`：蓝光 `uhd`：超清 `hd`：高清 `sd`：标清 `origin`：原画
AllowedSize	Array of String	`["sd","hd"]`	工区观看的可选清晰度。观众仅可在该范围内切换清晰度。清晰度越高，对网络环境要求越高。取值如下： `origin`：原画 `bd`：蓝光 `uhd`：超清 `hd`：高清 `sd`：标清 `auto`：智能

OfficeIp

参数	类型	示例值	描述
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.22"]`	内网 IP。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListOfficeConfig&Version=2023-08-01&PageNumber=1&PageSize=10&AreaId=srg123&OfficeName=A&OfficeId=z123&OfficeStatus=Enable

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListOfficeConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "TotalCount": 1,
        "Offices": {
            "CreateTime": 1733738464,
            "EnableExtranetUrl": true,
            "OfficeId": "z123",
            "OfficeName": "北京海淀 A",
            "OfficeIp": {
                "NetworkSegment": [
                    "123.12.23.21/24",
                    "123.12.23.21/26"
                ],
                "Ip": [
                    "123.12.23.21",
                    "123.12.23.22"
                ]
            },
            "AreaId": "srg123",
            "OfficeStatus": "Enable",
            "RecommendedSize": "sd",
            "AllowedSize": [
                "sd",
                "hd"
            ],
            "LBStrategy": "Default"
        }
    }
}

错误码

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