Querying Watermark Rules
Function
Queries watermark rules that meet the specified criteria.
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, no identity policy-based permission required for calling this API.
URI
GET /v1/{project_id}/watermark/rules
|
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 |
|---|---|---|---|
|
template_id |
No |
String |
Watermark template ID |
|
domain |
No |
String |
Ingest domain name |
|
app |
No |
String |
App name for stream push |
|
channel_id |
No |
String |
OTT channel ID |
|
stream |
No |
String |
Enter a transcoding template ID for OTT, and a stream name for Cloud Live. |
|
offset |
No |
Integer |
Offset, which is the position where the query starts. The value must be greater than or equal to 0. |
|
limit |
No |
Integer |
Number of records on each page. The value ranges from 1 to 100 and defaults to 10. |
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 |
|---|---|---|
|
X-request-id |
String |
Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp is the current timestamp. hostname is the name of the server that handles the current request.) |
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Integer |
Total number |
|
rules_infos |
Array of WatermarkRule objects |
Response data |
|
Parameter |
Type |
Description |
|---|---|---|
|
rule_name |
String |
Watermark rule name |
|
template_id |
String |
Watermark template ID, which contains only digits, letters, and hyphens (-). The ID is generated when a template is created. |
|
domain |
String |
Domain name |
|
app |
String |
App name. Note: This parameter is optional for Clod Live and mandatory for Media Live. |
|
stream |
String |
Stream name. This parameter is optional for OTT. |
|
location |
WatermarkLocation object |
Watermark position |
|
channel_id |
String |
This parameter is used for OTT. Set this parameter to the channel ID. |
|
transcode_template_name |
String |
This parameter is used for OTT. Set this parameter to the name of the transcoding template corresponding to the channel. |
|
Parameter |
Type |
Description |
|---|---|---|
|
location |
String |
Watermark position. The options are TOPLEFT (upper left), TOPRIGHT (upper right), BOTTOMLEFT (lower left), BOTTOMRIGHT (lower right), and RANDOM (random). If RANDOM is used, the watermark will randomly appear on the upper left, upper right, lower left, or lower right of the video. |
|
x_offset |
Number |
Horizontal offset between the watermark and the output video. Options: (1) An integer indicates the offset pixel. The value ranges from 1 to 4,096, in pixels. (2) A decimal indicates the ratio of the horizontal offset to the output video width. The value range is [0, 1). The percentage can contain a maximum of four decimal places. |
|
y_offset |
Number |
Vertical offset between the watermark and the output video. Options: (1) An integer indicates the offset pixel. The value ranges from 1 to 4,096, in pixels. (2) A decimal indicates the ratio of the vertical offset to the output video height. The value range is [0, 1). The percentage can contain a maximum of four decimal places. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp is the current timestamp. hostname is the name of the server that handles the current request.) |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Code |
|
error_msg |
String |
Error description |
Example Requests
GET https://live.hwcloud.com/v1/{project_id}/watermark/rules
Example Responses
Status code: 200
Watermark rules queried.
{
"total" : 1,
"rules_infos" : [ {
"template_id" : "70b76xxxxxx34253880af501cdxxxxxx",
"domain" : "push.example.com",
"app" : "live",
"stream" : "watermarkStream",
"location" : {
"location" : "TOPLEFT",
"x_offset" : 20,
"y_offset" : 10
}
} ]
}
Status code: 400
Invalid parameter.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
}
SDK Sample Code
The SDK sample code is as follows.
Java
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 ListWatermarkRuleSolution { 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(); ListWatermarkRuleRequest request = new ListWatermarkRuleRequest(); try { ListWatermarkRuleResponse response = client.listWatermarkRule(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()); } } } |
Python
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 = ListWatermarkRuleRequest() response = client.list_watermark_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
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.ListWatermarkRuleRequest{} response, err := client.ListWatermarkRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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 |
Watermark rules queried. |
|
400 |
Invalid parameter. |
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