文档首页/ 视频直播 Live/ 云直播API参考/ 截图管理/ 查询直播截图配置 - ListSnapshotConfigs
更新时间:2026-09-07 GMT+08:00

查询直播截图配置 - ListSnapshotConfigs

功能介绍

查询直播截图配置接口

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    live:snapshot:listRules

    Read

    -

    -

    -

    -

URI

GET /v1/{project_id}/stream/snapshot

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID,获取方法请参考获取项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

domain

是

String

参数解释:

直播域名

约束限制:

不涉及

取值范围:

字符长度为[1-255]位

默认取值:

不涉及

app_name

否

String

参数解释:

应用名称

约束限制:

不涉及

取值范围:

字符长度为[1-128]位

默认取值:

不涉及

limit

否

Integer

参数解释:

每页记录数

约束限制:

不涉及

取值范围:

1~100

默认取值:

10

offset

否

Integer

参数解释:

分页编号

约束限制:

不涉及

取值范围:

≥0

默认取值:

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

否

String

使用AK/SK方式认证时必填,携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必填,请求的发生时间。

X-Project-Id

否

String

使用AK/SK方式认证时必填,携带项目ID信息。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总条目数

取值范围:

不涉及

snapshot_config_list

Array of LiveSnapshotConfig objects

参数解释:

直播截图配置

limit

Integer

参数解释:

每页记录数

取值范围:

不涉及

offset

Integer

参数解释:

偏移量

取值范围:

不涉及

表5 LiveSnapshotConfig

参数

参数类型

描述

domain

String

参数解释:

直播推流域名

取值范围:

字符长度为[1-255]位

app_name

String

参数解释:

应用名称

取值范围:

字符长度为[1-128]位

auth_key

String

参数解释:

回调鉴权密钥值

取值范围:

字符长度为[32,128]位

time_interval

Integer

参数解释:

截图频率,单位:秒

取值范围:

[5,3600]

object_write_mode

Integer

参数解释:

在OBS桶存储截图的方式

取值范围:

  • 0:全保存模式,截图文件名中含时间戳,每条流的所有截图文件均会保存在存储对象里。示例:snapshot/{domain}/{app_name}/{stream_name}/{UnixTimestamp}.jpg

  • 1:覆盖模式,截图文件名不含时间戳,每条流只保存最新的截图文件,新的截图文件会覆盖原来的截图文件。示例:snapshot/{domain}/{app_name}/{stream_name}.jpg

snapshot_mode

String

参数解释:

截图模式

取值范围:

  • keyframe:I帧截图只选取、保存符合要求的I帧。

  • nokeyframe:非I帧截图只选取、保存符合要求的非I帧。

  • random:随机截图交替选取、保存符合要求的I帧及非I帧。

obs_location

ObsFileAddr object

参数解释:

OBS存储位置信息

call_back_enable

String

参数解释:

是否启用回调通知

取值范围:

  • on:启用。

  • off:不启用。

call_back_url

String

参数解释:

通知服务器地址

取值范围:

不涉及

image_object_format

String

参数解释:

截图存储文件命名规则

取值范围:

不涉及

image_access_protocol

String

参数解释:

截图存储文件访问协议

取值范围:

  • http

  • https

image_access_domain

String

参数解释:

截图存储文件访问域名

取值范围:

字符长度为[0,255]位

表6 ObsFileAddr

参数

参数类型

描述

bucket

String

参数解释:

OBS的bucket名称

取值范围:

字符长度为[1,64]位

location

String

参数解释:

OBS Bucket所在的区域,且必须保持与使用的直播服务区域保持一致

取值范围:

字符长度为[1,128]位

object

String

参数解释:

OBS对象路径,遵守OSS Object定义

取值范围:

字符长度为[0,1024]位

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询直播截图配置。

GET https://{endpoint}/v1/{project_id}/stream/snapshot?domain=testsnapshot.com&app_name=live&offset=0&limit=10

响应示例

状态码:200

查询直播截图配置操作成功

{
  "total" : 2,
  "offset" : 0,
  "limit" : 10,
  "snapshot_config_list" : [ {
    "domain" : "testsnapshot.huawei.com",
    "app_name" : "live",
    "time_interval" : 5,
    "object_write_mode" : 1,
    "snapshot_mode" : "keyframe",
    "obs_location" : {
      "bucket" : "obs-d95a",
      "location" : "region1",
      "object" : "test1/"
    }
  }, {
    "domain" : "testsnapshot.huawei.com",
    "app_name" : "src",
    "time_interval" : 5,
    "object_write_mode" : 1,
    "obs_location" : {
      "bucket" : "obs-d95a",
      "location" : "region1",
      "object" : "test2/"
    }
  } ]
}

状态码:400

查询直播截图配置操作失败

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v1.region.LiveRegion;
import com.huaweicloud.sdk.live.v1.*;
import com.huaweicloud.sdk.live.v1.model.*;


public class ListSnapshotConfigsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        ListSnapshotConfigsRequest request = new ListSnapshotConfigsRequest();
        try {
            ListSnapshotConfigsResponse response = client.listSnapshotConfigs(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v1.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListSnapshotConfigsRequest()
        response = client.list_snapshot_configs(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := live.LiveClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := live.NewLiveClient(hcClient)

    request := &model.ListSnapshotConfigsRequest{}
	response, err := client.ListSnapshotConfigs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询直播截图配置操作成功

400

查询直播截图配置操作失败

错误码

请参见错误码。