Consulta de la configuración del nombre de dominio
Función
Esta API se utiliza para consultar la configuración del nombre de dominio, incluyendo encabezado de solicitud de recuperación, encabezado HTTP, autenticación de URL, certificado, servidor de origen, protocolo de recuperación, redirección forzada, compresión inteligente, parámetro URL de caché, IPv6, edad de caché de código de estado, Recuperación basada en rango, lista negra o lista blanca de agente de usuario, reescritura de URL de solicitud de recuperación y configuración de página de error personalizada.
URI
GET /v1.1/cdn/configuration/domains/{domain_name}/configs
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
domain_name |
Sí |
String |
Nombre de dominio. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
enterprise_project_id |
No |
String |
Proyecto de empresa al que pertenece el recurso. Este parámetro sólo es válido cuando la función de proyecto de empresa está habilitada. El valor all indica todos los proyectos. Este parámetro es obligatorio cuando se utiliza un usuario de IAM para llamar a esta API. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. El token se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
configs |
ConfigsGetBody object |
Elementos de configuración. |
Parámetro |
Tipo |
Descripción |
---|---|---|
origin_request_header |
Array of OriginRequestHeader objects |
Configuración de encabezado de solicitud de recuperación. |
http_response_header |
Array of HttpResponseHeader objects |
Configuración de encabezado HTTP. |
url_auth |
UrlAuthGetBody object |
Firma de URL. |
https |
HttpGetBody object |
Configuración del certificado. |
sources |
Array of SourcesConfig objects |
Configuración del servidor de origen. |
origin_protocol |
String |
Protocolo de recuperación de contenido. Valores posibles: follow (igual que las peticiones del usuario), http (HTTP, valor predeterminado) y https (HTTPS). |
force_redirect |
ForceRedirectConfig object |
Forzar redireccionamiento. |
compress |
Compress object |
Compresión inteligente. |
cache_url_parameter_filter |
CacheUrlParameterFilter object |
Configuración para almacenar en caché los parámetros de URL. |
ipv6_accelerate |
Integer |
Configuración de IPv6 (1: habilitado; 0: deshabilitado). |
error_code_cache |
Array of ErrorCodeCache objects |
Vigencia de la caché del código de estado. |
origin_range_status |
String |
Recuperación basada en rango, es decir, recuperación de contenido basada en segmentos. Para habilitar la recuperación basada en rango, el servidor de origen debe admitir solicitudes de rango, es decir, solicitudes con el campo Rango en los encabezados. De lo contrario, la recuperación de contenido puede fallar. on: Habilitarlo. off: Desactivarlo. |
user_agent_filter |
UserAgentFilter object |
Lista negra o lista blanca del agente de usuario. |
origin_request_url_rewrite |
Array of OriginRequestUrlRewrite objects |
Reescritura de URL de solicitud de recuperación. Se pueden configurar hasta 20 URLs. |
error_code_redirect_rules |
Array of ErrorCodeRedirectRules objects |
Página de error personalizada. |
Parámetro |
Tipo |
Descripción |
---|---|---|
name |
String |
Encabezado de solicitud de recuperación. Un encabezado contiene de 1 a 64 caracteres, incluyendo letras, dígitos y guiones (-). |
value |
String |
Valor del encabezado de solicitud de recuperación. Este parámetro es opcional para la operación de eliminación. Un valor contiene de 1 a 512 caracteres. Las variables, por ejemplo, $client_ip y $remote_port, no son compatibles. |
action |
String |
Tipo de operación del encabezado de solicitud de recuperación.El valor se puede eliminar o establecer. set: Si el encabezado no existe en la solicitud de recuperación original, agregue el encabezado antes de establecer su valor. |
Parámetro |
Tipo |
Descripción |
---|---|---|
name |
String |
Encabezado de respuesta HTTP. Valores posibles: Content-Disposition, Content-Language, Access-Control-Allow-Origin, Access-Control-Allow-Methods, Access-Control-Max-Age, Access-Control-Expose-Headers, o custom headers. Un encabezado contiene de 1 a 100 caracteres, incluyendo letras, dígitos y guiones (-) y comienza con una letra. |
value |
String |
Valor del encabezado de respuesta HTTP. Un valor contiene de 1 a 256 caracteres, incluidas letras, dígitos y caracteres especiales (.-_*#!%&+|^~'/:;,=@?). |
action |
String |
Tipo de operación del encabezado de respuesta HTTP. El valor se puede establecer o eliminar. Algunos encabezados solo se pueden establecer. Algunos encabezados personalizados no se pueden eliminar ni establecer. |
Parámetro |
Tipo |
Descripción |
---|---|---|
status |
String |
Estado del método de firma de URL A/B/C. El valor puede estar off o on. |
type |
String |
Método de firma. type_a: método A. type_b: método B. type_c1: método C1. type_c2: método C2. |
time_format |
String |
Formato de tiempo. dec: decimal. hex: hexadecimal. El método A solo admite el formato decimal. El método B solo admite el formato decimal. El método C1 solo admite el formato hexadecimal. El método C2 soporta formatos decimales y hexadecimal. |
expire_time |
Integer |
Tiempo de caducidad. El valor varía de 0 a 31536000, en segundos. |
Parámetro |
Tipo |
Descripción |
---|---|---|
https_status |
String |
Si se debe habilitar HTTPS. on: activado; off: desactivado. |
certificate_name |
String |
Nombre del certificado. El valor contiene de 3 a 32 caracteres. Este parámetro se devuelve cuando se configura un certificado. |
certificate_value |
String |
Contenido del certificado utilizado por el protocolo HTTPS. Este parámetro se devuelve cuando se configura un certificado. El valor está en formato PEM. |
certificate_source |
Integer |
Tipo de certificado. 1: certificado gestionado por Huawei; 0: su propio certificado. Valor predeterminado: 0. Este parámetro se devuelve cuando se configura un certificado. |
http2_status |
String |
Si se utiliza HTTP/2. on: sí; off: no. |
tls_version |
String |
Seguridad de la capa de transporte (TLS). Actualmente, TLSv1.0, TLSv1.1, TLSv1.2, y TLSv1.3 son compatibles. Este parámetro se devuelve cuando se configura un certificado. De forma predeterminada, todas las versiones de TLS están habilitadas. Al menos una versión debe estar habilitada. |
Parámetro |
Tipo |
Descripción |
---|---|---|
origin_addr |
String |
Dirección IP o nombre de dominio del servidor de origen. |
origin_type |
String |
Tipo de servidor de origen. Valores posibles: ipaddr (dirección IP del servidor de origen), domain (nombre de dominio del servidor de origen), andobs_bucket (nombre de dominio de un bucket OBS). |
priority |
Integer |
Prioridad de servidor de origen. Valores posibles: 70 (primario) y 30 (en espera). |
obs_web_hosting_status |
String |
Si desea habilitar el alojamiento de sitios web estático para el bucket OBS. Este parámetro es obligatorio cuando el tipo de servidor de origen es obs_bucket. Valores posibles: off (deshabilitado) y on (habilitado). |
http_port |
Integer |
Puerto HTTP. Valor predeterminado: 80. |
https_port |
Integer |
Puerto HTTPS. Valor predeterminado: 443. |
host_name |
String |
Host de recuperación. El valor predeterminado es el nombre de dominio de aceleración. |
Parámetro |
Tipo |
Descripción |
---|---|---|
status |
String |
Si se debe activar la redirección forzada. Valores posibles: on (activado) y off (desactivado). |
type |
String |
Forzar el tipo de redirección. Valores posibles: http (forzar la redirección a HTTP) y https (forzar la redirección a HTTPS). |
Parámetro |
Tipo |
Descripción |
---|---|---|
status |
String |
Ya sea para habilitar la compresión inteligente. Valores posibles: on (activado) y off (desactivado). |
type |
String |
Tipo de compresión inteligente. Valores posibles: gzip (gzip) y br (Brotli). |
Parámetro |
Tipo |
Descripción |
---|---|---|
type |
String |
Tipo de operación para almacenar en caché los parámetros de URL. full_url: cache todos los parámetros; ignore_url_params: ignore todos los parámetros; del_args: ignore parámetros de URL específicos; reserve_args: parámetros de URL especificados de reserva. |
value |
String |
Valores de parámetros. Múltiples valores están separados por punto y coma (;). |
Parámetro |
Tipo |
Descripción |
---|---|---|
code |
Integer |
Los códigos de error 400, 403, 404, 405, 414, 500, 501, 502, 503 y 504 están disponibles. |
ttl |
Integer |
Vigencia de la caché del código de error, en segundos. El valor oscila entre 0 y 31,536,000 de forma predeterminada (365 días al año). |
Parámetro |
Tipo |
Descripción |
---|---|---|
type |
String |
Tipo de lista negra o blanca de agente de usuario. off: La lista negra y la lista blanca del agente de usuario están deshabilitadas. black: Lista negra del agente de usuario. white: Lista blanca del agente de usuario. |
value |
String |
Lista negra o lista blanca del agente de usuario. Este parámetro es opcional cuando type se establece en off. Se pueden configurar hasta 10 reglas. Una sola regla contiene hasta 100 caracteres. Las reglas están separadas por comas (,). |
Parámetro |
Tipo |
Descripción |
---|---|---|
priority |
Integer |
Prioridad de una regla de reescritura de URL. La prioridad de una regla es obligatoria y debe ser única. La regla con la prioridad más alta se usará primero para hacer coincidir. La prioridad es un entero que oscila entre 1 y 100. Un número mayor indica una prioridad más alta. |
match_type |
String |
Tipo de coincidencia. all: todos los archivos. file_path: ruta URL. wildcard |
source_url |
String |
URL que se va a reescribir. Una URL comienza con una barra (/) y no contiene http://, https://, ni el nombre de dominio. Una URL contiene hasta 512 caracteres. Se admiten comodines (*), por ejemplo, /test/*/*.mp4. Cuando el modo de coincidencia es Path, las cadenas de consulta de la URL original se eliminarán después de reescribir. |
target_url |
String |
Una URL comienza con una barra (/) y no contiene http://, https://, ni el nombre de dominio. Una URL contiene hasta 256 caracteres. El campo n-ésimo comodín (*) se puede sustituir por $n, donde n = 1, 2, 3..., por ejemplo, /newtest/$1/$2.jpg. |
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error de redirección. Actualmente, se admiten los siguientes códigos de estado: 4xx: 400, 403, 404, 405, 414, 416, 451 5xx: 500, 501, 502, 503, 504 |
target_code |
String |
Código de estado de redirección. El valor puede ser 301 o 302. |
target_link |
String |
URL de destino para redireccionamiento. |
Solicitudes de ejemplo
GET https://cdn.myhuaweicloud.com/v1.1/cdn/configuration/domains/www.test.com/configs
Ejemplo de respuestas
Status code: 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 |
Descripción |
---|---|
200 |
OK |
Códigos de error
Consulte Códigos de error.