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/ Las API de gateway dedicado (V2)/ Gestión de Gateway/ Actualización de un gateway dedicado

Actualización más reciente 2023-03-29 GMT+08:00

Ver PDF

Actualización de un gateway dedicado

Función

Esta API se utiliza para actualizar un gateway dedicado.

URI

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

**Tabla 1** Parámetros de path
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento.
instance_id	Sí	String	Gateway ID, que se puede obtener de la información de gateway en la consola 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 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 un token.

**Tabla 3** Parámetros de body de solicitud
Parámetro	Obligatorio	Tipo	Descripción
description	No	String	Descripción de gateway.
maintain_begin	No	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 realiza el mantenimiento en el gateway. Durante este período, los servicios pueden seguir utilizándose, pero ocasionalmente puede haber interrupciones temporales. El mantenimiento programado ocurre con poca frecuencia (normalmente una vez cada varios meses).
maintain_end	No	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 realiza el mantenimiento en el gateway. Durante este período, los servicios pueden seguir utilizándose, pero ocasionalmente puede haber interrupciones temporales. El mantenimiento programado ocurre con poca frecuencia (normalmente una vez cada varios meses).
instance_name	No	String	Nombre del gateway. Mínimo: 3 Máximo: 64
security_group_id	No	String	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. Elija Control de acceso > Grupos de seguridad en el panel de navegación. En la página de Grupos de seguridad, 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: Llamar 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 la API de VPC.

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
id	String	ID de gateway.
project_id	String	ID del inquilino al que pertenece el gateway.
instance_name	String	Nombre del gateway.
status	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 Valores de enumeración: 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
instance_status	Integer	ID de estado de gateway. 1: Creating 2: Created 3: Creation failed 4: Initializing 5: Registering 6: Running 7: Initialization failed 8: Registration failed 10: Installing 11: Installation failed 12: Upgrading 13: Upgrade failed 20: Rolling back 21: Rolled back 22: Rollback failed 23: Deleting 24: Deletion failed 25: Deregistering 26: Deregistration failed 27: Creation timeout 28: Initialization timeout 29: Registration timeout 30: Installation timeout 31: Upgrade timeout 32: Rollback timeout 33: Deletion timeout 34: Deregistration timeout 35: Starting 36: Freezing 37: Frozen 38: Restarting 39: Restarting failed 40: Abnormal 41: Restarting timeout Valores de enumeración: 1 2 3 4 5 6 7 8 10 11 12 13 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
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 Valores de enumeración: BASIC PROFESSIONAL ENTERPRISE PLATINUM BASIC_IPV6 PROFESSIONAL_IPV6 ENTERPRISE_IPV6 PLATINUM_IPV6
create_time	Long	Hora en 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 si utiliza una cuenta de empresa.
eip_address	String	EIP vinculado al gateway.
charging_mode	Integer	Modo de facturación del gateway. 0: pago por uso 1: anual/mensual Valores de enumeración: 0 1
cbc_metadata	String	ID de pedido de suscripción anual/mensual.
loadbalancer_provider	String	Tipo del balanceador de carga utilizado por el gateway. LVS ELB (available only in certain regions) Predeterminado: lvs Valores de enumeración: lvs elb
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: Llamar a la API de VPC correspondiente. Para obtener más información, consulte la sección "Consulta de VPCs" en la Referencia de la 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: Llamar a la API de VPC correspondiente. Para obtener más información, consulte la sección "Consultar subredes" en la Referencia de la 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. Elija Control de acceso > Grupos de seguridad en el panel de navegación. En la página de Grupos de seguridad, 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: Llamar 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 la 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.
available_zone_ids	String	AZ.
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	ROMA EIP. 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.
publicips	Array of IpDetails objects	Direcciones públicas de acceso entrante.
privateips	Array of IpDetails objects	Direcciones privadas de acceso entrante.
is_releasable	Boolean	Si se puede liberar el gateway. true: El gateway puede ser liberado. false: no se puede liberar el gateway.

**Tabla 5** EndpointService
Parámetro	Tipo	Descripción
service_name	String	Nombre del servicio de punto de conexión de VPC.
created_at	String	Hora 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.
bandwidth_size	Integer	Ancho de banda.

Código de estado: 400

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

Código de estado: 401

**Tabla 9** Parámetros de body 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 10** Parámetros de body 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 11** Parámetros de body 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 12** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
error_code	String	Código de error.
error_msg	String	Mensaje de error.

Solicitudes de ejemplo

{
  "description" : "test create instance",
  "instance_name" : "apig-demo"
}

Ejemplo de respuestas

Código de estado: 200

{
  "available_zone_ids" : "[xx-xxx-7a, xx-xxx-7b]",
  "bandwidth_size" : 5,
  "description" : "test create instance",
  "eip_id" : "41f961ab-2bdd-4ca7-9b59-cfc4fcef10c9",
  "enterprise_project_id" : "0",
  "instance_name" : "apig-demo",
  "maintain_begin" : "22:00:00",
  "maintain_end" : "02:00:00",
  "security_group_id" : "36d0ec18-bd10-4da7-86f3-ad7a5ddc55d7",
  "spec_id" : "PROFESSIONAL",
  "subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5",
  "vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763"
}

Código de estado: 400

Bad Request

{
  "error_code" : "APIC.7211",
  "error_msg" : "Parameter value does not match the rules, parameter name[maintainBegin]"
}

Código de estado: 401

Unauthorized

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

Código de estado: 403

Forbidden

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

Código de estado: 404

Not Found

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

Código de estado: 500

Internal Server Error

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

Códigos de estado

Código de estado	Descripción
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de Gateway

Tema anterior: Consulta de detalles de gateway dedicado

Tema siguiente: Consulta del progreso de creació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