Help Center/ Live/ Cloud Live API Reference/ Snapshot Management/ Creating a Snapshot Capturing Template
Updated on 2024-09-27 GMT+08:00
View PDF

Creating a Snapshot Capturing Template

Function

API for creating a snapshot capturing template.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/stream/snapshot

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Ingest domain name

app_name

Yes

String

Application name

auth_key

No

String

Callback authentication key value

Length range: [32-128]

If callback authentication is required, specify this parameter. Otherwise, leave it empty.

time_interval

Yes

Integer

Snapshot capturing frequency

Value range: 5 to 3600

Unit: second

object_write_mode

Yes

Integer

Method for storing snapshots in an OBS bucket:

  • 0: All. A snapshot file name contains the timestamp. All snapshot files of each stream are stored in OBS. Example: snapshot/{domain}/{app_name}/{stream_name}/{UnixTimestamp}.jpg

  • 1: Latest. A snapshot file name does not contain the timestamp. Only the latest snapshot file of each stream will be saved. A new snapshot file overwrites the previous one. Example: snapshot/{domain}/{app_name}/{stream_name}.jpg

obs_location

Yes

ObsFileAddr object

OBS bucket location information

call_back_enable

No

String

Whether to enable callback notification.

  • on: enabled

  • off: disabled

call_back_url

No

String

Address of the server for receiving callback notifications. The value must be a valid URL that contains a protocol, which can be HTTP or HTTPS. After snapshot capturing, Live pushes the snapshot status information to this address.
Table 4 ObsFileAddr

Parameter

Mandatory

Type

Description

bucket

Yes

String

OBS bucket name

location

Yes

String

Region where the OBS bucket is located. The region must be the same as that of the Live service.

object

Yes

String

OBS object path, which complies with the OSS Object definition.

  • If this parameter is used for an input, an object must be specified.

  • If this parameter is used for an output, only the directory for storing the snapshot needs to be specified.

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Creates a snapshot capturing template.

POST https://{endpoint}/v1/{project_id}/stream/snapshot

{
  "domain" : "play.example.huawei.com",
  "app_name" : "live",
  "time_interval" : 5,
  "object_write_mode" : 1,
  "obs_location" : {
    "bucket" : "cls-test",
    "location" : "region1",
    "object" : "/ffff/aa/"
  }
}

Example Responses

Status code: 400

The snapshot capturing template configuration failed.

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

Status Codes

Status Code

Description

200

The snapshot capturing template has been configured.

400

The snapshot capturing template configuration failed.

Error Codes

See Error Codes.

Parent Topic: Snapshot Management