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/ Creación de un Gateway dedicado
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF
Compartir

Creación de un Gateway dedicado

Función

Esta API se utiliza para crear un gateway dedicado.

URI

POST /v2/{project_id}/apigw/instances

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.

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

Yes

String

Nombre del gateway.

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.

  • 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

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

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

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

eip_id

No

String

EIP ID.

Este parámetro es necesario si el acceso público está habilitado para el gateway. Después de vincular un EIP al gateway, los usuarios pueden acceder a las API en el gateway desde redes públicas mediante el EIP.

Para obtener un ID de EIP, inicie sesión en la consola de VPC y elija Elastic IP y Bandwidth > EIPs en el panel de navegación. Haga clic en el nombre del 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 si utiliza 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: Llamar 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 la API de Enterprise Management.

available_zone_ids

Sí

Array of strings

AZs.

Una zona de disponibilidad es una región física donde los recursos utilizan fuentes de alimentación y redes independientes. Las zonas AZ están físicamente aisladas, pero se interconectan a través de una red interna. Para mejorar la disponibilidad de las aplicaciones, cree puertas de enlace en las diferentes Zonas de disponibilidad.

Para obtener información de zona de disponibilidad, llame 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

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.

  • LVS

  • ELB (disponible solo en ciertas regiones)

Predeterminado: lvs

Valores de enumeración:

  • lvs

  • elb

tags

No

Array of TmsKeyValue objects

Etiquetas.

Se puede crear un máximo de 20 etiquetas para el gateway.
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

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 de body de respuesta

Parámetro

Tipo

Descripción

instance_id

String

Gateway ID.

message

String

Información sobre la tarea de creación de gateway.

job_id

String

ID de tarea.

Código de estado: 400

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

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

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.

Solicitudes de ejemplo

{
  "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

Accepted

{
  "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

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.7301",
  "error_msg" : "Instance spec 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

202

Accepted

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