Help Center/ Video On Demand/ API Reference/ Watermark template management/ Confirms that the watermark image has been uploaded
Updated on 2024-12-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Confirms that the watermark image has been uploaded

Function

Checks the upload status of the watermark image

URI

POST /v1.0/{project_id}/watermark/status/uploaded

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.

It 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 a 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Watermark configuration template ID

status

Yes

String

Watermark upload status. The value can be ** "SUCCEED"** or ** "FAILED"**.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Watermark configuration template ID.

image_url

String

URL for downloading a watermark image.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Confirms the watermark image upload status.

POST https://{endpoint}/v1.0/{project_id}/watermark/status/uploaded

Content-Type: application/json
{
  "id": "2305739f855413a84af9e6ad6e2b21be",
  "status": "SUCCEED"
}

Example Responses

Status code: 200

The information is returned when the request succeeds.

{
  "id" : "2305739f855413a84af9e6ad6e2b21be",
  "image_url" : "https://vod-bucket-26-cn-north-4.obs.cn-north-4.myhuaweicloud.com:443/05ab5cef408026f22f62c018de60cf2e/a52ba84366abebb4c4614e1b16973549/watermark.png?AWSAccessKeyId=CBN2J**********0RCSN&Expires=1625479312&Signature=kZYh0hEos2V**********AHGyXA%3D"
}

Status code: 400

The information is returned when the request fails.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code

Description

200

The information is returned when the request succeeds.

400

The information is returned when the request fails.

Error Codes

See Error Codes.