Modificação da configuração completa do domínio
Função
Esta API é usada para modificar a configuração completa 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, redirecionamento de força, compressão inteligente, parâmetro de URL de cache, IPv6, idade de 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
PUT /v1.1/cdn/configuration/domains/{domain_name}/configs
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
domain_name |
Sim |
String |
Especifica o nome de domínio acelerado. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
enterprise_project_id |
Não |
String |
Projeto corporativo ao qual pertence o nome de domínio a ser modificado. 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
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Especifica o token do usuário. The token can be obtained by calling the IAM API used to obtain a user token. The value of **X-Subject-Token** in the response header is the user token. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
configs |
Não |
Configs object |
Itens de configuração. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
origin_request_header |
Não |
Array of OriginRequestHeader objects |
Configurações de cabeçalho de solicitação de recuperação. As configurações originais de todos os cabeçalhos serão sobrescritas. Ao usar essa API, faça o upload das informações de todos os cabeçalhos. |
http_response_header |
Não |
Array of HttpResponseHeader objects |
Configurações de cabeçalho de HTTP. As configurações originais de todos os cabeçalhos serão sobrescritas. Ao usar essa API, faça o upload das informações de todos os cabeçalhos. |
url_auth |
Não |
UrlAuth object |
Assinatura de URL. |
https |
Não |
HttpPutBody object |
Configuração do certificado. |
sources |
Não |
Array of SourcesConfig objects |
Configurações do servidor de origem. |
origin_protocol |
Não |
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 |
Não |
ForceRedirectConfig object |
Forçar redirecionamento. |
compress |
Não |
Compress object |
Compressão inteligente. |
cache_url_parameter_filter |
Não |
CacheUrlParameterFilter object |
Configurações para parâmetros de URL em cache. |
ipv6_accelerate |
Não |
Integer |
Configurações IPv6 (1: ativado; 0: desativado). |
error_code_cache |
Não |
Array of ErrorCodeCache objects |
Idade da cache do código de estado. |
origin_range_status |
Não |
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 |
Não |
UserAgentFilter object |
Lista negra ou lista branca do agente de usuário. |
origin_request_url_rewrite |
Não |
Array of OriginRequestUrlRewrite objects |
Reescrita de URL de solicitação de recuperação. Até 20 URLs podem ser configurados. |
error_code_redirect_rules |
Não |
Array of ErrorCodeRedirectRules objects |
Página de erro personalizada. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
name |
Sim |
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 |
Não |
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 |
Sim |
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. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
name |
Sim |
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 |
Não |
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 |
Sim |
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. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
status |
Sim |
String |
Status do método de assinatura de URL A/B/C. O valor pode ser desligado ou ligado. |
type |
Não |
String |
Método de sinalização type_a:Método A type_b:Método B type_c1:Método C1 type_c2:Método C2 |
key |
Não |
String |
Uma chave de autenticação contém de 6 a 32 caracteres, incluindo letras e dígitos. |
time_format |
Não |
String |
Formato da hora. dec:Decimal hex:Hexadecimal Método A: somente o formato decimal é suportado. Método B: apenas o formato decimal é suportado. Método C1: apenas o formato hexadecimal é suportado. Método C2: os formatos decimal e hexadecimal são suportados. |
expire_time |
Não |
Integer |
Tempo de expiração. O valor varia de 0 a 31536000, em segundos. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
https_status |
Não |
String |
Se deve ativar o HTTPS. on: ativado; off: desativado. |
certificate_name |
Não |
String |
Nome do certificado. O valor contém de 3 a 32 caracteres. Este parâmetro é obrigatório quando um certificado é configurado. |
certificate_value |
Não |
String |
Conteúdo do certificado usado pelo protocolo HTTPS. Este parâmetro é obrigatório quando um certificado é configurado. O valor está no formato PEM. |
private_key |
Não |
String |
Chave privada usada pelo protocolo HTTPS. Este parâmetro é obrigatório quando um certificado é configurado. O valor está no formato PEM. |
certificate_source |
Não |
Integer |
Tipo de certificado. 1: certificado gerenciado pela Huawei; 0: seu próprio certificado. Valor padrão: 0. Este parâmetro é obrigatório quando um certificado é configurado. |
http2_status |
Não |
String |
Se o HTTP/2 é usado. on: sim; off: não. Valor padrão: off. Quando https_status é definido como off, este parâmetro não tem efeito. |
tls_version |
Não |
String |
Segurança da Camada de Transporte (TLS). Atualmente, TLSv1.0, TLSv1.1, TLSv1.2 e TLSv1.3 são suportados. Por padrão, todas as versões são ativadas. Você pode ativar uma única versão ou versões consecutivas. Para habilitar várias versões, use vírgulas (,) para separar versões, por exemplo, TLSv1.1,TLSv1.2. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
origin_addr |
Sim |
String |
Endereço IP ou nome de domínio do servidor de origem. |
origin_type |
Sim |
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 |
Sim |
Integer |
Prioridade do servidor de origem. Valores possíveis: 70 (primário) e 30 (em espera). |
obs_web_hosting_status |
Não |
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 |
Não |
Integer |
Porta de HTTP. Valor padrão: 80. |
https_port |
Não |
Integer |
Porta de HTTPS. Valor padrão: 443. |
host_name |
Não |
String |
Host de recuperação. O valor padrão é o nome de domínio de aceleração. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
status |
Sim |
String |
Se ativar o redirecionamento de força. Valores possíveis: on (ativado) e off (desativado). |
type |
Não |
String |
Forçar o tipo de redirecionamento. Valores possíveis: http (forçar redirecionamento para HTTP) e https (forçar redirecionamento para HTTPS). |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
status |
Sim |
String |
Se para ativar a compactação inteligente. Valores possíveis: on (ativado) e off (desativado). |
type |
Não |
String |
Tipo de compressão inteligente. Valores possíveis: gzip (gzip) e br (Brotli). |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
type |
Não |
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 |
Não |
String |
Valores dos parâmetros. Vários valores são separados por ponto-e-vírgula (;). |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
code |
Não |
Integer |
Os códigos de erro 400, 403, 404, 405, 414, 500, 501, 502, 503 e 504 estão disponíveis. |
ttl |
Não |
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). |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
type |
Sim |
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 |
Não |
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 (,). |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
priority |
Sim |
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 |
Sim |
String |
Tipo de correspondência. all: todos os arquivos. file_path: Caminho do URL. wildcard |
source_url |
Não |
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 |
Sim |
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. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
error_code |
Sim |
String |
Código de erro de redireccionamento. 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 |
Sim |
String |
Código de status de redirecionamento. O valor pode ser 301 ou 302. |
target_link |
Sim |
String |
URL de destino para redirecionamento. |
Parâmetros de resposta
Nenhum
Exemplos de solicitações
{ "configs" : { "origin_request_header" : [ { "name" : "test_name", "value" : "test_value", "action" : "set" } ], "http_response_header" : [ { "name" : "test_name", "value" : "test_value", "action" : "set" } ], "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 } ] } }
Exemplo de respostas
Nenhum
Códigos de estado
Código de estado |
Descrição |
---|---|
204 |
OK |
Códigos de erro
Consulte Códigos de erro.