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 detalles de un servicio de punto de conexión de VPC
Actualización más reciente 2024-09-14 GMT+08:00
Ver PDF
Compartir

Consulta de detalles de un servicio de punto de conexión de VPC

Función

Esta API se utiliza para consultar detalles sobre un servicio de punto de conexión de VPC.

Método de invocación

Para obtener más información, consulte Invocación a las API.

URI

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

Tabla 1 Parámetros de enrutamiento

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto.

Mínimo: 1

Máximo: 64

vpc_endpoint_service_id

Sí

String

Especifica el ID del servicio de punto de conexión de VPC.

Mínimo: 1

Máximo: 64

Parámetros de solicitud

Tabla 2 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Especifica el token de usuario. Se puede obtener invocando a la API de IAM. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

Content-Type

No

String

Especifica el tipo MIME del cuerpo de la solicitud. Se recomienda el valor application/json. Para las API utilizadas para cargar objetos o imágenes, el tipo MIME varía en función del tipo de flujo.

Valor predeterminado: application/json

Parámetros de respuesta

Código de estado: 200

Tabla 3 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

id

String

Especifica el ID único del servicio de punto de conexión de VPC.

Mínimo: 1

Máximo: 64

port_id

String

Especifica el ID que identifica el recurso backend del servicio de punto de conexión de VPC. El ID está en formato de UUID. El valor puede ser:

  • LB: indica el ID del puerto de la dirección IP privada de un balanceador de carga (recomendado).

  • VM: indica el ID de NIC de una dirección IP de ECS.

  • VIP: indica el ID de NIC del servidor virtual para el que se configura la dirección IP virtual. (Este valor ha sido descartado. Se recomienda LB)

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: servidor en nube

  • VIP: dirección IP virtual

  • LB: balanceador de carga mejorado

vpc_id

String

Especifica el ID de la VPC donde se encuentra el recurso backend del servicio de punto de conexión de la VPC.

Mínimo: 1

Máximo: 64

approval_enabled

Boolean

Especifica si se requiere la aprobación de la conexión.

  • false: no se requiere la aprobación de conexión. El punto de conexión de VPC creada se encuentra en estado accepted.

  • true: Se requiere la aprobación de la conexión. El punto de conexión de VPC creado se encuentra en el estado de pendingAcceptance, 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 pudo 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. Existen dos tipos de servicios de punto de conexión de VPC: interfaz y gateway.

  • gateway: Indica los servicios de punto de conexión de VPC configurados por el personal de O&M. Puede usarlos directamente sin crearlos usted mismo.

  • interface: indica los servicios en la nube configurados por el personal de O&M y los servicios privados creados por ustedes. No puede configurar estos servicios en la nube, pero puede utilizarlos. Se pueden crear puntos de conexión de VPC para conectarse a servicios de puntos de conexión de VPC de gateway y de interfaz.

created_at

String

Especifica cuándo se creó el servicio de punto de conexión de VPC. Se utiliza el formato de hora UTC AAAA-MMDDTHH:MM:SSZ.

updated_at

String

Especifica cuándo se actualizó el servicio de punto de conexión de VPC. Se utiliza el formato de hora UTC AAAA-MMDDTHH:MM:SSZ.

project_id

String

Especifica el ID del proyecto. Para obtener detalles sobre cómo obtener el ID de proyecto, consulte "Obtención de un ID de proyecto".

Mínimo: 1

Máximo: 64

cidr_type

String

Especifica el tipo de bloque del CIDR.

  • public: indica un bloqueo de CIDR público.

  • internal: indica un bloque CIDR privado. internal es el valor predeterminado.

ports

Array of PortList objects

Especifica los mapeos de puertos abiertos para el servicio de punto de conexión de VPC. No se permiten mapeos 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 port_id, debe ser único server_port o protocol, o ambos server_port y protocol de cada uno de estos servicios de punto de conexión.

tcp_proxy

String

Especifica si se va a transferir al servidor información del cliente, como direcciones IP de origen, números de puerto de origen e ID de marcadores. La información se puede enviar al servidor de las siguientes maneras:

  • TCP TOA: La información del cliente se coloca en el campo tcp option y se envía al servidor. Nota: TCP TOA solo está disponible cuando el recurso backend es OBS.

  • Proxy Protocol: La información del cliente se coloca en el campo tcp payload y se envía al servidor. tcp_proxy solo está disponible cuando el servidor puede analizar los campos tcp option y tcp payload. El valor puede ser uno de los siguientes:

  • close: No se transporta información de TCP TOA ni de Proxy Protocol.

  • toa_open: Se transporta información de TCP TOA.

  • proxy_open: Se transporta la información de Proxy Protocol.

  • open: Se transporta información tanto de TCP TOA como de Proxy Protocol.

  • proxy_vni: Solo se transporta información de Proxy Protocol y de Proxy VNI. close es el valor predeterminado.

tags

Array of TagList objects

Especifica etiquetas de recursos.

error

Array of Error objects

Especifica el mensaje de error que se devuelve cuando se produce un error.

enable_policy

Boolean

Especifica si la política de punto de conexión de VPC está habilitada.

  • false: no se puede configurar la política de punto de conexión de VPC.

  • true: Se puede configurar la política de punto de conexión de VPC. El valor predeterminado es false.

description

String

Especifica el campo de descripción. El valor puede contener caracteres como letras y dígitos, pero no puede contener signos menores que (<) ni mayores que signos (>).

Mínimo: 0

Máximo: 512
Tabla 4 PortList

Parámetro

Tipo

Descripción

client_port

Integer

Especifica el puerto al que accederá un punto de conexión de VPC. Este puerto es provisto por el punto de conexión de VPC, lo que permite acceder al servicio de punto de conexión de VPC. Rango soportado: 1 a 65535.

Mínimo: 1

Máximo: 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 se asocia con recursos backend para brindar servicios de punto de conexión de VPC. Rango soportado: 1 a 65535

Mínimo: 1

Máximo: 65535

Mínimo: 1

Máximo: 65535

protocol

String

Protocolo de mapeo de puertos. Se soporta TCP.

Valor predeterminado: TCP
Tabla 5 TagList

Parámetro

Tipo

Descripción

key

String

Especifica la clave de etiqueta. Una clave de etiqueta contiene un máximo de 36 caracteres de Unicode. 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 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 6 Error

Parámetro

Tipo

Descripción

message

String

Descripción del error de tarea

Mínimo: 0

Máximo: 1024

code

String

Código de error de una excepción de tarea.

Mínimo: 0

Máximo: 10

Ejemplo de solicitudes

Información detallada sobre un servicio de punto de conexión de VPC

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}

This request is to query connections of the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88.GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88

Ejemplo de respuestas

Código de estado: 200

El servidor procesó correctamente la solicitud.

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

Códigos de estado

Código de estado

Descripción

200

El servidor procesó correctamente la solicitud.

Códigos de error

Consulte Códigos de error.