Miku 直播

    • Miku 直播 > API 文档 > 空间管理API >获取空间配置

    获取空间配置

    最近更新时间: 2025-11-20 22:45:20

    描述

    获取指定直播空间（Bucket）的配置信息。

    接口信息

    • 请求方法: GET
    • 请求地址: <bucket>.mls.cn-east-1.qiniumiku.com
    • 请求路径: /

    请求参数

    Query 参数

    参数名称 类型 必填 示例值 描述
    config string 是 config 配置

    Header 参数

    参数名称 类型 必填 示例值 描述
    Host string 是 <bucket>.mls.cn-east-1.qiniumiku.com 请求的服务域名
    Authorization string 是 <QiniuToken> 管理凭证 QiniuToken，生成规则

    请求示例

    GET /?config HTTP/1.1
Host: test.mls.cn-east-1.qiniumiku.com
Authorization: <QiniuToken>
Content-Type: application/json

{}

    返回响应

    响应状态码

    响应示例

    {
    "callbackEnable": false,
    "callbackUrl": "",
    "codec": null,
    "connectId": "YmgAAMhqlCThCXkY",
    "creationDate": "2019-01-01T00:00:00.000+08:00",
    "lastModified": "2019-01-01T00:00:00.000+08:00",
    "name": "test-bucket-name",
    "recording": {
        "enable": true,
        "objectBucket": "predem-bucket",
        "objectZone": "z0",
        "expireDays": 60,
        "segmentDuration": 0,
        "snapshot": {
            "enable": false,
            "notifyUrl": "",
            "pipeline": "",
            "bucket": "",
            "interval": 0,
            "filename": "",
            "format": "",
            "roundingGaps": 0,
            "expireDays": 0
        },
        "format": [
            "m3u8"
        ],
        "playbackDomain": ""
    },
    "refererSecurity": {
        "type": "",
        "list": null,
        "includeEmpty": false
    },
    "region": "cn-east-1",
    "status": "Enabled"
}

    响应参数

    参数名称 类型 说明
    callbackEnable boolean 是否启用回调通知功能
    callbackUrl string 开关播的回调地址
    codec null 转码相关配置
    connectId string 连接 ID，用于唯一标识一个推流或拉流连接
    creationDate string 创建时间，遵循 ISO 8601 格式
    lastModified string 修改时间，遵循 ISO 8601 格式
    name string 空间名称
    recording object 录制配置，详见 recording 对象
    refererSecurity object 防盗链配置，详见 refererSecurity 对象
    region string 区域，暂时只支持 cn-east-1
    status string 状态

    recording 对象

    参数名称 类型 说明
    enable boolean 是否开启录制功能
    objectBucket string 录制文件保存对象空间
    objectZone string 对象存储空间的区域
    expireDays integer 录制过期时间，默认不过期
    segmentDuration integer 录制切片时长，默认 5s
    snapshot object 截图配置，详见 snapshot 对象
    format []string 支持的录制格式列表，如 [‘flv’, ‘mp4’]
    playbackDomain string 回放域名

    snapshot 对象

    参数名称 类型 说明
    enable boolean 是否开启截图
    notifyUrl string 截图完成后的回调通知地址
    pipeline string 截图处理管道名称（如七牛 Dora 管道）
    bucket string 截图存储的目标 Bucket
    interval integer 截图间隔，单位为 s
    filename string 截图文件名模板
    format string 参考：管道
    有如下两种格式：
    vframe/jpg/offset/0
    vframe/png/offset/0
    roundingGaps integer 用于精确对齐截图时间点，单位 s
    expireDays integer 截图过期时间，默认不过期

    refererSecurity 对象

    参数名称 类型 说明
    type string “black”：黑名单类型 “white”：白名单类型 “”：关闭鉴权
    list []string Referer 白名单或黑名单列表
    includeEmpty boolean 是否允许空 Referer 访问
    以上内容是否对您有帮助？