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/ Creación de un gateway dedicado (pago por uso)

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

Ver PDF

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

Función

Esta API se utiliza para crear un gateway dedicado de pago por uso.

Método de invocación

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

URI

POST /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.

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.

**Tabla 3** Parámetros del cuerpo de solicitud
Parámetro	Obligatorio	Tipo	Descripción
description	No	String	Descripción de gateway. El valor puede contener hasta 255 caracteres excepto > y <.
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	Sí	String	Nombre del gateway. Ingrese de 3 a 64 caracteres, comenzando con una letra. Solo se admiten letras, dígitos, guiones (-) y guiones bajos (_). Mínimo: 3 Máximo: 64
instance_id	No	String	ID de gateway, que se generará automáticamente si no especifica este parámetro.
spec_id	Sí	String	Edición de gateway. Opciones: BASIC PROFESSIONAL ENTERPRISE PLATINUM BASIC_IPV6 PROFESSIONAL_IPV6 ENTERPRISE_IPV6 PLATINUM_IPV6 PLATINUM_X2 PLATINUM_X3 PLATINUM_X4 PLATINUM_X5 PLATINUM_X6 PLATINUM_X7 PLATINUM_X8 Platinum 2–8 are available only in certain regions.
vpc_id	Sí	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	Sí	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	Sí	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.
eip_id	No	String	ID de EIP. Este parámetro es necesario si el acceso público está habilitado para el gateway y loadbalancer_provider se establece en lvs. Después de vincular una EIP al gateway, los usuarios pueden acceder a las API en el gateway desde redes públicas mediante la EIP. Para obtener un ID de EIP, inicie sesión en la consola de VPC y elija "Elastic IP and Bandwidth" > "EIPs" en el panel de navegación. Haga clic en el nombre de la EIP de destino, y vea el ID de EIP en la página mostrada.
enterprise_project_id	No	String	ID de proyecto de empresa. Este parámetro es necesario para una cuenta de empresa. Puede obtenerlo de cualquiera de las siguientes maneras: Método 1: Inicie sesión en la página de Enterprise Project Management, haga clic en el nombre del proyecto de empresa de destino y vea el ID del proyecto en la página mostrada. Método 2: Invoque a la API de gestión de proyectos correspondiente. Para obtener más información, consulte la sección "Consulta de la lista de proyectos empresariales" en la Referencia de las API de Enterprise Management.
available_zone_ids	Sí	Array of strings	Las AZ. Una AZ es una región física donde los recursos utilizan las fuentes de alimentación y las redes independientes. Las AZ están físicamente aisladas, pero se interconectan a través de una red interna. Para mejorar la disponibilidad de las aplicaciones, cree gateways en las diferentes Zonas de disponibilidad. Para obtener información de zona de disponibilidad, invoque a la API utilizada para consultar disponibilidad.
bandwidth_size	No	Integer	Ancho de banda de acceso saliente. Este parámetro es necesario si el acceso saliente público está habilitado para el gateway. Después de configurar el ancho de banda del gateway, los usuarios pueden acceder a los recursos de las redes públicas. Predeterminado: 5
bandwidth_charging_mode	No	String	Tipo de facturación del ancho de banda de acceso público saliente. Este parámetro es necesario si el acceso saliente público está habilitado para el gateway. bandwidth: facturado por ancho de banda traffic: facturado por tráfico Predeterminado: bandwidth
ipv6_enable	No	Boolean	Indica si se admite el acceso público con una dirección IPv6. Actualmente, las direcciones IPv6 solo se admiten en ciertas regiones.
loadbalancer_provider	No	String	Tipo del balanceador de carga utilizado por el gateway. Este campo se descarta. La región del gateway determina el uso de ELB o LVS. Para obtener más detalles, véase la sección "Notas y restricciones" en la Descripción del servicio de API Gateway. lvs: Linux VM elb: Elastic Load Balancer (disponible solo en determinadas regiones) Predeterminado: lvs
tags	No	Array of TmsKeyValue objects	Etiquetas. Se puede crear un máximo de 20 etiquetas para el gateway. Longitud de matriz: 0 - 20
vpcep_service_name	No	String	Nombre de un servicio de punto de conexión de VPC. Puede contener máx. 16 caracteres, incluidas letras, dígitos, guiones (-) y guiones bajos. Si no se especifica este parámetro, el sistema genera automáticamente un nombre con el formato "{region}.apig.{service_id}". Si se especifica este parámetro, el sistema genera automáticamente un nombre con el formato "{region}.{vpcep_service_name}.{service_id}". Una vez creado el gateway, puede modificar este nombre en la página Gateways > VPC Endpoints.
ingress_bandwidth_size	No	Integer	Ancho de banda de acceso público entrante. Este parámetro es necesario si el acceso público entrante está habilitado para el gateway y loadbalancer_provider se establece en elb. Después de vincular una EIP al gateway, los usuarios pueden acceder a las API en el gateway desde redes públicas mediante la EIP. Predeterminado: 5
ingress_bandwidth_charging_mode	No	String	Tipo de facturación del ancho de banda de acceso público entrante. Este parámetro es necesario si el acceso público entrante está habilitado para el gateway y loadbalancer_provider se establece en elb. bandwidth: facturado por ancho de banda traffic: facturado por tráfico Predeterminado: bandwidth

**Tabla 4** TmsKeyValue
Parámetro	Obligatorio	Tipo	Descripción
key	No	String	Clave. Incluye UTF-8 letras, dígitos, espacios o caracteres especiales (_.:=+-@). No empiece con _sys_ porque es una etiqueta de sistema. Mínimo: 1 Máximo: 128
value	No	String	El valor. Puede introducir letras, dígitos y espacios u otros caracteres especiales (_.:/=+-@) en formato UTF-8. Mínimo: 0 Máximo: 255

Parámetros de respuesta

Código de estado: 202

**Tabla 5** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
instance_id	String	ID de gateway.
message	String	Información sobre la tarea de creación de gateway.
job_id	String	ID de la tarea.

Código de estado: 400

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

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

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

Ejemplo de las solicitudes

Creación de un gateway con configuraciones de red y grupos de seguridad

{
  "available_zone_ids" : [ "xx-xxx-7b", "xx-xxx-7a" ],
  "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"
}

Ejemplo de respuestas

Código de estado: 202

Aceptado

{
  "instance_id" : "6a7d71827fd54572b1f31aa9548fcc81",
  "message" : "JOB_ASSIGNED_FOR_PROVISIONING_0003I:The job JOB-bdb370eb6f4c4c73b61b95a9da38beb5 has been assigned to the instance 6a7d71827fd54572b1f31aa9548fcc81 for running provisioning.",
  "job_id" : "JOB-edbac2355fb7433e98f173ea2e452e2d"
}

Código de estado: 400

Error en la solicitud

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

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.7301",
  "error_msg" : "Instance spec 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
202	Aceptado
400	Error en la solicitud
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: Gestión de gateway

Tema siguiente: Consulta de detalles de 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