SearchWaterMarkTemplate - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Appelez cette opération pour interroger les modèles de filigrane dans l'état spécifié. Si vous ne spécifiez pas l'état, tous les modèles de filigrane sont interrogés par défaut.

Limite QPS

Vous pouvez appeler cette API jusqu'à 100 fois par seconde par compte. Si le nombre d'appels par seconde dépasse la limite, un mécanisme de limitation du débit (throttling) est déclenché, ce qui peut affecter votre activité. Nous vous recommandons de prendre en compte cette limite lors de l'appel à cette opération. Pour plus d'informations, consultez la section Limite QPS.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour votre commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	SearchWaterMarkTemplate	L'opération que vous souhaitez effectuer. Définissez la valeur sur SearchWaterMarkTemplate.
PageSize	Long	No	10	Le nombre d'entrées à renvoyer par page. Un maximum de 100 entrées peut être renvoyé par page. Valeur par défaut : 10.
PageNumber	Long	No	1	Le numéro de la page à renvoyer. Valeur par défaut : 1.
State	String	No	Normal	L'état des modèles de filigrane que vous souhaitez interroger. Valeurs valides : All : Tous les modèles de filigrane sont interrogés. Il s'agit de la valeur par défaut. normal : Les modèles de filigrane normaux sont interrogés. Deleted : Les modèles de filigrane supprimés sont interrogés.

Paramètres de réponse

Parameter	Type	Example	Description
TotalCount	Long	1	Le nombre total d'entrées renvoyées.
PageSize	Long	10	Le nombre d'entrées renvoyées sur chaque page.
RequestId	String	FC029D04-8F47-57FF-A759-23383C15617D	L'ID de la requête.
PageNumber	Long	1	Le numéro de la page renvoyée.
WaterMarkTemplateList	Array of WaterMarkTemplate		Les détails des modèles de filigrane.
WaterMarkTemplate
Type	String	Image	Le type de filigrane. Valeurs valides : Image : un filigrane image. Text : un filigrane texte. Remarque Seuls les filigranes de type Image sont pris en charge.
RatioRefer	Object		Les valeurs des paramètres Height, Width, Dx et Dy par rapport aux bords de référence. Si les valeurs des paramètres Height, Width, Dx et Dy sont des décimales comprises entre 0 et 1, les valeurs sont calculées en se référant aux bords suivants dans l'ordre : Width : le bord de largeur. Height : le bord de hauteur. Long : le bord long. Short : le bord court.
Dx	String	0.51	Le décalage horizontal du filigrane par rapport à l'image vidéo de sortie. Valeur par défaut : 0. La valeur par défaut indique qu'il n'y a aucun décalage. La valeur peut être un entier ou un nombre décimal. Integer : le décalage vertical. Cela indique la position absolue. Unité : pixel. Decimal : le ratio du décalage horizontal par rapport à la largeur de la vidéo de sortie. Le ratio varie en fonction de la taille de la vidéo. Quatre décimales sont prises en charge, par exemple 0,9999. Les décimales supplémentaires sont ignorées.
Width	String	0.36	La largeur de l'image du filigrane dans la vidéo de sortie. La valeur peut être un entier ou un nombre décimal. Integer : la largeur de l'image du filigrane. Cela indique la position absolue. Unité : pixel. Decimal : le ratio de la largeur de l'image du filigrane par rapport à la largeur de la vidéo de sortie. Le ratio varie en fonction de la taille de la vidéo. Quatre décimales sont prises en charge, par exemple 0,9999. Les décimales supplémentaires sont ignorées.
Height	String	0.33	La hauteur de l'image du filigrane dans la vidéo de sortie. La valeur peut être un entier ou un nombre décimal. Integer : la hauteur de l'image du filigrane. Cela indique la position absolue. Unité : pixel. Decimal : le ratio de la hauteur de l'image du filigrane par rapport à la hauteur de la vidéo de sortie. Le ratio varie en fonction de la taille de la vidéo. Quatre décimales sont prises en charge, par exemple 0,9999. Les décimales supplémentaires sont ignorées.
Dy	String	0.2	Le décalage vertical du filigrane par rapport à l'image vidéo de sortie. Valeur par défaut : 0. La valeur par défaut indique qu'il n'y a aucun décalage. La valeur peut être un entier ou un nombre décimal. Integer : le décalage vertical. Cela indique la position absolue. Unité : pixel. Decimal : le ratio du décalage vertical par rapport à la hauteur de la vidéo de sortie. Le ratio varie en fonction de la taille de la vidéo. Quatre décimales sont prises en charge, par exemple 0,9999. Les décimales supplémentaires sont ignorées.
ReferPos	String	TopRight	La position du filigrane. Valeurs valides : TopRight : le coin supérieur droit. TopLeft : le coin supérieur gauche. BottomRight : le coin inférieur droit. BottomLeft : le coin inférieur gauche.
State	String	Normal	L'état du modèle de filigrane. Valeurs valides : Normal : Le modèle de filigrane est normal. Deleted : Le modèle de filigrane est supprimé.
Dx	String	100	Le décalage horizontal. Unité : pixel.
Width	String	8	La largeur de l'image du filigrane. Unité : pixel.
Height	String	8	La hauteur de l'image du filigrane. Unité : pixel.
Timeline	Object		La chronologie du filigrane.
Start	String	0	Le début de la plage de temps pendant laquelle le filigrane est affiché. Unité : secondes. Valeur par défaut : 0.
Duration	String	ToEND	La durée d'affichage du filigrane. Valeur par défaut : ToEND. La valeur par défaut indique que le filigrane est affiché jusqu'à la fin de la vidéo.
Name	String	example-watermark	Le nom du modèle de filigrane.
Dy	String	100	Le décalage vertical. Unité : pixel.
Id	String	88c6ca184c0e4578645b665e2a12****	L'ID du modèle de filigrane.

Exemples

Exemple de requête

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=SearchWaterMarkTemplate
&PageSize=10
&PageNumber=1
&State=Normal
&<Common request parameters>

Exemple de réponse réussie

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<SearchWaterMarkTemplateResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>FC029D04-8F47-57FF-A759-23383C15617D</RequestId>
    <PageNumber>1</PageNumber>
    <WaterMarkTemplateList>
        <Type>Image</Type>
        <RatioRefer>
            <Dx>0.51</Dx>
            <Width>0.36</Width>
            <Height>0.33</Height>
            <Dy>0.2</Dy>
        </RatioRefer>
        <ReferPos>TopRight</ReferPos>
        <State>Normal</State>
        <Dx>100</Dx>
        <Width>8</Width>
        <Height>8</Height>
        <Timeline>
            <Start>0</Start>
            <Duration>ToEND</Duration>
        </Timeline>
        <Name>example-watermark</Name>
        <Dy>100</Dy>
        <Id>88c6ca184c0e4578645b665e2a12****</Id>
    </WaterMarkTemplateList>
</SearchWaterMarkTemplateResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "FC029D04-8F47-57FF-A759-23383C15617D",
  "PageNumber" : 1,
  "WaterMarkTemplateList" : [ {
    "Type" : "Image",
    "RatioRefer" : {
      "Dx" : "0.51",
      "Width" : "0.36",
      "Height" : "0.33",
      "Dy" : "0.2"
    },
    "ReferPos" : "TopRight",
    "State" : "Normal",
    "Dx" : "100",
    "Width" : "8",
    "Height" : "8",
    "Timeline" : {
      "Start" : "0",
      "Duration" : "ToEND"
    },
    "Name" : "example-watermark",
    "Dy" : "100",
    "Id" : "88c6ca184c0e4578645b665e2a12****"
  } ]
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs.