Modificación de un servicio de punto de conexión de VPC
Función
Función Esta API se utiliza para modificar un servicio de punto de conexión de VPC.
URI
PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. |
vpc_endpoint_service_id |
Sí |
String |
Especifica el ID del servicio de punto de conexión de VPC. |
Parámetros de Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Especifica el token de usuario. Se puede obtener llamando a la API de IAM. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario. |
Content-Type |
Sí |
String |
Especifica el tipo MIME del cuerpo de la solicitud. Se recomienda el valor predeterminado application/json. Para las API utilizadas para cargar objetos o imágenes, el tipo MIME varía según el tipo de flujo. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
approval_enabled |
No |
Boolean |
Especifica si se requiere aprobación. ● falso: No se requiere aprobación. El punto de conexión de VPC creado está en el estado aceptado de forma predeterminada. ● true: Se requiere aprobación. La conexión de punto de conexión creada solo se puede usar después de haber sido aprobada por el usuario del servicio de punto de conexión de VPC. El valor predeterminado es true. Predeterminado: true |
service_name |
No |
String |
Especifica el nombre del servicio de punto de conexión de VPC. El nombre puede contener un máximo de 16 caracteres, incluyendo letras, dígitos, (_), de guiones bajos y (-) de guiones. Mínimo: 0 Máximo: 16 |
ports |
No |
Array of PortList objects |
Especifica las asignaciones de puertos abiertas por el servicio de punto de conexión de VPC. No se permiten asignaciones de puertos duplicados en el mismo servicio de punto de conexión de VPC. Si varios servicios de punto de conexión de VPC comparten un ID de puerto, las combinaciones de puertos y protocolos de servidor para todas las asignaciones de puertos entre servicios de punto de conexión de VPC deben ser únicas.Se puede agregar un máximo de 200 asignaciones de puertos a la vez. |
port_id |
No |
String |
Especifica el ID del recurso backend del servicio de punto de conexión de VPC. El ID está en el formato de identificador único universal (UUID). Las opciones son las siguientes: ● Balanceador de carga: Especifica el ID de puerto de la dirección IP privada del balanceador de carga compartido. Para obtener más información, consulta el campo vip_port_id en los parámetros de respuesta de la sección "Ver detalles de un equilibrador de carga" en la referencia de la API de equilibrio de carga elástica. ● Máquina virtual: Especifica el ID de NIC de la dirección IP de ECS. Para obtener más información, consulte el campo port_id en los parámetros de respuesta de la sección "Consultar NICs de un ECS" en la Referencia de la API de Elastic Cloud Server. ● Dirección IP virtual: Especifica el ID de NIC del servidor físico donde se encuentra el recurso virtual. Nota: Si el recurso backend es un balanceador de carga, configure este parámetro con el valor vip_port_id de otro balanceador de carga del mismo tipo. Por ejemplo, si el equilibrador de carga original es el compartido, el nuevo equilibrador de carga no puede ser el dedicado. |
vip_port_id |
No |
String |
NIC ID de la dirección IP virtual. Mínimo: 1 Máximo: 64 |
description |
No |
String |
Especifica el campo de descripción. El valor puede contener caracteres como letras y dígitos, pero no puede contener menos de signos (<) y grandes que signos (>). |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
client_port |
No |
Integer |
Especifica el puerto al que se puede acceder un punto de conexión de VPC. Este puerto es proporcionado por el punto de conexión de VPC, lo que le permite acceder al servicio de punto de conexión de VPC. Rango soportado: 1 a 65535. Mínimo: 1 Máximo: 65535 |
server_port |
No |
Integer |
Especifica el puerto para acceder al servicio de punto de conexión de VPC. Este puerto está asociado con recursos de backend para proporcionar servicios de punto de conexión de VPC. Rango soportado: 1 a 65535 Mínimo: 1 Máximo: 65535 |
protocol |
No |
String |
Protocolo de mapeo de puertos. Se admite TCP. Predeterminado: TCP |
Parámetros de Respuesta
Status code: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el identificador único del servicio de punto de conexión de VPC. |
port_id |
String |
Especifica el ID del recurso backend del servicio de punto de conexión de VPC. El ID está en el formato de identificador único universal (UUID). Las opciones son las siguientes: ● Balanceador de carga: Especifica el ID de puerto de la dirección IP privada del balanceador de carga compartido. ● Máquina virtual: Especifica el ID de NIC de la dirección IP de ECS. ● Dirección IP virtual: Especifica el ID de NIC del servidor físico donde se encuentra el recurso virtual. |
vip_port_id |
String |
Especifica el ID de la NIC virtual a la que está enlazada la dirección IP virtual. Este parámetro se devuelve solo cuando port_id se establece en VIP. |
service_name |
String |
Especifica el nombre del servicio de punto de conexión de VPC. Mínimo: 0 Máximo: 128 |
server_type |
String |
Especifica el tipo de recurso. ● VM: indica un servidor en la nube. ● VIP: indica una dirección IP virtual. ● LB: indica un equilibrador de carga compartido. |
vpc_id |
String |
Especifica el ID de la VPC a la que pertenece el recurso backend del servicio de punto de conexión de VPC. |
pool_id |
String |
Especifica el identificador de clúster del servicio de punto de conexión de VPC. |
approval_enabled |
Boolean |
Especifica si se requiere aprobación. ● falso: No se requiere aprobación. El punto de conexión de VPC creado está en el estado aceptado de forma predeterminada. ● true: Se requiere aprobación. El punto de conexión de VPC creado está en el estado de aceptación pendiente y solo se puede usar después de ser aprobado por el usuario del servicio de punto de conexión de VPC. |
status |
String |
Especifica el estado del servicio de punto de conexión de VPC. ● creating: Se está creando el servicio de punto de conexión de VPC. ● available: Se puede conectar el servicio de punto de conexión de VPC. ● failed: No se puede crear el servicio de punto de conexión de VPC. |
service_type |
String |
Especifica el tipo del servicio de punto de conexión de VPC. Hay dos tipos de servicios de punto de conexión de VPC: interfaz y gateway. ● gateway: los servicios de punto de conexión de VPC de este tipo son configurados por el personal de O&M. Pueden usarlos directamente sin crearlos por ustedes mismos. ● interface: Se incluyen los servicios en la nube configurados por el personal de O&M y los servicios privados creados por ustedes mismos. Los servicios en la nube configurados por el personal de O&M no necesitan ser creados. Puedes usarlo directamente. Puede crear un punto de conexión de VPC para acceder al gateway y la interfaz de servicios de punto de conexión de VPC. |
created_at |
String |
Especifica la hora de creación del servicio de punto de conexión de VPC. El formato de hora UTC aplicado es AAAA-MMDDTHH:MM:SSZ. |
updated_at |
String |
Especifica la hora de actualización del servicio de punto de conexión de VPC. El formato de hora UTC aplicado es AAAA-MMDDTHH:MM:SSZ. |
project_id |
String |
ID del proyecto |
cidr_type |
String |
Especifica el tipo de bloque CIDR. ● público: indica un bloque CIDR público. ● interno: indica un bloque CIDR privado. El valor predeterminado es interno. |
ports |
Array of PortList objects |
Especifica las asignaciones de puertos abiertas por el servicio de punto de conexión de VPC. No se permiten asignaciones de puertos duplicados en el mismo servicio de punto de conexión de VPC. Si varios servicios de punto de conexión de VPC comparten un ID de puerto, las combinaciones de puertos y protocolos de servidor para todas las asignaciones de puertos entre servicios de punto de conexión de VPC deben ser únicas. |
tcp_proxy |
String |
Especifica si la información del cliente, como la dirección IP, el número de puerto y el identificador_de_marcador, se transmite al servidor. Se admiten los siguientes métodos: ● TCP TOA: transmite la información del cliente insertada en el campo de opción tcp al servidor. Nota: TCP TOA solo se admite cuando el tipo de recurso backend es Object Storage Service (OBS). ● Protocolo proxy: transmite la información del cliente insertada en el campo de carga útil tcp al servidor. tcp_proxy solo está disponible cuando el servidor puede analizar los campos tcp opción y tcp payload. Los valores son los siguientes: ● close: indica que el protocolo proxy está deshabilitado. ● toa_open: indica que el protocolo proxy tcp_toa está habilitado. ● proxy_open: indica que el protocolo proxy_protocolo está habilitado. ● open: indica que tanto tcp_toa como proxy_protocolo están habilitados. El valor predeterminado es close. |
tags |
Array of TagList objects |
Lista de etiquetas de recursos |
description |
String |
Especifica el campo de descripción. El valor puede contener caracteres como letras y dígitos, pero no puede contener menos de signos (<) y grandes que signos (>). |
Parámetro |
Tipo |
Descripción |
---|---|---|
client_port |
Integer |
Especifica el puerto al que se puede acceder un punto de conexión de VPC. Este puerto es proporcionado por el punto de conexión de VPC, lo que le permite acceder al servicio de punto de conexión de VPC. Rango soportado: 1 a 65535. Mínimo: 1 Máximo: 65535 |
server_port |
Integer |
Especifica el puerto para acceder al servicio de punto de conexión de VPC. Este puerto está asociado con recursos de backend para proporcionar servicios de punto de conexión de VPC. Rango soportado: 1 a 65535 Mínimo: 1 Máximo: 65535 |
protocol |
String |
Protocolo de mapeo de puertos. Se admite TCP. Predeterminado: TCP |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Especifica la clave de etiqueta. Una clave de etiqueta contiene un máximo de 36 caracteres Unicode. El campo del elemento no puede quedar en blanco. No puede contener signos iguales (=), asteriscos (*), menos que signos (<), mayor que signos (>), barras invertidas (), comas (,), barras verticales (|), y barras (/), y los caracteres primero y último no pueden ser espacios. Mínimo: 1 Máximo: 36 |
value |
String |
Especifica la clave de etiqueta. Un valor de etiqueta contiene un máximo de 43 caracteres Unicode y puede ser una cadena vacía. No puede contener signos iguales (=), asteriscos (*), menos que signos (<), mayor que signos (>), barras invertidas (), comas (,), barras verticales (|), y barras (/), y los caracteres primero y último no pueden ser espacios. Mínimo: 1 Máximo: 43 |
Status code: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 404
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 405
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 406
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 407
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 408
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 409
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 501
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 502
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 503
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Status code: 504
Parámetro |
Tipo |
Descripción |
---|---|---|
error |
Error object |
Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
message |
String |
Descripción de error de tarea |
code |
String |
Código de error de una excepción de tarea. |
Solicitudes de Ejemplo
PUT https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2- d380272eed88 { "approval_enabled" : true, "service_name" : "test", "ports" : [ { "client_port" : 8081, "server_port" : 22, "protocol" : "TCP" }, { "client_port" : 8082, "server_port" : 23, "protocol" : "TCP" } ] }
Respuestas de Ejemplo
Status code: 200
El servidor ha procesado correctamente la solicitud.
{ "id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "port_id" : "4189d3c2-8882-4871-a3c2-d380272eed88", "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed80", "pool_id" : "5289d3c2-8882-4871-a3c2-d380272eed80", "status" : "available", "approval_enabled" : false, "service_name" : "test123", "service_type" : "interface", "server_type" : "VM", "project_id" : "6e9dfd51d1124e8d8498dce894923a0d", "created_at" : "2022-04-14T09:35:47Z", "ports" : [ { "client_port" : 8080, "server_port" : 90, "protocol" : "TCP" }, { "client_port" : 8081, "server_port" : 80, "protocol" : "TCP" } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
El servidor ha procesado correctamente la solicitud. |
400 |
El servidor no pudo entender la solicitud debido a una sintaxis mal formada. |
401 |
La página solicitada requiere un nombre de usuario y contraseña. |
403 |
El servidor entendió la solicitud, pero se niega a cumplirla. |
404 |
La página solicitada no se ha podido encontrar. |
405 |
El método especificado en la línea de solicitud no está permitido para el recurso identificado por el URI de solicitud. |
406 |
El recurso identificado por la solicitud sólo es capaz de generar entidades de respuesta que tienen características de contenido no aceptables de acuerdo con las cabeceras de aceptación enviadas en la solicitud. |
407 |
El cliente primero debe autenticarse con el proxy. |
408 |
El cliente no produjo una solicitud dentro del tiempo que el servidor estaba preparado para esperar. |
409 |
No se pudo completar la solicitud debido a un conflicto con el estado actual del recurso. |
500 |
Error al completar la solicitud. Anormalidad del servicio. |
501 |
Error al completar la solicitud. El servidor no admite la función solicitada. |
502 |
Error al completar la solicitud. porque el servidor ha recibido una respuesta no válida. |
503 |
Error al completar la solicitud. porque el sistema no está disponible. |
504 |
Fin del tiempo de espera del gateway |
Códigos de error
Consulte Códigos de error.