Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ API Gateway/ Referencia de la API/ API de gateway dedicados (V2)/ Gestión de gateway/ Consulta de detalles de gateway dedicado

Actualización más reciente 2025-12-22 GMT+08:00

Ver PDF

Consulta de detalles de gateway dedicado

Función

Esta API se utiliza para consultar los detalles de gateway dedicado.

Método de invocación

Para obtener más información, véase invocación de API.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}

**Tabla 1** Parámetros de ruta
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto.
instance_id	Sí	String	ID de gateway, que se puede obtener de la información de gateway en la consola de APIG.

Parámetros de solicitud

**Tabla 2** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token.

Parámetros de respuesta

Código de estado: 200

**Tabla 3** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
id	String	ID de gateway.
project_id	String	ID del tenant al que pertenece el gateway.
instance_name	String	Nombre del gateway.
status	String	Estado de la instancia: Creating: Se está creando la instancia. CreateSuccess: La instancia se crea correctamente. CreateFail: No se puede crear la instancia. Initing: Se está inicializando la instancia. Registering: Se está registrando la instancia. Running: La instancia se está ejecutando. InitingFailed: No se puede inicializar la instancia. RegisterFailed: La instancia no se puede registrar. Installing: Se está instalando la instancia. InstallFailed: No se puede instalar la instancia. Updating: Se está actualizando la instancia. UpdateFailed: No se puede actualizar la instancia. Rollbacking: Se está revirtiendo la instancia. RollbackSuccess: La instancia se revierte correctamente. RollbackFailed: No se puede revertir la instancia. Deleting: Se está suprimiendo la instancia. DeleteFailed: No se puede eliminar la instancia. Unregistering: Se está dando de baja la instancia. UnRegisterFailed: No se puede dar de baja la instancia. CreateTimeout: Se expira la creación de la instancia. InitTimeout: Se expira la inicialización de la instancia. RegisterTimeout: Se expira el registro de la instancia. InstallTimeout: Se expira la instalación de la instancia. UpdateTimeout: Se expira la actualización de la instancia. RollbackTimeout: Se expira la reversión de la instancia. DeleteTimeout: Se expira la eliminación de la instancia. UnregisterTimeout: Se expira la anulación de la instancia. Starting: Se está iniciando la instancia. Freezing: La instancia se está congelando. Frozen: La instancia está congelada. Restarting: Se está reiniciando la instancia. RestartFail: La instancia no se puede reiniciar. Unhealthy: La instancia es anormal. RestartTimeout: Se expira el reinicio de la instancia. Resizing: La especificación de instancia está cambiando. ResizeFailed: No se puede cambiar la especificación de instancia. ResizeTimeout: Se expira el cambio de especificación de instancia.
instance_status	Integer	ID de estado de instancia: 1: Creando 2: Creado con éxito 3: Error de creación 4: Inicializando 5: Registrando 6: En ejecución 7: Error de inicialización 8: Error en el registro 10: Instalando 11: Error de instalación 12: Actualizando 13: Error de actualización 20: Retrocediendo 21: Retrocedido 22: Error de reversión 23: Eliminando 24: Error de la eliminación 25: Retirando el registro 26: Error al cancelar el registro 27: Se expiró la creación 28: Se expiró la inicialización 29: Se expiró el registro 30: Se expiró la instalación 31: Se expiró la actualización 32: Se expiró la reversión 33: Se expiró la eliminación 34: Se expiró la anulación 35: Comenzando 36: Congelando 37: Congelado 38: Reiniciando 39: Error de reinicio 40: Anormal 41: Se expiró el reinicio 42: Cambiando la especificación 43: Error al cambiar la especificación 44: Se expiró el cambio de especificación
type	String	Tipo de gateway. El valor predeterminado es apig.
spec	String	Edición de gateway. BASIC PROFESSIONAL ENTERPRISE PLATINUM BASIC_IPV6 PROFESSIONAL_IPV6 ENTERPRISE_IPV6 PLATINUM_IPV6
create_time	Long	Hora en la que se crea el gateway. La hora está en el formato de marca de tiempo de Unix.
enterprise_project_id	String	ID de proyecto de empresa. Este parámetro es necesario para una cuenta de empresa.
eip_address	String	EIP vinculada al gateway.
charging_mode	Integer	Modo de facturación del gateway. 0: pago por uso 1: Este parámetro no se utiliza actualmente.
cbc_metadata	String	Este parámetro no se utiliza actualmente.
loadbalancer_provider	String	Tipo del balanceador de carga utilizado por el gateway. LVS ELB (disponible solo en ciertas regiones) Predeterminado: lvs
cbc_operation_locks	Array of CbcOperationLock objects	Bloqueo de restricción de operaciones en la nube
description	String	Descripción sobre el gateway.
vpc_id	String	ID de VPC. Puede obtenerlo de cualquiera de las siguientes maneras: Método 1: Inicie sesión en la consola de VPC y haga clic en el nombre de una VPC para ver el ID de VPC en la página de detalles que se muestra. Método 2: Invoque a la API de VPC correspondiente. Para obtener más información, consulte la sección "Consulta de las VPC" en la Referencia de las API de VPC.
subnet_id	String	ID de red de subred. Puede obtenerlo de cualquiera de las siguientes maneras: Método 1: Inicie sesión en la consola de VPC y haga clic en la subred de destino en la página Subnets. Puede ver el ID de red en la página mostrada. Método 2: Invoque a la API de VPC correspondiente. Para obtener más información, consulte la sección "Consulta de subredes" en la Referencia de las API de VPC.
security_group_id	String	ID del grupo de seguridad al que pertenece el gateway. Puede obtenerlo de cualquiera de las siguientes maneras: Método 1: Inicie sesión en la consola de VPC. Seleccione Access Control > Security Groups en el panel de navegación. En la página Security Groups, haga clic en el grupo de seguridad de destino. A continuación, vea el ID del grupo de seguridad en la página mostrada. Método 2: Invoque a la API de VPC correspondiente. Para obtener más información, consulte la sección "Consulta de grupos de seguridad" en la Referencia de las API de VPC.
maintain_begin	String	Hora de inicio de la ventana de tiempo de mantenimiento. Debe estar en el formato "xx:00:00". El valor de xx puede ser 02, 06, 10, 14, 18 o 22. Durante el período de tiempo de mantenimiento, el personal de O&M puede realizar operaciones de mantenimiento en el gateway. Durante el mantenimiento, los servicios pueden seguir utilizándose, pero ocasionalmente puede haber interrupciones temporales del servicio. El mantenimiento programado ocurre con poca frecuencia (normalmente una vez cada varios meses).
maintain_end	String	Hora de finalización de la ventana de tiempo de mantenimiento. Debe estar en el formato "xx:00:00". Hay una diferencia de 4 horas entre la hora de inicio y la hora de finalización. Durante el período de tiempo de mantenimiento, el personal de O&M puede realizar operaciones de mantenimiento en el gateway. Durante el mantenimiento, los servicios pueden seguir utilizándose, pero ocasionalmente puede haber interrupciones temporales del servicio. El mantenimiento programado ocurre con poca frecuencia (normalmente una vez cada varios meses).
ingress_ip	String	Dirección de entrada de VPC.
ingress_ip_v6	String	Dirección de acceso de VPC (IPv6).
user_id	String	ID de la cuenta a la que pertenece el gateway.
nat_eip_ipv6_cidr	String	Dirección de salida pública (IPv6). Actualmente, las direcciones IPv6 solo se admiten en ciertas regiones.
eip_ipv6_address	String	EIP (IPv6). Actualmente, las direcciones IPv6 solo se admiten en ciertas regiones.
nat_eip_address	String	Dirección IP para el acceso público saliente.
bandwidth_size	Integer	Ancho de banda de acceso saliente.
bandwidth_charging_mode	String	Modo de facturación del ancho de banda de acceso público saliente.
available_zone_ids	String	Zona de disponibilidad.
instance_version	String	Versión de gateway.
virsubnet_id	String	ID de red de subred. Actualmente, este parámetro no es compatible.
roma_eip_address	String	EIP de ROMA. Actualmente, este parámetro no es compatible.
listeners	Object	Información del oyente. Actualmente, este parámetro no es compatible.
supported_features	Array of strings	Funciones admitidas.
endpoint_service	EndpointService object	Detalles del servicio de punto de conexión de VPC. Este parámetro será obsoleta. Utilice endpoint_services en su lugar.
endpoint_services	Array of EndpointService objects	Servicios de punto de conexión de VPC.
node_ips	NodeIps object	ID de punto de conexión de VPC.
node_ipv6_ips	NodeIps object	Dirección IPv6 del nodo de servicio.
public_ipv6_ips	Array of strings	Dirección IPV6 para el acceso público saliente.
publicips	Array of IpDetails objects	Direcciones públicas de acceso entrante.
privateips	Array of IpDetails objects	Direcciones privadas de acceso entrante.
unreliable_ips	Array of strings	Lista de direcciones IP de acceso entrante de gateway no confiables, para las que el nombre de subdominio del grupo no es CNAMEd. No se puede acceder directamente al grupo DEFAULT utilizando la dirección IP de esta lista.
enable_fullstack_ipv6	Boolean	Si el gateway admite IPv6 de formato completo. true: El gateway admite IPv6 para el acceso entrante y saliente. false: no soportado. El gateway admite IPv6 solo para el acceso entrante.
is_releasable	Boolean	Si se puede liberar el gateway. true: El gateway puede ser liberado. false: no se puede liberar el gateway.
ingress_bandwidth_charging_mode	String	Modo de facturación del ancho de banda de acceso público entrante.

**Tabla 4** CbcOperationLock
Parámetro	Tipo	Descripción
lock_scene	String	Escenarios de restricción: TO_PERIOD_LOCK: Cambio del modo de facturación de pago por uso a anual/mensual. En este escenario, no se permiten eliminar recursos, cambiar las especificaciones y cambiar de pago por uso a anual/mensual. SPEC_CHG_LOCK: Modificación de las especificaciones del modo de facturación anual/mensual. En este escenario, no se permiten eliminar recursos ni cambiar las especificaciones.
lock_source_id	String	ID del objeto que inicia la restricción

**Tabla 5** EndpointService
Parámetro	Tipo	Descripción
service_name	String	Nombre del servicio de punto de conexión de VPC.
created_at	String	Tiempo de creación.

**Tabla 6** NodeIps
Parámetro	Tipo	Descripción
livedata	Array of strings	Direcciones IP de nodo LiveData.
shubao	Array of strings	Direcciones IP del nodo Shubao.

**Tabla 7** IpDetails
Parámetro	Tipo	Descripción
ip_address	String	Dirección IP.
ipv6_address	String	Dirección IPv6.
bandwidth_size	Integer	Ancho de banda.

Código de estado: 401

**Tabla 8** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Código de estado: 403

**Tabla 9** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Código de estado: 404

**Tabla 10** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Código de estado: 500

**Tabla 11** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Ejemplo de las solicitudes

Ninguno

Ejemplo de respuestas

Código de estado: 200

Aceptar

{
  "id" : "8dfxxxxxxxxxxxxxxxxxxxxxxxxxx00p",
  "spec" : "BASIC",
  "project_id" : "78xxxxxxxxxxxxxxxxxxxxxxxxxxxxoi",
  "instance_name" : "apig-demo",
  "status" : "Running",
  "instance_status" : 6,
  "eip_address" : null,
  "type" : null,
  "create_time" : 1635890506328,
  "charging_mode" : 0,
  "enterprise_project_id" : "0",
  "loadbalancer_provider" : "elb",
  "description" : "test create instance",
  "instance_version" : "acc6d368a3cb4d47840380bf62b0ab32",
  "available_zone_ids" : "[xx-xxx-7a, xx-xxx-7b]",
  "user_id" : "e966ff7227ef4df49df7d57aaf00f8ed",
  "vpc_id" : "0402ea19-5457-4032-9d1b-eb48b98f6c66",
  "subnet_id" : "a3bd29e4-d5bc-414c-a79a-1f35ee4ead88",
  "virsubnet_id" : "a3bd29e4-d5bc-414c-a79a-1f35ee4ead88",
  "security_group_id" : "4b95a790-5cfc-463d-8de5-42199e55371c",
  "maintain_begin" : "22:00:00",
  "maintain_end" : "02:00:00",
  "ingress_ip" : "192.168.0.152",
  "ingress_ip_v6" : null,
  "nat_eip_address" : "xxx.xxx.xxx.xxx",
  "roma_eip_address" : null,
  "bandwidth_size" : 5,
  "bandwidth_charging_mode" : "traffic",
  "nat_eip_ipv6_cidr" : null,
  "eip_ipv6_address" : null,
  "supported_features" : [ "lts", "gateway_responses", "ratelimit", "request_body_size", "backend_timeout", "app_token", "app_basic", "app_secret", "multi_auth", "route", "sign_basic", "app_route", "backend_client_certificate", "ssl_ciphers", "cors", "app_quota", "app_acl", "real_ip_from_xff", "set_resp_headers", "vpc_backup", "throttle_strategy", "watch_instance", "sign_aes", "mock_status_code_and_header", "backend_retry_count", "custom_log", "real_ip_header_getter", "policy_sys_param", "vpc_name_modifiable", "breaker", "default_group_host_trustlist" ],
  "node_ips" : {
    "livedata" : [ ],
    "shubao" : [ "192.168.0.123", "192.168.0.114" ]
  },
  "endpoint_service" : null,
  "endpoint_services" : [ {
    "service_name" : "xx-xxx-7a.apig.20bc4a91-1542-43s2-a278-b1e49c0hh6f9",
    "created_at" : "2021-8-03 06:04:43"
  } ],
  "publicips" : [ {
    "ip_address" : "xxx.xxx.xxx.xxx",
    "ipv6_address" : "xxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:2b8",
    "bandwidth_size" : 5
  } ],
  "privateips" : [ {
    "ip_address" : "xxx.xxx.xxx.xxx",
    "ipv6_address" : "xxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:2b8",
    "bandwidth_size" : 5
  } ],
  "ingress_bandwidth_charging_mode" : "traffic",
  "cbc_operation_locks" : [ {
    "lock_scene" : "TO_PERIOD_LOCK",
    "lock_source_id" : "CxxxxxxxxxxxM"
  } ],
  "public_ipv6_ips" : [ "xxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:2b83", "xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:6fee" ],
  "node_ipv6_ips" : {
    "livedata" : [ ],
    "shubao" : [ "xxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:2b81", "xxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:2b84" ]
  },
  "enable_fullstack_ipv6" : true,
  "unreliable_ips" : [ "192.xx.xxx.xxx" ]
}

Código de estado: 401

Sin autorización

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de estado: 403

Prohibido

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

Código de estado: 404

No se ha encontrado

{
  "error_code" : "APIC.7302",
  "error_msg" : "Instance not found"
}

Código de estado: 500

Error del servidor interno

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

Códigos de estado

Código de estado	Descripción
200	Aceptar
401	Sin autorización
403	Prohibido
404	No se ha encontrado
500	Error del servidor interno

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de gateway

Tema anterior: Creación de un gateway dedicado (pago por uso)

Tema siguiente: Actualización de un gateway dedicado

Comentarios

¿Le pareció útil esta página?

Sí No

Deje algún comentario

Muchas gracias por sus comentarios. Seguiremos trabajando para mejorar la documentación.

El sistema está ocupado. Vuelva a intentarlo más tarde.

¿Cuáles de los siguientes problemas se presentaron?

Contenido diferente a la de la IU del producto

Descripciones poco claras

Falta de ejemplos o código

Pasos incorrectos

No puedo encontrar lo que necesito

Falta de prácticas recomendadas

Comentarios (opcional)

0/500

Seleccione al menos un tipo de problema e ingrese sus comentarios o sugerencias.

Ingrese 500 caracteres como máximo.

Enviar Cancelar