Creación de un gateway virtual
Función
Esta API se utiliza para crear un gateway virtual.
URI
POST /v3/{project_id}/dcaas/virtual-gateways
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Especifica el token de usuario. Para obtener el token, consulte la sección "Obtención del token de usuario" en la Referencia de las API de Identity and Access Management. El token es el valor de X-Subject-Token en la cabecera de respuesta. Mínimo: 0 Máximo: 10240 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
virtual_gateway |
No |
CreateVirtualGateway object |
Especifica los parámetros para crear un gateway virtual. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
vpc_id |
Sí |
String |
Especifica el ID de la VPC conectada por el gateway virtual. |
name |
No |
String |
Especifica el nombre del gateway virtual. Mínimo: 0 Máximo: 64 |
description |
No |
String |
Proporciona la información complementaria sobre el gateway virtual. Mínimo: 0 Máximo: 128 |
local_ep_group |
Sí |
Array of strings |
Especifica las subredes IPv4 conectadas por el gateway virtual, que suele ser los bloques CIDR de una VPC. |
local_ep_group_ipv6 |
No |
Array of strings |
Especifica las subredes IPv6 conectadas por el gateway virtual, que suele ser los bloques CIDR de una VPC. Este es un campo reservado. |
bgp_asn |
No |
Integer |
Especifica el número del sistema autónomo (ASN) BGP local del gateway virtual. Mínimo: 1 Máximo: 4294967295 |
enterprise_project_id |
No |
String |
Especifica el ID del proyecto de empresa al que pertenece el gateway virtual. Mínimo: 36 Máximo: 36 |
tags |
No |
Array of Tag objects |
Especifica las etiquetas. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
key |
Sí |
String |
Especifica la clave de etiqueta. La clave puede contener un máximo de 36 caracteres de Unicode, incluidos letras, dígitos, guiones (-) y guiones bajos (_). Mínimo: 0 Máximo: 36 |
value |
No |
String |
Especifica el valor de etiqueta. El valor puede contener un máximo de 43 caracteres de Unicode, incluidos letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Mínimo: 0 Máximo: 43 |
Parámetros de respuesta
Código de estado: 201
Parámetro |
Tipo |
Descripción |
---|---|---|
virtual_gateway |
VirtualGateway object |
Especifica los parámetros para crear un gateway virtual. |
request_id |
String |
Especifica el ID de la solicitud. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID del gateway virtual. |
vpc_id |
String |
Especifica el ID de la VPC conectada por el gateway virtual. |
tenant_id |
String |
Especifica el ID del proyecto al que pertenece la instancia. Mínimo: 32 Máximo: 32 |
name |
String |
Especifica el nombre del gateway virtual. Mínimo: 0 Máximo: 64 |
description |
String |
Proporciona la información complementaria sobre el gateway virtual. Mínimo: 0 Máximo: 128 |
type |
String |
Especifica el tipo del gateway virtual. El valor solo puede ser default. Predeterminado: default Valores de enumeración:
|
local_ep_group |
Array of strings |
Especifica las subredes IPv4 conectadas por el gateway virtual, que suele ser los bloques CIDR de una VPC. |
local_ep_group_ipv6 |
Array of strings |
Especifica las subredes IPv6 conectadas por el gateway virtual, que suele ser los bloques CIDR de una VPC.This is a reserved field. |
admin_state_up |
Boolean |
Especifica el estado administrativo, que puede ser true o false. Predeterminado: true |
status |
String |
Especifica el estado del gateway virtual, que puede ser ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE o PENDING_DELETE. |
bgp_asn |
Integer |
Especifica el ASN de BGP local del gateway virtual. Mínimo: 1 Máximo: 4294967295 |
enterprise_project_id |
String |
Especifica el ID del proyecto de empresa al que pertenece el gateway virtual. Mínimo: 36 Máximo: 36 |
tags |
Array of Tag objects |
Especifica las etiquetas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Especifica la clave de etiqueta. La clave puede contener un máximo de 36 caracteres de Unicode, incluidos letras, dígitos, guiones (-) y guiones bajos (_). Mínimo: 0 Máximo: 36 |
value |
String |
Especifica el valor de etiqueta. El valor puede contener un máximo de 43 caracteres de Unicode, incluidos letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Mínimo: 0 Máximo: 43 |
Ejemplo de las solicitudes
Creación de un gateway virtual
POST https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-gateways { "virtual_gateway" : { "name" : "vgw-c7b22", "description" : "", "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c", "bgp_asn" : 64512, "local_ep_group" : [ "192.168.1.0/24" ] } }
Ejemplo de las respuestas
Código de estado: 201
CREATED
{ "virtual_gateway" : { "id" : "20082c1b-3c99-48d8-8e8c-116af5d7e9f0", "name" : "vgw-c7b22", "description" : "", "tenant_id" : "0605768a3300d5762f82c01180692873", "vpc_id" : "6592c28e-95d7-4b0a-9f61-004fdf03420c", "type" : "default", "status" : "ACTIVE", "admin_state_up" : true, "bgp_asn" : 64512, "local_ep_group" : [ "192.168.1.0/24" ], "enterprise_project_id" : "0", "create_time" : "2022-08-19T11:28:06.000Z" }, "request_id" : "765f7aaf8f2edd0e719de564ef72e2de" }
Códigos de estado
Código de estado |
Descripción |
---|---|
201 |
CREADO |
Códigos de error
Consulte Códigos de error.