1. API Description
Domain name for API request: mdl.tencentcloudapi.com.
This API is used to modify a watermark.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyStreamLiveWatermark. |
| Version | Yes | String | Common Params. The value used for this API: 2020-03-26. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Id | Yes | String | Watermark ID |
| Name | Yes | String | Watermark name |
| ImageSettings | No | CreateImageSettings | Watermark image settings. This parameter is valid if Type is STATIC_IMAGE. |
| TextSettings | No | CreateTextSettings | Watermark text settings. This parameter is valid if Type is TEXT. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: mdl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyStreamLiveWatermark
<Common request parameters>
{
"TextSettings": {
"XPos": 0,
"Text": "xx",
"YPos": 0,
"FontSize": 0,
"Location": "xx",
"FontColor": "xx"
},
"ImageSettings": {
"XPos": 0,
"YPos": 0,
"Height": 0,
"Width": 0,
"ImageContent": "xx",
"Location": "xx",
"ImageType": "xx"
},
"Name": "xx",
"Id": "xx"
}
Output Example
{
"Response": {
"RequestId": "xx"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter.Id | Invalid Id. |
| InvalidParameter.ImageSettings | Watermark image configuration error. |
| InvalidParameter.Name | Invalid Name. |
| InvalidParameter.TextSettings | Watermark text configuration error. |
| InvalidParameter.Type | Invalid Type. |
是
否
本页内容是否解决了您的问题？