Todos os produtos
Search
Central de documentação

ApsaraVideo Live:DescribeLiveDomainConfigs

Última atualização: Jun 28, 2026

Consulta uma ou mais configurações de um nome de domínio.

Descrição da operação

Você pode chamar esta operação para consultar várias configurações por vez.\n\n## Limite de QPS\n\nVocê pode chamar esta operação até 100 vezes por segundo por conta. Solicitações que excedem esse limite são descartadas e você sofrerá interrupções de serviço. Recomendamos que você observe esse limite ao chamar esta operaçã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:DescribeLiveDomainConfigs

get

*All Resource

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

DomainName

string

Sim

O domínio de ingestão ou o domínio de streaming.

demo.aliyundoc.com

FunctionNames

string

Sim

Os nomes dos recursos. Separe vários recursos com vírgulas (,). Para mais informações, consulte a seção Recursos especificados pelo parâmetro Functions neste tópico.

set_req_host_header,set_hashkey_args

Recursos especificados pelo parâmetro Functions\n\nNota Todos os valores de parâmetro são do tipo string. Alguns recursos, como filetype_based_ttl_set, suportam vários registros de configuração. Para atualizar um dos registros de configuração, use o campo configId para especificar o registro.\n\n| Nome | Parâmetro |\n| --- | --- |\n| referer_white_list_set: a lista de permissões de Referer. | refer_domain_allow_list: os Referers a serem adicionados à lista de permissões. Separe vários Referers com vírgulas (,).allow_empty: especifica se um Referer vazio é permitido. Valores válidos: on e off. |\n| referer_black_list_set: a lista de bloqueio de Referer. | refer_domain_deny_list: os Referers a serem adicionados à lista de bloqueio. Separe vários Referers com vírgulas (,).allow_empty: especifica se um Referer vazio é permitido. Valores válidos: on e off. |\n| filetype_based_ttl_set: o período de tempo após o qual um arquivo expira. | ttl: a duração do cache. Unidade: segundos.file_type: o tipo de arquivo. Separe vários tipos de arquivo com vírgulas (,).weight: o peso do tipo de arquivo. Valores válidos: 1 a 99. |\n| path_based_ttl_set: o período de tempo após o qual um diretório expira. | ttl: a duração do cache. Unidade: segundos.path: o diretório, que deve começar com uma barra (/).weight: o peso do diretório. Valores válidos: 1 a 99. |\n| oss_auth: autentica o acesso a um bucket do Object Storage Service (OSS). | oss_bucket_id: o nome do seu bucket OSS. |\n| ip_black_list_set: a lista de bloqueio de endereços IP. | ip_list: os endereços IP a serem adicionados à lista de bloqueio. Separe vários endereços IP com vírgulas (,). |\n| ip_allow_list_set: a lista de permissões de endereços IP. | ip_list: os endereços IP a serem adicionados à lista de permissões. Separe vários endereços IP com vírgulas (,). |\n| ip_white_list_set: a lista de permissões de endereços IP para limitação de taxa. | ip_list: os endereços IP a serem adicionados à lista de permissões. Separe vários endereços IP com vírgulas (,). |\n| error_page: redireciona uma página de erro para uma página especificada. | error_code: o código de erro.rewrite_page: a página para a qual a página de erro é redirecionada. |\n| set_req_host_header: modifica o cabeçalho Host das solicitações de retorno à origem. | domain_name: o cabeçalho Host das solicitações de retorno à origem. |\n| set_hashkey_args: ignora os parâmetros de URL especificados. | hashkey_args: os parâmetros a serem reservados. Separe vários parâmetros com vírgulas (,).disable: especifica se todos os parâmetros devem ser ignorados. Valores válidos: on e off. O valor on especifica que todos os parâmetros são ignorados. O valor off especifica que nenhum dos parâmetros é ignorado. |\n| aliauth: configura a autenticação do Alibaba Cloud. | auth_type: o tipo de autenticação. Valores válidos: type_a e no_auth. O valor type_a especifica que o tipo de autenticação A está ativado. O valor no_auth especifica que a autenticação está desativada.auth_key1: a chave de autenticação primária. A chave de autenticação deve ter de 16 a 32 caracteres e pode conter letras maiúsculas, minúsculas e dígitos.auth_key2: a chave de autenticação secundária.ali_auth_delta: o tempo de buffer personalizado para autenticação. Unidade: segundos. Recomendamos que você defina o valor para pelo menos 60 segundos. |\n| remote_auth: configura a autenticação remota para streaming ao vivo. | enable: especifica se a autenticação remota deve ser ativada. Este atributo é obrigatório. Valores válidos: on e off.remote_auth_path: o endereço do servidor de autenticação. Este atributo é obrigatório.remote_auth_pattern: o modo de autenticação. Os seguintes campos estão disponíveis:- param: especifica se os parâmetros na URL de ingestão devem ser passados para o servidor de autenticação. Valores válidos: pass (padrão) e fail.- args_white: o parâmetro que você deseja passar. Separe vários parâmetros com vírgulas (,).- args_black: o parâmetro que você não deseja passar. Separe vários parâmetros com vírgulas (,).- code: o código de status HTTP. Um valor na forma code=XXX é retornado pelo servidor de autenticação para o ApsaraVideo Live após a autenticação bem-sucedida. Exemplo: code=200. Um valor na forma code=~XXX é retornado pelo servidor de autenticação para o ApsaraVideo Live após a falha na autenticação. Exemplo: code=~403.- delta: a duração do tempo limite para autenticação.- retry: o número de tentativas após o tempo limite de autenticação.- timeout: a ação a ser executada após o tempo limite de autenticação. Valores válidos: pass e fail. pass: o ApsaraVideo Live aprova a solicitação. fail: o ApsaraVideo Live retorna o código de status HTTP 403 que indica falha.- async: especifica se a autenticação assíncrona deve ser ativada. Valores válidos: on e off (padrão). |\n| set_resp_header: configura um cabeçalho de resposta. Para verificar a configuração, você pode conferir a mensagem de resposta em um navegador. | key: o nome do cabeçalho de resposta.value: o conteúdo do cabeçalho de resposta. Se você quiser excluir o cabeçalho, insira null. |\n| https_force: configura o redirecionamento forçado para HTTPS. | enable: especifica se o recurso deve ser ativado. Valores válidos: on e off. Os recursos https_force e http_force são mutuamente exclusivos. Você não pode configurar ambos. Se você configurou um dos recursos, deve excluí-lo antes de poder configurar o outro. |\n| http_force: configura o redirecionamento forçado para HTTP. | enable: especifica se o recurso deve ser ativado. Valores válidos: on e off. Os recursos https_force e http_force são mutuamente exclusivos. Você não pode configurar ambos. Se você configurou um dos recursos, deve excluí-lo antes de poder configurar o outro. |\n| l2_oss_key: configura a autenticação de chave privada para solicitações de retorno à origem de nós L2 para buckets OSS privados. | private_oss_auth: especifica se o acesso a um bucket OSS privado deve ser autenticado. Valores válidos: on e off. |\n| green_manager: configura a detecção de pornografia. | enable: especifica se a detecção de pornografia deve ser ativada. Valores válidos: on e off. |\n| tmd_signature: configura regras personalizadas de limitação de taxa. | name: o nome da regra, que deve ser globalmente único.path: o identificador uniforme de recurso (URI). Você pode especificar URIs duplicados. No entanto, você deve verificar a validade deles.pathType: a regra de correspondência. Valores válidos: 0 e 1. O valor 0 especifica uma correspondência de prefixo. O valor 1 especifica uma correspondência exata.interval: o intervalo no qual os dados são monitorados. Unidade: segundos. O intervalo deve ser maior ou igual a 10 segundos.count: o número de visitas de um endereço IP.action: a ação a ser executada após as condições especificadas serem atendidas. Valores válidos: 0 e 1. O valor 0 especifica que o acesso é bloqueado. O valor 1 especifica que a detecção de bot é executada.ttl: o período de tempo durante o qual o acesso é bloqueado. Unidade: segundos. |\n| forward_scheme: configura o retorno à origem adaptativo. | enable: especifica se o recurso deve ser ativado. Valores válidos: on e off.scheme_origin: o protocolo da origem. Valores válidos: http, https e follow.scheme_origin_port: o número da porta da origem. Valores válidos: 80, 443 e 80:443. |\n| video_seek: configura a busca de vídeo. | enable: especifica se a busca de vídeo deve ser ativada. Valores válidos: on e off. |\n| gzip: configura a compactação Gzip. | enable: especifica se a compactação Gzip deve ser ativada. Valores válidos: on e off. |\n| tesla: configura a otimização de página para acelerar o acesso. | enable: especifica se o recurso deve ser ativado. Valores válidos: on e off. |\n| ali_ua: configura o controle de acesso baseado em User-Agent. | ua: o type do User-Agent. Valores válidos: black e white. |\n| host_redirect: configura a reescrita de URL. | regex: a URL a ser reescrita, por exemplo, ^/$.replacement: a URL final, por exemplo, /go/act/sale/tbzlsy.php.flag: a flag. Valores válidos: redirect e break. |\n| ipv6 :configura o IPv6. | switch: especifica se o IPv6 deve ser ativado. Este atributo é obrigatório. Valores válidos: on e off. Se você quiser desativar este recurso após ele ser ativado, desmarque o recurso no console. Não exclua a configuração. Caso contrário, o recurso ainda estará ativado.region: a região na qual você deseja ativar o IPv6. Valores válidos: cn-beijing (Pequim), cn-shanghai (Xangai), cn-shenzhen (Shenzhen), cn-qingdao (Qingdao), apsoutheast-1 (Singapura), eu-central-1 (Alemanha), ap-northeast-1 (Tóquio) e ap-southeast-5 (Jacarta). |\n| ali_location: configura o controle de acesso baseado em região. | location: as regiões. |\n| type: o tipo da lista. | Valores válidos: black e white. |\n| enable: especifica se o recurso deve ser ativado. | Valores válidos: on e off. |\n| live_forbid_flv: especifica se a reprodução de Flash Videos (FLVs) deve ser proibida. | Valores válidos: on e off. |\n| live_forbid_rtmp: especifica se a reprodução de vídeos Real-Time Messaging Protocol (RTMP) deve ser proibida. | Valores válidos: on e off. |\n| live_forbid_hls: especifica se a reprodução de vídeos HTTP Live Streaming (HLS) deve ser proibida. | Valores válidos: on e off. |\n| https_option: configura as definições de HTTP. | http2: especifica se o HTTP/2 deve ser ativado. Valor padrão: off. Valores válidos: on e off.live_http2: especifica se o live_http2 deve ser ativado. Valor padrão: off. Valores válidos: on e off. |

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

RequestId

string

O ID da solicitação.

F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED

DomainConfigs

object

DomainConfig

array<object>

As configurações do nome de domínio.

array<object>

Status

string

The configuration status. Valid values:

  • success

  • testing

  • failed

  • configuring

success

ConfigId

string

The configuration ID.

5003576

FunctionName

string

The name of the feature.

set_req_host_header

FunctionArgs

object

FunctionArg

array<object>

The attributes of the feature.

object

ArgName

string

The name of the attribute.

domain_name

ArgValue

string

The attribute value.

developer.aliyundoc.com

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ConfigId": "5003576",
        "FunctionName": "set_req_host_header",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "domain_name",
              "ArgValue": "developer.aliyundoc.com"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 Invalid%s.ValueNotSupported FunctionName [%s] is not supported.
404 InvalidUser The user's account is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.