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

Chama QueryMessageApp para consultar aplicativos de mensagens interativas com base em condições especificadas.

Descrição da operação

Limites de QPS

O limite de QPS para esta API é de 100 consultas por segundo por usuário. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Você pode chamar a API adequadamente para evitar esse problema. Para mais informações, consulte Limites de QPS.

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:QueryMessageApp

get

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Não	O ID do aplicativo de mensagens interativas.	VKL3***
AppName	string	Não	O nome do aplicativo de mensagens interativas.	testApp
SortType	integer	Não	O método de classificação. Valores válidos: 0: Ordem crescente por tempo. 1: Ordem decrescente por tempo.	1
PageNum	integer	Não	O número da página. Valor padrão: 1. Valores válidos: 1 a 100000.	10
PageSize	integer	Não	O número de aplicativos exibidos por página. Valor padrão: 20. Valores válidos: 1 a 50.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	16A96B9A-****-CB92E68F4CD8
Result	array<object>	O resultado retornado.
	array<object>
AppList	array<object>	A lista de aplicativos de mensagens interativas.
	array<object>
AppConfig	object	Application configuration.
	string	Application configuration.	dawd
AppId	string	Interactive Messages application ID.	VKL3***
AppName	string	Interactive Messages application name.	test
CreateTime	integer	UTC timestamp when the application was created.	502280113
Extension	object	Extension field.
	string	Extension field.	test001
Status	integer	Interactive Messages application status. A value of 1 indicates that the application status is Normal.	1
HasMore	boolean	Indica se há uma próxima página. Valores válidos: true: Há uma próxima página. false: Não há uma próxima página.	false
TotalCount	integer	O número total de resultados da consulta.	4

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": [
    {
      "AppList": [
        {
          "AppConfig": {
            "key": "dawd"
          },
          "AppId": "VKL3***",
          "AppName": "test",
          "CreateTime": 502280113,
          "Extension": {
            "key": "test001"
          },
          "Status": 1
        }
      ],
      "HasMore": false,
      "TotalCount": 4
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.