DescribeDcdnDomainConfigs - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Obtém as configurações de um nome de domínio acelerado.

Descrição da operação

Nota

Você pode consultar as configurações de vários recursos em uma única solicitação.
O limite de taxa de solicitação para um único usuário é de 30 chamadas por segundo.

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

dcdn:DescribeDcdnDomainConfigs

get

domain

acs:dcdn:*:{#accountId}:domain/{#domainName}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DomainName	string	Sim	O nome do domínio acelerado. Você pode consultar apenas um nome de domínio por vez.	example.com
FunctionNames	string	Não	Os nomes dos recursos. Separe vários nomes de recursos com vírgulas (,).	filetype_based_ttl_set,set_req_host_header
ConfigId	string	Não	O ID da configuração.	5003576

A tabela a seguir descreve os recursos.

Nome	Parâmetros
referer_white_list_set: Lista de permissões de proteção contra hotlink de Referer	refer_domain_allow_list: A lista de permissões. Separe vários nomes de domínio com vírgulas (,). allow_empty: Especifica se permite que solicitações com um cabeçalho Referer vazio acessem recursos do DCDN. Valores válidos: on e off.
referer_black_list_set: Lista de bloqueios de proteção contra hotlink de Referer	refer_domain_deny_list: A lista de bloqueios. Separe vários nomes de domínio com vírgulas (,). allow_empty: Especifica se permite que solicitações com um cabeçalho Referer vazio acessem recursos do DCDN. Valores válidos: on e off.
filetype_based_ttl_set: Configurar tempo de vida (TTL) com base no tipo de arquivo	ttl: A duração do cache. Unidade: segundos. file_type: O tipo de arquivo. Separe vários tipos de arquivo com vírgulas (,), por exemplo, TXT,JPG. weight: O peso.
path_based_ttl_set: Configurar TTL com base no caminho	ttl: A duração do cache. Unidade: segundos. path: O caminho. O caminho deve começar com uma barra (/). weight: O peso.
oss_auth: Autenticação do OSS para buckets	oss_bucket_id: A URL do seu bucket.
ip_black_list_set: Lista de bloqueios de endereços IP	ip_list: A lista de endereços IP. Separe vários endereços IP com vírgulas (,).
ip_allow_list_set: Lista de permissões de endereços IP	ip_list: A lista de endereços IP. Separe vários endereços IP com vírgulas (,).
error_page: Redirecionamento de página de erro	error_code: O código de erro. rewrite_page: A página de redirecionamento.
set_req_host_header: Modificar o cabeçalho Host personalizado de back-to-origin	domain_name: O conteúdo do cabeçalho Host de back-to-origin.
set_hashkey_args: Ignorar parâmetros de URL	hashkey_args: A lista de parâmetros a serem retidos. Separe vários parâmetros com vírgulas (,). Você pode especificar até 10 parâmetros. disable: Defina como on para ignorar todos os parâmetros ou off para não ignorá-los. Ignorar todos os parâmetros na chave de cache tem uma prioridade menor do que reter parâmetros específicos. keep_oss_args: Defina como on para reter todos os parâmetros para solicitações de back-to-origin, ou off para usar os mesmos parâmetros da chave de cache.
aliauth: Autenticação do Alibaba Cloud	auth_type: O tipo de autenticação. no_auth: sem autenticação. type_a: Método de autenticação A. type_b: Método de autenticação B. type_c: Método de autenticação C. auth_key1: Chave de autenticação 1. auth_key2: Chave de autenticação 2. ali_auth_delta: O período de carência de autenticação personalizado.
set_resp_header: Definir cabeçalhos de resposta HTTP (visíveis para navegadores)	key (Obrigatório): O cabeçalho de resposta. value (Obrigatório): O conteúdo do cabeçalho de resposta. Para excluir o cabeçalho, defina isso como null. header_operation_type: A operação no cabeçalho de solicitação. Valores válidos: add, delete, modify e rewrite. duplicate: Especifica se permite duplicatas. Valores válidos: on ou off. header_source: O cabeçalho a ser encontrado. header_destination: O cabeçalho a ser substituído. match_all: Especifica se corresponde a todos. Valores válidos: on ou off.
https_force: Forçar redirecionamento HTTPS	enable: A chave para o recurso. Valores válidos: on ou off.
http_force: Forçar redirecionamento HTTP	enable: A chave para o recurso. Valores válidos: on ou off.
https_option: Parâmetros básicos de HTTPS	http2: A chave do HTTP/2. Valores válidos: on ou off. ocsp_stapling: A chave do Online Certificate Status Protocol (OCSP) Stapling. Valores válidos: on ou off.
forward_scheme: Seguir protocolo para solicitações de back-to-origin	enable: A chave. Valores válidos: on ou off. scheme_origin: O protocolo para solicitações de back-to-origin. Valores válidos: http, https e follow.
dynamic: Configurações relacionadas ao DCDN	enable (Obrigatório): A chave. Valores válidos: on ou off. static_route_type: As extensões de arquivo para aceleração estática. static_route_url: O URI para aceleração estática. static_route_path: O caminho para aceleração estática. dynamic_route_origin: O esquema para a rota de back-to-origin. Valores válidos: http, https, follow e follow-port. dynamic_route_round_robin: A chave para balanceamento de carga. Valores válidos: on ou off. dynamic_route_adapt_cache: A chave para cache adaptativo. Valores válidos: on ou off.
set_req_header: Cabeçalhos HTTP personalizados de back-to-origin	key: O cabeçalho de back-to-origin. value: O conteúdo do cabeçalho de back-to-origin.
l2_oss_key: Solicitações de back-to-origin para buckets privados do Alibaba Cloud OSS	private_oss_auth: A chave para solicitações de back-to-origin para buckets privados. Valores válidos: on ou off.
range: Solicitações de back-to-origin baseadas em intervalo	enable: A chave. Valores válidos: on e off.
video_seek: Busca de vídeo	enable (Obrigatório): A chave. Valores válidos: on ou off. flv_seek_by_time: Ativa a busca por tempo para arquivos FLV. Valores válidos: on ou off. mp4_seek_start: O parâmetro de início personalizado para busca de MP4. mp4_seek_end: O parâmetro de fim personalizado para busca de MP4. flv_seek_start: O parâmetro de início personalizado para busca de FLV. flv_seek_end: O parâmetro de fim personalizado para busca de FLV.
websocket: WebSocket	enabled (Obrigatório): Especifica se deve ativar o WebSocket. Valores válidos: on ou off. origin_scheme: O esquema para solicitações de back-to-origin. Valores válidos: http, https e follow. heartbeat: O intervalo de heartbeat. Valor padrão: 60. Unidade: segundos. Valores válidos: 1 a 300.
ali_remove_args: Ignorar parâmetros de URL (excluir)	ali_remove_args (Obrigatório): Os parâmetros a serem excluídos. Separe vários parâmetros com espaços. Os parâmetros restantes são usados como argumentos de URL na chave de cache. keep_oss_args: Especifica se deve reter parâmetros para solicitações de back-to-origin. Valores válidos: on e off. on indica que todos os parâmetros são retidos. off indica que os parâmetros são os mesmos da chave de cache.
https_tls_version: Versões do protocolo TLS	tls10: Ativa o TLSv1.0. Valor padrão: on. Valores válidos: on ou off. tls11: Ativa o TLSv1.1. Valor padrão: on. Valores válidos: on ou off. tls12: Ativa o TLSv1.2. Valor padrão: on. Valores válidos: on ou off. tls13: Ativa o TLSv1.3. Valor padrão: off. Valores válidos: on ou off.
HSTS: HTTP Strict Transport Security (HSTS)	enabled (Obrigatório): A chave. Valor padrão: off. Valores válidos: on ou off. https_hsts_max_age (Obrigatório): O tempo de expiração. Unidade: ms. Recomenda-se um valor de 5184000000 ms (60 dias). https_hsts_include_subdomains: Especifica se o cabeçalho HSTS inclui o parâmetro includeSubDomains. Valores válidos: on ou off. Ative este recurso com cautela. Antes de ativá-lo, certifique-se de que o HTTPS esteja ativado para todos os subdomínios do nome de domínio acelerado. Caso contrário, os subdomínios ficarão inacessíveis após serem redirecionados para HTTPS.
filetype_force_ttl_code: Tempo de expiração de códigos de status para tipos de arquivo	file_type (Obrigatório): O tipo de arquivo. Separe vários tipos de arquivo com vírgulas (,), por exemplo, TXT,JPG. code_string (Obrigatório): O código de status. Separe vários códigos de status com vírgulas (,). Por exemplo: 302=0,301=0,4xx=2.
path_force_ttl_code: Tempo de expiração de códigos de status para caminhos	path (Obrigatório): O caminho deve começar com uma barra (/), por exemplo, /image. code_string (Obrigatório): O código de status. Separe vários códigos de status com vírgulas (,). Por exemplo: 302=0,301=0,4xx=2.
gzip: Compactação inteligente	enable (Obrigatório): A chave para o recurso. Valores válidos: on ou off.
tesla: Otimização de HTML	enable (Obrigatório): A chave para o recurso. Valores válidos: on ou off. trim_js: Valores válidos: on ou off. Se você ativar este recurso, o código JavaScript incorporado nas páginas HTML será otimizado. trim_css: Valores válidos: on ou off. Se você ativar este recurso, o código CSS incorporado nas páginas HTML será otimizado.
https_origin_sni: SNI de back-to-origin	enabled: A chave para o recurso. Valores válidos: on ou off. https_origin_sni (Obrigatório): O SNI de back-to-origin.
protogw: Aceleração de aplicativo IP	realip (Obrigatório): O método para transmitir o endereço IP de origem. Valores válidos: off, toa e pp. port (Obrigatório): A porta de serviço. pattern: A string de padrão.
host_redirect: Recurso de reescrita	regex: A URL a ser reescrita. Por exemplo: ^/$. replacement: A URL de destino. Por exemplo: /go/act/sale/tbzlsy.php. flag: Apenas redirect e break são suportados.
forward_timeout: Período de tempo limite para solicitações de back-to-origin	forward_timeout: O período de tempo limite. Unidade: segundos. Não defina isso com um valor maior que 100 segundos.
ipv6: Configuração de IPv6	switch (Obrigatório): A chave. Valores válidos: on (ativa o IPv6) e off (desativa o IPv6). region: A região onde o IPv6 está ativado. O asterisco (*) é suportado.
edge_function: EdgeScript	rule (Obrigatório): A regra DSL. pri (Obrigatório): A prioridade. enable (Obrigatório): Especifica se a regra é efetiva. Valores válidos: on ou off. name: O nome da regra. pos: A posição onde a regra é executada. Para nomes de domínio DCDN, apenas head é suportado. foot não é suportado. brk: Se esta regra for atingida, as regras restantes na posição de execução atual serão ignoradas. option: Controle de opção. grammar: Controle de gramática. Valores opcionais: empty, es2 e js. jsmode: Controle de lista de permissões de nome de domínio JS. Valores opcionais: redirect e bypass.
brotli: Compactação Brotli	enable (Obrigatório): A chave para o recurso. Valores válidos: on ou off. brotli_level: O nível de compactação. Valores válidos: 1 a 11.
ali_ua: Lista de bloqueios/permissões de User-Agent	ua: O User-Agent. type: O tipo de lista. Valores válidos: black ou white.

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 status. Valid values: success: The operation was successful. testing: The feature is being tested. failed: The operation failed. configuring: The feature is being configured.	success
ParentId	string	The ID of the advanced condition configuration.	1234567
ConfigId	string	The configuration ID.	5068995
FunctionName	string	The feature name.	set_req_host_header
FunctionArgs	object
FunctionArg	array<object>	The feature configuration.
	object
ArgName	string	The configuration name.	ttl
ArgValue	string	The configuration value.	13

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ParentId": "1234567",
        "ConfigId": "5068995",
        "FunctionName": "set_req_host_header",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "ttl",
              "ArgValue": "13"
            }
          ]
        }
      }
    ]
  }
}

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.	The specified configuration is not supported.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.