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> VPC Endpoint> Referencia de la API> API> Servicios de punto de conexión de VPC> Consulta de servicios de punto de conexión de VPC

Actualización más reciente 2023-01-06 GMT+08:00

Ver PDF

Consulta de servicios de punto de conexión de VPC

Función

Función Esta API se utiliza para consultar servicios de punto de conexión de VPC.

URI

GET /v1/{project_id}/vpc-endpoint-services

**Tabla 1** Parámetros de ruta
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID del proyecto

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
endpoint_service_name	No	String	Especifica el nombre del servicio de punto de conexión de VPC. El nombre no distingue entre mayúsculas y minúsculas y admite coincidencia difusa. Mínimo: 1 Máximo: 128
id	No	String	Especifica el identificador único del servicio de punto de conexión de VPC.
status	No	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. ● deleting: Se está eliminando el servicio de punto de conexión de VPC.
sort_key	No	String	Especifica el campo de clasificación de los servicios de punto de conexión de VPC, que puede ser ● crear_at: los servicios de punto de conexión de VPC se ordenan por tiempo de creación. ● update_at: Los servicios de punto de conexión de VPC se ordenan por tiempo de actualización. El campo predeterminado es create_at. Predeterminado: create_at
sort_dir	No	String	Especifica el método de clasificación de los servicios de punto de conexión de VPC, que puede ser:● desc : los servicios de punto de conexión de VPC se ordenan en orden descendente. ● asc: los servicios de punto de conexión de VPC se ordenan en orden ascendente. El método predeterminado es desc. Predeterminado: desc
limit	No	Integer	Especifica el número máximo de servicios de punto de conexión de VPC que se muestran en cada página. El valor varía de 0 a 1000 y es generalmente 10, 20 o 50. El número predeterminado es 10. Mínimo: 1 Máximo: 1000 Predeterminado: 10
offset	No	Integer	Especifica el desfase. Todos los servicios de punto de conexión de VPC después de este desplazamiento serán consultados. El desplazamiento debe ser un entero mayor que 0 pero menor que el número de servicios de punto de conexión de VPC. Mínimo: 0
public_border_group	No	String	Especifica el servicio de punto de conexión de VPC que coincide con el atributo de borde en el resultado del filtrado.

Parámetros de Solicitud

**Tabla 3** Parámetros de cabecera 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ámetros de Respuesta

Status code: 200

**Tabla 4** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
endpoint_services	Array of ServiceList objects	Lista de servicios de punto de conexión de VPC
total_count	Integer	Especifica el número total de servicios de punto de conexión de VPC que cumplen los criterios de búsqueda. El número no se ve afectado por el parámetro límite o desplazamiento.

**Tabla 5** ServiceList
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: 16
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.
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 se encuentra en el estado de Aceptación pendiente, y solo puede ser utilizado después de ser aprobado por el usuario del servicio 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. ● deleting: Se está eliminando 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. Para obtener más información sobre cómo obtener el ID de proyecto, consulte Obtención de un ID de proyecto.
domain_id	String	ID de dominio
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.
tags	Array of TagList objects	Lista de etiquetas de recursos
connection_count	Integer	Especifica el número de punto de conexión de VPC que se encuentran en el estado Creating o Accepted.
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 tcp_toa está habilitado. ● proxy_open: indica que proxy_protocolo está habilitado. ● open: indica que tanto tcp_toa como proxy_protocolo están habilitados. El valor predeterminado es close.
error	Array of Error objects	Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.
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 (>).
public_border_group	String	Especifica la información sobre el grupo de bordes públicos del grupo correspondiente al servicio de punto de conexión de VPC.

**Tabla 6** PortList
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

**Tabla 7** TagList
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

**Tabla 8** Error
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: 400

**Tabla 9** Parámetros del cuerpo de respuesta
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.

**Tabla 10** Error
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

**Tabla 11** Parámetros del cuerpo de respuesta
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.

**Tabla 12** Error
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

**Tabla 13** Parámetros del cuerpo de respuesta
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.

**Tabla 14** Error
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

**Tabla 15** Parámetros del cuerpo de respuesta
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.

**Tabla 16** Error
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

**Tabla 17** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
error	Objeto de Error	Especifica el mensaje de error devuelto cuando se produce una excepción de envío de tareas.

**Tabla 18** Error
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

**Tabla 19** Parámetros del cuerpo de respuesta
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.

**Tabla 20** Error
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

**Tabla 21** Parámetros del cuerpo de respuesta
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.

**Tabla 22** Error
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

**Tabla 23** Parámetros del cuerpo de respuesta
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.

**Tabla 24** Error
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

**Tabla 25** Parámetros del cuerpo de respuesta
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.

**Tabla 26** Error
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

**Tabla 27** Parámetros del cuerpo de respuesta
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.

**Tabla 28** Error
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

**Tabla 29** Parámetros del cuerpo de respuesta
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.

**Tabla 30** Error
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

**Tabla 31** Parámetros del cuerpo de respuesta
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.

**Tabla 32** Error
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

**Tabla 33** Parámetros del cuerpo de respuesta
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.

**Tabla 34** Error
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

**Tabla 35** Parámetros del cuerpo de respuesta
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.

**Tabla 36** Error
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

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services?endpoint_service_name={endpoint_service_name}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}&status={status}

Respuestas de Ejemplo

Status code: 200

El servidor ha procesado correctamente la solicitud.

{
  "endpoint_services" : [ {
    "id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
    "port_id" : "4189d3c2-8882-4871-a3c2-d380272eed88",
    "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed80",
    "status" : "available",
    "approval_enabled" : false,
    "service_name" : "test123",
    "server_type" : "VM",
    "service_type" : "interface",
    "ports" : [ {
      "client_port" : "8080",
      "server_port" : "80",
      "protocol" : "TCP"
    }, {
      "client_port" : "8081",
      "server_port" : "80",
      "protocol" : "TCP"
    } ],
    "project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
    "created_at" : "2022-04-14T09:35:47Z",
    "updated_at" : "2022-04-14T09:36:47Z",
    "public_border_group" : "br-iaas-odin1raa"
  } ],
  "total_count" : 100
}

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