Querying Snapshot Capturing Templates
Function
This API is used to query snapshot capturing templates.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
live:snapshot:listRules
Read
-
-
-
-
URI
GET /v1/{project_id}/stream/snapshot
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| domain | Yes | String | Definition Domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A |
| app_name | No | String | Definition Application name. Constraints N/A Range Length: 1 to 128 characters Default Value N/A |
| limit | No | Integer | Definition Number of records on each page. Constraints N/A Value range: 1~100 Default value: 10 |
| offset | No | Integer | Definition Page number. Constraints N/A Value range: ≥0 Default value: 0 |
Request 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. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total | Integer | Definition Total number of records. Range N/A |
| snapshot_config_list | Array of LiveSnapshotConfig objects | Definition Snapshot configuration. |
| limit | Integer | Definition Number of records on each page. Range N/A |
| offset | Integer | Definition Offset. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| domain | String | Definition Ingest domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A |
| app_name | String | Definition Application name. Constraints N/A Range Length: 1 to 128 characters Default Value N/A |
| auth_key | String | Definition Callback authentication key. Constraints If callback authentication is required, specify this parameter. Otherwise, leave it empty. Range Length: 32 to 128 characters Default Value N/A |
| time_interval | Integer | Definition Snapshot frequency, in seconds. Constraints N/A Range 5 to 3,600 Default Value N/A |
| object_write_mode | Integer | Definition Method for storing snapshots in an OBS bucket. Constraints N/A Range
Default value: 0 |
| snapshot_mode | String | Definition Snapshot option. Constraints N/A Range
Default Value keyframe Default value: keyframe |
| obs_location | ObsFileAddr object | Definition OBS storage location information. Constraints N/A |
| call_back_enable | String | Definition Whether to enable callback notifications. Constraints N/A Range Default Value N/A |
| call_back_url | String | Definition Notification server address. Constraints The value must be a valid URL containing a protocol. The supported protocols are HTTP and HTTPS. After snapshot capturing, Live pushes the snapshot process changes to this URL. Range N/A Default Value N/A |
| image_object_format | String | Definition Naming rules for snapshot files. Constraints Only JPG is supported. In the full storage mode:
A time template must be selected. Range N/A Default Value N/A |
| image_access_protocol | String | Definition Protocol for accessing stored snapshots. Constraints Only HTTP and HTTPS are supported. Range Default Value N/A |
| image_access_domain | String | Definition Domain name for accessing stored snapshots. Constraints N/A Range Length: 0 to 255 characters Default Value N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
Queries snapshot capturing templates.
GET https://{endpoint}/v1/{project_id}/stream/snapshot?domain=testsnapshot.com&app_name=live&offset=0&limit=10 Example Responses
Status code: 200
The snapshot capturing template query succeeded.
{
"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/"
}
} ]
} Status code: 400
The snapshot capturing template query failed.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
} SDK Sample Code
The SDK sample code is as follows.
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 | 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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSnapshotConfigsRequest{} response, err := client.ListSnapshotConfigs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | The snapshot capturing template query succeeded. |
| 400 | The snapshot capturing template query failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot