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 gateway dedicados

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

Ver PDF

Consulta de gateway dedicados

Función

Esta API se utiliza para consultar gateways dedicados.

Método de invocación

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

URI

GET /v2/{project_id}/apigw/instances

**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.

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
offset	No	Long	Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0. Predeterminado: 0
limit	No	Integer	Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500. Mínimo: 1 Máximo: 500 Predeterminado: 20
instance_id	No	String	ID de gateway.
instance_name	No	String	Nombre del gateway.
status	No	String	Estado de gateway. Creating CreateSuccess CreateFail Initing Registering Running InitingFailed RegisterFailed Installing InstallFailed Updating UpdateFailed Rollbacking RollbackSuccess RollbackFailed Deleting DeleteFailed Unregistering UnRegisterFailed CreateTimeout InitTimeout RegisterTimeout InstallTimeout UpdateTimeout RollbackTimeout DeleteTimeout UnregisterTimeout Starting Freezing Frozen Restarting RestartFail Unhealthy RestartTimeout

Parámetros de solicitud

**Tabla 3** 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 4** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
size	Integer	Longitud de la lista de recursos devuelta.
total	Long	Número de recursos que coinciden con las condiciones de consulta.
instances	Array of RespInstanceBase objects	Lista de gateway.

**Tabla 5** RespInstanceBase
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

**Tabla 6** 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

Código de estado: 401

**Tabla 7** 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 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: 500

**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.

Ejemplo de las solicitudes

Ninguno

Ejemplo de respuestas

Código de estado: 200

Aceptar

{
  "total" : 2,
  "size" : 2,
  "instances" : [ {
    "cbc_metadata" : "CS2006301043A28NF:00301-734023-0--0",
    "charging_mode" : 1,
    "create_time" : 1585302825070,
    "eip_address" : "xxx.xxx.xxx.xxx",
    "enterprise_project_id" : "0",
    "id" : "eddc4d25480b4cd6b512f270a1b8b341",
    "instance_name" : "apig-Enterprise_Project_Pay-per-Use",
    "instance_status" : 6,
    "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
    "spec" : "PROFESSIONAL",
    "status" : "Running",
    "type" : "apig"
  }, {
    "charging_mode" : 0,
    "create_time" : 1594370987422,
    "eip_address" : "xxx.xxx.xxx.xxx",
    "enterprise_project_id" : "0",
    "id" : "2e2d613c64094a4a94ad38e7ca30adee",
    "instance_name" : "apig-autotest-apitest-nodelete",
    "instance_status" : 6,
    "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
    "spec" : "PROFESSIONAL",
    "status" : "Running",
    "type" : "apig",
    "cbc_operation_locks" : [ {
      "lock_scene" : "TO_PERIOD_LOCK",
      "lock_source_id" : "CxxxxxxxxxxxM"
    } ]
  } ]
}

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: 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
500	Error del servidor interno

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de gateway

Tema anterior: Consulta de las AZ

Tema siguiente: Eliminació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