Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2022-12-26 GMT+08:00

Consulta de configuração de nome de domínio

Função

Esta API é usada para consultar a configuração do nome de domínio, incluindo cabeçalho de solicitação de recuperação, cabeçalho HTTP, autenticação de URL, certificado, servidor de origem, protocolo de recuperação, forçar redirecionamento, compressão inteligente, parâmetro de URL de cache, IPv6, idade do cache de código de status, Recuperação baseada em intervalo, lista negra ou lista branca do agente do usuário, reescrita de URL de solicitação de recuperação e configurações de página de erro personalizadas.

URI

GET /v1.1/cdn/configuration/domains/{domain_name}/configs

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

domain_name

Sim

String

Nome de domínio.

Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

enterprise_project_id

Não

String

Projeto corporativo ao qual o recurso pertence. Este parâmetro é válido somente quando a função do projeto empresarial está ativada. O valor all indica todos os projetos. Esse parâmetro é obrigatório quando você usa um usuário do IAM para chamar essa API.

Parâmetros de solicitação

Tabela 3 Parâmetros do cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário.

O token pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário.

Parâmetros de resposta

Código de estado: 200

Tabela 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

configs

ConfigsGetBody object

Itens de configuração.

Tabela 5 ConfigsGetBody

Parâmetro

Tipo

Descrição

origin_request_header

Array of OriginRequestHeader objects

Configuração do cabeçalho da solicitação de recuperação.

http_response_header

Array of HttpResponseHeader objects

Configuração de cabeçalho HTTP.

url_auth

UrlAuthGetBody object

Assinatura de URL.

https

HttpGetBody object

Configuração do certificado.

sources

Array of SourcesConfig objects

Configurações do servidor de origem.

origin_protocol

String

Protocolo de recuperação de conteúdo. Valores possíveis: follow (o mesmo que as solicitações do usuário), http (HTTP, valor padrão) e https (HTTPS).

force_redirect

ForceRedirectConfig object

Forçar redirecionamento.

compress

Compress object

Compressão inteligente.

cache_url_parameter_filter

CacheUrlParameterFilter object

Configurações para parâmetros de URL em cache.

ipv6_accelerate

Integer

Configurações IPv6 (1: ativado; 0: desativado).

error_code_cache

Array of ErrorCodeCache objects

Idade da cache do código de estado.

origin_range_status

String

Recuperação baseada em intervalo, ou seja, recuperação de conteúdo baseada em segmento. Para ativar a recuperação baseada em intervalo, o servidor de origem deve suportar solicitações de intervalo, ou seja, solicitações com o campo intervalo nos cabeçalhos. Caso contrário, a recuperação de conteúdo pode falhar. on: ative-o. off: desative-o.

user_agent_filter

UserAgentFilter object

Lista negra ou lista branca do Usuário-Agente.

origin_request_url_rewrite

Array of OriginRequestUrlRewrite objects

Reescrita de URL de solicitação de recuperação. Até 20 URLs podem ser configurados.

error_code_redirect_rules

Array of ErrorCodeRedirectRules objects

Página de erro personalizada.

Tabela 6 OriginRequestHeader

Parâmetro

Tipo

Descrição

name

String

Cabeçalho da solicitação de recuperação. Um cabeçalho contém de 1 a 64 caracteres, incluindo letras, dígitos e hifens (-).

value

String

Valor do cabeçalho da solicitação de recuperação. Este parâmetro é opcional para a operação de exclusão. Um valor contém de 1 a 512 caracteres. Variáveis, por exemplo, $client_ip e $remote_port, não são suportadas.

action

String

Tipo de operação do cabeçalho da solicitação de recuperação. O valor pode ser delete ou set. set: se o cabeçalho não existir na solicitação de recuperação original, adicione o cabeçalho antes de definir seu valor.

Tabela 7 HttpResponseHeader

Parâmetro

Tipo

Descrição

name

String

