QueryWaterMarkTemplateList - - Centre de documentation Alibaba Cloud

Consulte les modèles de filigrane.

Description de l'opération

Vous pouvez appeler cette opération pour interroger jusqu'à 10 modèles de filigrane à la fois.

Limite de QPS

Vous pouvez appeler cette opération jusqu'à 100 fois par seconde et par compte. Les requêtes qui dépassent cette limite sont rejetées et peuvent entraîner des interruptions de service. Nous vous recommandons de prendre en compte cette limite lors de l'appel de cette opération. Pour plus d'informations, consultez Limite de QPS.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

mts:QueryWaterMarkTemplateList

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
WaterMarkTemplateIds	string	Oui	Les identifiants des modèles de filigrane que vous souhaitez interroger. Pour obtenir les identifiants des modèles de filigrane, vous pouvez vous connecter à la console ApsaraVideo Media Processing (MPS) et choisir Paramètres globaux > Modèles de filigrane dans le volet de navigation de gauche. Vous pouvez interroger jusqu'à 10 modèles de filigrane à la fois. Séparez les identifiants de plusieurs modèles de filigrane par des virgules (,).	3780bd69b2b74540bc7b1096f564****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
RequestId	string	L'identifiant de la requête.	17079AF5-6276-51A9-B755-D26594C93F3C
NonExistWids	object
String	array	Les identifiants des modèles qui n'existent pas.
	string	Les identifiants des modèles de filigrane qui n'existent pas. Ce paramètre n'est pas renvoyé si tous les modèles de filigrane spécifiés sont trouvés.	72dfa5e679ab4be9a3ed9974c736****
WaterMarkTemplateList	object
WaterMarkTemplate	array<object>	Les détails des modèles de filigrane.
	array<object>	Les paramètres de réponse.
Type	string	The type of the watermark. Valid values: Image: an image watermark. Text: a text watermark. Remarque Only watermarks of the Image type are supported.	Image
RatioRefer	object	The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence: Width: the width edge. Height: the height edge. Long: the long edge. Short: the short edge.
Dx	string	The horizontal offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal. Integer: the vertical offset. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	0.51
Width	string	The width of the watermark image in the output video. The value can be an integer or a decimal. Integer: the width of the watermark image. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	0.36
Height	string	The height of the watermark image in the output video. The value can be an integer or a decimal. Integer: the height of the watermark image. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	0.33
Dy	string	The vertical offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal. Integer: the vertical offset. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	0.4
ReferPos	string	The position of the watermark. Valid values: TopRight: the upper-right corner. TopLeft: the upper-left corner. BottomRight: the lower-right corner. BottomLeft: the lower-left corner.	TopRight
State	string	The status of the watermark template. Valid values: Valid values: Normal: The watermark template is normal. Deleted: The watermark template is deleted.	Normal
Dx	string	The horizontal offset. Unit: pixel.	100
Width	string	The width of the watermark image. Unit: pixel.	8
Height	string	The height of the watermark image. Unit: pixel.	8
Timeline	object	The timeline of the watermark.
Start	string	The beginning of the time range during which the watermark is displayed. Unit: seconds. Default value: 0.	0
Duration	string	The display duration of the watermark. Default value: ToEND. The default value indicates that the watermark is displayed until the video ends.	10
Name	string	The name of the watermark template.	example-watermark
Dy	string	The vertical offset. Unit: pixel.	100
Id	string	The ID of the watermark template.	3780bd69b2b74540bc7b1096f564****

Exemples

JSON format

{
  "RequestId": "17079AF5-6276-51A9-B755-D26594C93F3C",
  "NonExistWids": {
    "String": [
      "72dfa5e679ab4be9a3ed9974c736****"
    ]
  },
  "WaterMarkTemplateList": {
    "WaterMarkTemplate": [
      {
        "Type": "Image",
        "RatioRefer": {
          "Dx": "0.51",
          "Width": "0.36",
          "Height": "0.33",
          "Dy": "0.4"
        },
        "ReferPos": "TopRight",
        "State": "Normal",
        "Dx": "100",
        "Width": "8",
        "Height": "8",
        "Timeline": {
          "Start": "0",
          "Duration": "10"
        },
        "Name": "example-watermark",
        "Dy": "100",
        "Id": "3780bd69b2b74540bc7b1096f564****"
      }
    ]
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.