Consulta de nombres de dominio
Función
Esta API se utiliza para consultar nombres de dominio acelerados.
URI
GET /v1.0/cdn/domains
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
domain_name |
No |
String |
Especifica el nombre de dominio acelerado, que coincide de manera difusa. El valor contiene de 1 a 255 caracteres. |
business_type |
No |
String |
Especifica el tipo de servicio del nombre de dominio acelerado. Valores posibles: - web (aceleración de entrega de imágenes y archivos pequeños) - download (aceleración de descarga de archivos grandes) - video (aceleración de audio y vídeo bajo demanda) - wholeSite (aceleración de todo el sitio) |
domain_status |
No |
String |
Especifica el estado del nombre de dominio acelerado. Valores posibles: - online: CDN ha sido habilitado para este nombre de dominio. - offline: CDN ha sido deshabilitado para este nombre de dominio. - configuring: La configuración del nombre de dominio está en curso. - *configure_failed: La configuración falla. - checking: Se está revisando el dominio. - check_failed: El dominio falla la revisión. - deleting: se está eliminando el nombre de dominio. |
service_area |
No |
String |
Especifica el área cubierta por el servicio de aceleración. Valores posibles: - mainland_china: China continental. outside_mainland_china: fuera de China continental. - global: global. |
page_size |
No |
Integer |
Especifica el número de registros de cada página. El valor oscila entre 1 y 10,000. Si no se establece este parámetro, se utiliza el valor por defecto 30. |
page_number |
No |
Integer |
Especifica el número de página. El valor oscila entre 1 y 65,535. Si este parámetro no está definido, se utiliza el valor por defecto 1. |
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 |
Especifica el 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 |
---|---|---|
total |
Integer |
Especifica el número total de registros. |
domains |
Array of Domains objects |
Especifica los detalles del nombre de dominio. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de nombre de dominio acelerado. |
domain_name |
String |
Especifica el nombre de dominio acelerado. |
business_type |
String |
Especifica el tipo de servicio del nombre de dominio. Valores posibles: web (aceleración estática), download (aceleración de descarga), video (aceleración de streaming de medios) y wholeSite (aceleración de todo el sitio). |
user_domain_id |
String |
Especifica el ID de dominio del propietario del nombre de dominio. |
domain_status |
String |
Especifica el estado del nombre de dominio acelerado. Valores posibles: online (CDN habilitado), offline (CDN deshabilitado), configuring (configurando) configure_failed (configuración fallida), checking (revisando), check_failed (rechazado después de revisar) y deleting (eliminando). |
cname |
String |
Especifica el registro CNAME del nombre de dominio acelerado. |
sources |
Array of Sources objects |
Especifica el nombre de dominio o la dirección IP del servidor de origen. Ingrese un máximo de 10 direcciones IP y use comas (,) para separarlas. Solo se permiten direcciones IPv4. |
domain_origin_host |
DomainOriginHost object |
Especifica la configuración de recuperación del nombre de dominio. |
https_status |
Integer |
Especifica si la aceleración HTTPS está habilitada. |
create_time |
Long |
Especifica la hora a la que se creó el nombre de dominio. El valor es el número de milisegundos desde la época UNIX (1 de enero de 1970). |
modify_time |
Long |
Especifica la hora a la que se modificó el nombre de dominio. El valor es el número de milisegundos desde la época UNIX (1 de enero de 1970). |
disabled |
Integer |
Especifica si el dominio está prohibido. Valores posibles: 0 (no prohibido) y 1 (prohibido). |
locked |
Integer |
Especifica si el dominio está bloqueado. Valores posibles: 0 (no bloqueado) y 1 (bloqueado). |
auto_refresh_preheat |
Integer |
Especifica si están habilitados la actualización y el precalentamiento automáticos. Valores posibles: 0 (deshabilitado) y 1 (habilitado). |
service_area |
String |
Especifica el ámbito del servicio CDN. Valores posibles: mainland_china (China continental), outside_mainland_china (fuera de China continental) y global (global). |
range_status |
String |
Especifica si está habilitada la recuperación basada en intervalos. |
follow_status |
String |
Especifica si está habilitada la recuperación de redirección. |
origin_status |
String |
Especifica si la recuperación de contenido está deshabilitada. |
banned_reason |
String |
Especifica el motivo para deshabilitar el nombre de dominio. |
locked_reason |
String |
Especifica el motivo por el que se bloquea el nombre de dominio. |
enterprise_project_id |
String |
ID del 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. Si no se especifica este parámetro, se consulta el proyecto predeterminado. Este parámetro es obligatorio cuando se utiliza un usuario de IAM para llamar a esta API. |
Parámetro |
Tipo |
Descripción |
---|---|---|
domain_id |
String |
ID de nombre de dominio. |
ip_or_domain |
String |
Especifica la dirección IP o el nombre de dominio del servidor de origen. |
origin_type |
String |
Especificó el tipo del 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). |
active_standby |
Integer |
Especifica si el servidor de origen está activo o en espera. Valores posibles: 1 (activo) y 0 (en espera). Un servidor de origen activo es obligatorio, mientras que un servidor de origen en espera es opcional. Un bucket OBS no tiene un servidor de origen en espera. |
enable_obs_web_hosting |
Integer |
Especifica si el alojamiento estático está habilitado para un bucket OBS. Valores posibles: 0 (deshabilitado) y 1 (habilitado). Este parámetro se pasa solo cuando origin_type se establece en obs_bucket. |
Parámetro |
Tipo |
Descripción |
---|---|---|
domain_id |
String |
Especifica el ID de nombre de dominio. Para obtener más información, consulte Consulta de detalles sobre un nombre de dominio. |
origin_host_type |
String |
Especifica el tipo del host de recuperación. |
customize_domain |
String |
Especifica el nombre de dominio personalizado del host de recuperación. |
Solicitudes de ejemplo
GET https://cdn.myhuaweicloud.com/v1.0/cdn/domains?domain_name=www.example.com&page_size=10&page_number=1&enterprise_project_id=0
Ejemplo de respuestas
Código de estado: 200
OK
{ "total" : 1, "domains" : [ { "sources" : [ { "origin_type" : "ipaddr", "ip_or_domain" : "10.62.53.75", "active_standby" : 1 } ], "cname" : "www.example.com.c.test.com", "id" : "ab1234a*********************g56", "user_domain_id" : "1e234********************441", "domain_name" : "www.example.com", "business_type" : "web", "service_area" : "mainland_china", "domain_status" : "online", "https_status" : 0, "create_time" : 1516861994806, "modify_time" : 1532405346365, "domain_origin_host" : { "domain_id" : "ab1234a*********************g56", "origin_host_type" : "customize", "customize_domain" : "www.xxxx.com" }, "disabled" : 0, "locked" : 0, "range_status" : "off", "follow_status" : "off", "origin_status" : "on", "auto_refresh_preheat" : 0 } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
Códigos de error
Consulte Códigos de error.