DescribeLiveStreamWatermarks - ApsaraVideo Live: Central de Documentação do Alibaba Cloud

Consulta modelos de marca d'água.

Descrição da operação

Esta operação suporta paginação.

Limite de QPS

Você pode chamar esta operação até 60 vezes por segundo por conta. Solicitações que excedam esse limite serão descartadas e você poderá sofrer interrupções no serviço.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

live:DescribeLiveStreamWatermarks

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-shanghai
Domain	string	Não	O domínio principal de streaming.	live.yourdomain.com
KeyWord	string	Não	A palavra-chave para a pesquisa. Você pode especificar um ID ou nome de modelo. Há suporte à pesquisa aproximada para nomes.	445409ec-7eaa-461d-8f29-4bec2eb9****
PageNumber	integer	Não	O número da página. O valor padrão é 1.	1
PageSize	integer	Não	O número de modelos a serem retornados em cada página. O valor padrão é 100.	100

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações do modelo de marca d'água.
Total	integer	O número total de entradas correspondentes.	100
RequestId	string	O ID da solicitação.	5c6a2a0df228-4a64- af62-20e91b9676b3
WatermarkList	object
Watermark	array<object>	A lista de modelos de marca d'água.
	object	A lista de modelos de marca d'água.
Type	integer	The watermark type. 0: Image.	0
XOffset	number	The X-axis offset of the watermark, in pixels. Nota Relative to RefWidth. If OffsetCorner is TopLeft, XOffset is the horizontal distance between the top‑left corner of the watermark and the top‑left corner of the background video. Positive X points to the right.	50.0
RefWidth	integer	The reference width of the video background, in pixels.	1920
YOffset	number	The Y-axis offset of the watermark, in pixels. Nota Relative to RefHeight. If OffsetCorner is TopLeft, YOffset is the vertical distance between the top‑left corner of the watermark and the top‑left corner of the background video. Positive Y points downward.	100.0
Height	integer	The height of the watermark image, in pixels. This value is relative to `RefHeight` and is scaled proportionally with the actual video resolution.	200
RefHeight	integer	The reference height of the video background, in pixels.	1080
PictureUrl	string	The URL of the watermark image.	http://example.com
Transparency	integer	The opacity of the watermark. Value range: `0` (fully transparent) to `255` (fully opaque).	255
Description	string	The custom description of the watermark.	my watermark
OffsetCorner	string	The anchor point for the watermark's position. Valid values: TopLeft TopRight BottomLeft BottomRight	TopRight
RuleCount	integer	The number of watermark rules configured for the domain.	12
Name	string	The name of the watermark.	livewatermark****
TemplateId	string	The ID of the watermark template.	445409ec-7eaa-4 61d-8f29-4bec2eb9 ****

Exemplos

Resposta de sucesso

JSON formato

{
  "Total": 100,
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "WatermarkList": {
    "Watermark": [
      {
        "Type": 0,
        "XOffset": 50,
        "RefWidth": 1920,
        "YOffset": 100,
        "Height": 200,
        "RefHeight": 1080,
        "PictureUrl": "http://example.com",
        "Transparency": 255,
        "Description": "my watermark",
        "OffsetCorner": "TopRight",
        "RuleCount": 12,
        "Name": "livewatermark****",
        "TemplateId": "445409ec-7eaa-4 61d-8f29-4bec2eb9 ****"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameters	%s Please check and try again later.	Exception parameter exists, please check and try again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.