Cabeçalho de resposta HTTP. Valores possíveis: Content-Disposition, Content-Language, Access-Control-Allow-Origin, Access-Control-Allow-Methods, Access-Control-Max-Age, Access-Control-Expose-Headers ou cabeçalhos personalizados. Um cabeçalho contém de 1 a 100 caracteres, incluindo letras, dígitos e hífens (-) e começa com uma letra.

value

String

Valor do cabeçalho da resposta HTTP. Um valor contém de 1 a 256 caracteres, incluindo letras, dígitos e caracteres especiais (.-_*#!%&+|^~'"/:;,=@?).

action

String

Tipo de operação do cabeçalho de resposta HTTP. O valor pode ser definido ou excluído. Alguns cabeçalhos só podem ser definidos. Alguns cabeçalhos personalizados não podem ser excluídos ou definidos.

Tabela 8 UrlAuthGetBody

Parâmetro

Tipo

Descrição

status

String

Status do método de assinatura de URL A/B/C. O valor pode ser off ou on.

Tipo

Cadeia

Método de assinatura. type_a: método A. type_b: método B. type_c1: método C1. type_c2: método C2.

time_format

String

Formato da hora. dec: decimal. hex: hexadecimal. O método A suporta apenas o formato decimal. O método B suporta apenas o formato decimal. Método C1 suporta apenas o formato hexadecimal. O método C2 suporta os formatos decimal e hexadecimal.

expire_time

Integer

Tempo de expiração. O valor varia de 0 a 31536000, em segundos.

Tabela 9 HttpGetBody

Parâmetro

Tipo

Descrição

https_status

String

Se deve ativar o HTTPS. on: ativado; off: desativado.

certificate_name

String

Nome do certificado. O valor contém de 3 a 32 caracteres. Este parâmetro é retornado quando um certificado é configurado.

certificate_value

String

Conteúdo do certificado usado pelo protocolo HTTPS. Este parâmetro é retornado quando um certificado é configurado. O valor está no formato PEM.

certificate_source

Integer

Tipo de certificado. 1: certificado gerenciado pela Huawei; 0: seu próprio certificado. Valor padrão: 0. Este parâmetro é retornado quando um certificado é configurado.

http2_status

String

Se o HTTP/2 é usado. on: sim; off: não.

tls_version

String

Segurança da Camada de Transporte (TLS). Atualmente, TLSv1.0, TLSv1.1, TLSv1.2 e TLSv1.3 são suportados. Este parâmetro é retornado quando um certificado é configurado. Por padrão, todas as versões do TLS estão ativadas. Pelo menos uma versão deve ser ativada.

Tabela 10 SourcesConfig

Parâmetro

Tipo

Descrição

origin_addr

String

Endereço IP ou nome de domínio do servidor de origem.

origin_type

String

Tipo de servidor de origem. Valores possíveis: ipaddr (endereço IP do servidor de origem), domain (nome de domínio do servidor de origem), e obs_bucket (nome de domínio de um bucket OBS).

priority

Integer

Prioridade do servidor de origem. Valores possíveis: 70 (primário) e 30 (em espera).

obs_web_hosting_status

String

Se deve ativar a hospedagem de sites estáticos para o bucket do OBS. Este parâmetro é obrigatório quando o tipo de servidor de origem é obs_bucket. Valores possíveis: off (desativado) e on (ativado).

http_port

Integer

Porta de HTTP. Valor padrão: 80.

https_port

Integer

Porta de HTTPS. Valor padrão: 443.

host_name

String

Host de recuperação. O valor padrão é o nome de domínio de aceleração.

Tabela 11 ForceRedirectConfig

Parâmetro

Tipo

Descrição

status

String

Se ativar o redirecionamento de força. Valores possíveis: on (ativado) e off (desativado).

type

String

Forçar o tipo de redirecionamento. Valores possíveis: http (forçar redirecionamento para HTTP) e https (forçar redirecionamento para HTTPS).

Tabela 12 Compactar

Parâmetro

Tipo

Descrição

status

String

Se para ativar a compactação inteligente. Valores possíveis: on (ativado) e off (desativado).

type

String

Tipo de compressão inteligente. Valores possíveis: gzip (gzip) e br (Brotli).

Tabela 13 CacheUrlParameterFilter

Parâmetro

Tipo

Descrição

type

String

Tipo de operação para parâmetros de URL de cache. full_url: cache de todos os parâmetros; ignore_url_params: ignore todos os parâmetros; del_args: ignore parâmetros específicos de URL; reserve_args: reserve parâmetros especificados de URL.

value

String

Valores dos parâmetros. Vários valores são separados por ponto-e-vírgula (;).

Tabela 14 ErrorCodeCache

Parâmetro

Tipo

Descrição

code

Integer

Os códigos de erro 400, 403, 404, 405, 414, 500, 501, 502, 503 e 504 estão disponíveis.

ttl

Integer

Código de erro idade do cache, em segundos. O valor varia de 0 a 31.536.000 por padrão (365 dias por ano por padrão).

Tabela 15 UserAgentFilter

Parâmetro

Tipo

Descrição

type

String

Tipo de lista negra ou lista branca do agente de usuário. off: a lista negra e a lista branca do agente de usuário estão desabilitadas. black: lista negra do agente de usuário. white: lista branca do agente de usuário.

value

String

Lista negra ou lista branca do agente de usuário. Este parâmetro é opcional quando type é definido como off. Até 10 regras podem ser configuradas. Uma única regra contém até 100 caracteres. As regras são separadas por vírgulas (,).

Tabela 16 OriginRequestUrlRewrite

Parâmetro

Tipo

Descrição

priority

Integer

Prioridade de uma regra de reescrita de URL. A prioridade de uma regra é obrigatória e deve ser única. A regra com a prioridade mais alta será usada para combinar primeiro. A prioridade é um número inteiro que varia de 1 a 100. Um número maior indica uma prioridade maior.

match_type

String

Tipo de correspondência. all: todos os arquivos. file_path: caminho do URL. wildcard

source_url

String

URL a ser reescrita. Um URL começa com uma barra (/) e não contém http://, https://, nem o nome do domínio. Um URL contém até 512 caracteres. Os curingas (*) são suportados, por exemplo, /test/*/*.mp4. Quando o modo de partida é caminho, as cadeias de consulta no URL original serão removidas após a reescrita.

target_url

String

Um URL começa com uma barra (/) e não contém http://, https://, nem o nome do domínio. Um URL contém até 256 caracteres. O enésimo campo curinga (*) pode ser substituído por $n, onde n = 1, 2, 3..., por exemplo, /newtest/$1/$2.jpg.

Tabela 17 ErrorCodeRedirectRules

Parâmetro

Tipo

Descrição

error_code

String

Código de erro de redirecionamento. Atualmente, os seguintes códigos de status são suportados: 4xx: 400, 403, 404, 405, 414, 416, 451 5xx: 500, 501, 502, 503, 504

target_code

String

Código de status de redirecionamento. O valor pode ser 301 ou 302.

target_link

String

URL de destino para redirecionamento.

Exemplos de solicitações

GET https://cdn.myhuaweicloud.com/v1.1/cdn/configuration/domains/www.test.com/configs

Exemplo de respostas

Código de estado: 200

OK

{
  "configs" : {
    "origin_request_header" : [ ],
    "http_response_header" : [ ],
    "https" : {
      "https_status" : "off"
    },
    "url_auth" : {
      "status" : "off"
    },
    "compress" : {
      "status" : "off"
    },
    "force_redirect" : {
      "status" : "on",
      "type" : "http"
    },
    "origin_protocol" : "follow",
    "sources" : [ {
      "origin_addr" : "192.168.1.1",
      "origin_type" : "ipaddr",
      "priority" : 70,
      "http_port" : 80,
      "https_port" : 443
    } ],
    "cache_url_parameter_filter" : {
      "type" : "del_args",
      "value" : "key1;key2"
    }
  }
}

Códigos de estado

Código de estado

Descrição

200

OK

Códigos de erro

Consulte Códigos de erro.