自定义截图及存储配置

设置自定义截图及存储配置

为指定发布点下的直播流设置自定义截图及存储配置。

HTTP 请求

PATCH https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/snapshot/custom/regions/{region}

路径参数

参数	类型	描述
appid	String	必填。在声网控制台获取的 App ID。
entry_point	String	必填。发布点名称。
region	String	必填。添加推流域名时设置的区域。

请求包体

请求包体为 JSON Object 类型，包含以下字段：

字段	类型	描述
enabled	Bool	必填。是否启用截图功能： true：启用截图。 false：关闭截图。
snapshotInterval	Integer	选填。截图的间隔，单位为秒，默认值为 10，取值范围为 [5,300]。
storageConfig	JSON Object	选填。截图文件的存储配置，详见 StorageConfig。

HTTP 响应

如果返回的 HTTP 状态码为 200，表示请求成功。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 HTTP 状态码了解可能的原因。

示例

请求行

PATCH https://api.sd-rtn.com/v1/projects/{your_appid}/fls/entry_points/live/settings/snapshot/custom/regions/cn HTTP/1.1

请求 body

{
    "enabled": true,
    "snapshotInterval": 30,
    "storageConfig": {
        "accessKey": "{your access key}",
        "bucket": "{your bucket}",
        "region": 3,
        "secretKey": "{your secret key}",
        "vendor": 2
    }
}

响应行

HTTP/1.1 200 OK

获取自定义截图及存储配置

获取指定发布点的自定义截图及存储配置。

HTTP 请求

GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/snapshot/custom/regions/{region}

路径参数

参数	类型	描述
appid	String	必填。在声网控制台获取的 App ID。
entry_point	String	必填。发布点名称。
region	String	必填。添加推流域名时设置的区域。

HTTP 响应

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

字段	类型	描述
enabled	Bool	是否启用了截图功能： true：已启用截图。 false：未启用截图。
snapshotInterval	Integer	截图的间隔，单位为秒，取值范围为 [5,300]。
storageConfig	JSON Object	截图文件的存储配置，详见 StorageConfig。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 HTTP 状态码了解可能的原因。

示例

请求行

GET https://api.sd-rtn.com/v1/projects/{your_appid}/fls/entry_points/live/settings/snapshot/custom/regions/cn HTTP/1.1

响应行

HTTP/1.1 200 OK

响应 body

{
  "enabled": true,
    "snapshotInterval": 30,
    "storageConfig": {
        "accessKey": "test acces key",
        "region": 3,
        "bucket": "test bucket",
        "secretKey": "test secret key",
        "vendor": 2
    }
}

参数类型

StorageConfig

截图文件的存储设置，包含以下字段：

• vendor：Number 类型，第三方云存储平台。

  • 1：Amazon S3
  • 2：阿里云
  • 3：腾讯云
  • 5：Microsoft Azure
  • 6：谷歌云
  • 7：华为云
  • 8：百度智能云

• region：Number 类型，第三方云存储指定的地区信息。录制服务仅支持以下列表中的地区。

当 vendor = 1，即第三方云存储为 Amazon S3 时：

• 0：US_EAST_1
• 1：US_EAST_2
• 2：US_WEST_1
• 3：US_WEST_2
• 4：EU_WEST_1
• 5：EU_WEST_2
• 6：EU_WEST_3
• 7：EU_CENTRAL_1
• 8：AP_SOUTHEAST_1
• 9：AP_SOUTHEAST_2
• 10：AP_NORTHEAST_1
• 11：AP_NORTHEAST_2
• 12：SA_EAST_1
• 13：CA_CENTRAL_1
• 14：AP_SOUTH_1
• 15：CN_NORTH_1
• 16：CN_NORTHWEST_1
• 18：AF_SOUTH_1
• 19：AP_EAST_1
• 20：AP_NORTHEAST_3
• 21：EU_NORTH_1
• 22：ME_SOUTH_1
• 24：AP_SOUTHEAST_3
• 25：EU_SOUTH_1

当 vendor = 2，即第三方云存储为阿里云时：

• 0：CN_Hangzhou
• 1：CN_Shanghai
• 2：CN_Qingdao
• 3：CN_Beijing
• 4：CN_Zhangjiakou
• 5：CN_Huhehaote
• 6：CN_Shenzhen
• 7：CN_Hongkong
• 8：US_West_1
• 9：US_East_1
• 10：AP_Southeast_1
• 11：AP_Southeast_2
• 12：AP_Southeast_3
• 13：AP_Southeast_5
• 14：AP_Northeast_1
• 15：AP_South_1
• 16：EU_Central_1
• 17：EU_West_1
• 18：EU_East_1
• 19：AP_Southeast_6
• 20：CN_Heyuan
• 21：CN_Guangzhou
• 22：CN_Chengdu
• 23：CN_Nanjing
• 24：CN_Fuzhou
• 25：CN_Wulanchabu
• 26：CN_Northeast_2
• 27：CN_Southeast_7

详见阿里云参考文档。

当 vendor = 3，即第三方云存储为腾讯云时：

• 0：AP_Beijing_1
• 1：AP_Beijing
• 2：AP_Shanghai
• 3：AP_Guangzhou
• 4：AP_Chengdu
• 5：AP_Chongqing
• 6：AP_Shenzhen_FSI
• 7：AP_Shanghai_FSI
• 8：AP_Beijing_FSI
• 9：AP_Hongkong
• 10：AP_Singapore
• 11：AP_Mumbai
• 12：AP_Seoul
• 13：AP_Bangkok
• 14：AP_Tokyo
• 15：NA_Siliconvalley
• 16：NA_Ashburn
• 17：NA_Toronto
• 18：EU_Frankfurt
• 19：EU_Moscow

当 vendor = 5，即第三方云存储为 Microsoft Azure 时：

无需设置 region 参数，即使设置也不生效。

当 vendor = 6，即第三方云存储为谷歌云时：

无需设置 region 参数，即使设置也不生效。

当 vendor = 7，即第三方云存储为华为云时：

• 0：CN_North_1
• 1：CN_North_4
• 2：CN_East_2
• 3：CN_East_3
• 4：CN_South_1
• 5：CN_Southwest_2
• 6：AP_Southeast_1
• 7：AP_Southeast_2
• 8：AP_Southeast_3
• 9：AF_South_1
• 10：SA_Argentina_1
• 11：SA_Peru_1
• 12：NA_Mexico_1
• 13：SA_Brazil_1
• 14：LA_South_2
• 15：SA_Chile_1

当 vendor = 8，即第三方云存储为百度智能云时：

• 0：Beijing
• 1：Baoding
• 2：Suzhou
• 3：Guangzhou
• 4：Hongkong
• 5：Singapore
• 6：Wuhan
• 7：Shanghai

• bucket：String 类型，第三方云存储的 bucket，bucket 名称需要符合对应第三方云存储服务的命名规则。
• accessKey：String 类型，第三方云存储的 access key。在一般情况下，建议提供只写权限的访问密钥。如需延时转码，则访问密钥必须同时具备读写权限。
• secretKey：String 类型，第三方云存储的 secret key。

HTTP 状态码

状态码	描述
200	请求成功。
400	参数非法，如 appid 或者 entry_point 为空，或者 region 参数值非法。
401	未经授权的（客户 ID/客户密钥匹配错误）。
404	服务器无法根据请求找到资源，即请求的发布点不存在，或者请求的 URI 路径非法。
500	服务器内部错误，无法完成请求。
504	服务器内部错误。充当网关或代理的服务器未从远端服务器获取请求。