Consulta de detalles de un punto de conexión de VPC
Función
Esta API se utiliza para consultar detalles sobre un punto de conexión de VPC.
URI
GET /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Mínimo: 1 Máximo: 64 |
vpc_endpoint_id |
Sí |
String |
Especifica el ID del punto de conexión de VPC. Mínimo: 1 Máximo: 64 |
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. Mínimo: 1 Máximo: 2048 |
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. Mínimo: 1 Máximo: 64 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID único del punto de conexión de VPC. |
service_type |
String |
Especifica el tipo de servicio del punto de conexión de VPC asociado con el punto de conexión de VPC. ● gateway: configurado por el personal de O&M. Pueden usarlos directamente sin crearlos por ustedes mismos. ● interface: incluye servicios en la nube configurados por el personal de O&M y servicios privados creados por los usuarios. No puede configurar estos servicios en la nube, pero puede usarlos. Puede consultar los servicios de punto de conexión de VPC públicos para ver los servicios de punto de conexión de VPC que son visibles y accesibles para todos los usuarios configurados por el personal de O&M. También puede crear un servicio de punto de conexión de VPC de interfaz creando un servicio de punto de conexión de VPC. |
status |
String |
Especifica el estado de conexión del punto de conexión de VPC. ●pendingAcceptance: La conexión de punto de conexión de VPC debe ser aceptada. ● creating: Se está creando la conexión de punto de conexión de VPC. ●accepted: Se ha aceptado la conexión de punto de conexión de VPC. ● failed: Error en la conexión de punto de conexión de VPC. |
active_status |
Matriz de strings |
Especifica el estado de la cuenta. ● frozen: La cuenta está congelada. ● active: La cuenta no está congelada. |
enable_status |
String |
Especifica si el punto de conexión de VPC está disponible. ● enable: El punto de conexión de VPC está habilitado. ● disable: El punto de conexión de VPC está deshabilitado. |
specification_name |
String |
Especifica el nombre de la especificación del servicio de punto de conexión de VPC. |
endpoint_service_name |
String |
Especifica el nombre del servicio de punto de conexión de VPC. |
marker_id |
Integer |
Especifica el ID de paquete del punto de conexión de VPC. |
endpoint_service_id |
String |
Especifica el ID del servicio de punto de conexión de VPC. |
enable_dns |
Boolean |
Especifica si se va a crear un nombre de dominio. ● true: Se requiere un nombre de dominio. ● false: No se requiere un nombre de dominio. Nota: Cuando se crea un punto de conexión de VPC para conectar un servicio de punto de conexión de VPC de gateways, no se crea ningún nombre de dominio si enable_dns se establece en true o false. |
dns_names |
Matriz de strings |
Especifica el nombre de dominio para acceder al servicio de punto de conexión de VPC asociado. Este parámetro solo está disponible cuando enable_dns se establece en true. |
ip |
String |
Especifica la dirección IP para acceder al servicio de punto de conexión de VPC asociado. Este parámetro se devuelve solo cuando se cumplen las siguientes condiciones: ● Puede consultar un punto de conexión de VPC para acceder a un servicio de punto de conexión de VPC de interfaz. ● La función de aprobación de conexión está habilitada para el servicio de punto de conexión de VPC y la conexión ha sido aprobada. El estado del punto de conexión de VPC puede ser accepted o rejected. El estado rejected solo aparece cuando se acepta la conexión de punto de conexión de VPC y luego se rechaza. |
vpc_id |
String |
Especifica el ID de la VPC donde se va a crear el punto de conexión de VPC. |
subnet_id |
String |
Especifica el ID de la subred en la VPC basado en vpc_id. El ID está en formato UUID. |
created_at |
String |
Especifica la hora de creación del punto de conexión de VPC. El formato de hora UTC aplicado es AAAA-MM-DDTHH:MM:SSZ. |
updated_at |
String |
Especifica la hora de actualización del punto de conexión de VPC. El formato de hora UTC aplicado es AAAA-MM-DDTHH:MM:SSZ. |
project_id |
String |
Especifica el ID del proyecto. Para obtener más información sobre cómo obtener un ID de proyecto, consulte "Obtención de un ID de proyecto". |
tags |
Matriz de objetos de TagList |
Especifica la lista de etiquetas. Si no hay ninguna etiqueta en la lista, las etiquetas se toman como una matriz vacía. |
error |
Objeto de QueryError |
Información de excepción devuelta durante la consulta de recursos. |
whitelist |
Matriz de strings |
Especifica la lista blanca para controlar el acceso al punto de conexión de VPC. Si no especifica este parámetro, se devuelve una lista blanca vacía. Este parámetro solo está disponible cuando se crea un punto de conexión de VPC para conectarse a un servicio de punto de conexión de VPC de interfaz. |
enable_whitelist |
Boolean |
Especifica si se debe habilitar el aislamiento de ACL de red. ● true: El aislamiento de ACL de red está habilitado. ● false: El aislamiento de ACL de red está deshabilitado. Si no especifica este parámetro, el aislamiento de ACL de red está deshabilitado. Este parámetro solo está disponible cuando se crea un punto de conexión de VPC para conectarse a un servicio de punto de conexión de VPC de interfaz. |
routetables |
Matriz de strings |
Especifica los ID de las tablas de ruta. Si no especifica este parámetro, se devuelve el ID de tabla de ruta de la VPC. Este parámetro solo está disponible cuando se crea un punto de conexión de VPC para conectarse a un servicio de punto de conexión de VPC de interfaz. |
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 (>). |
policy_statement |
Matriz de strings |
Este campo se muestra en el cuerpo de respuesta solo para habilitar el punto de conexión de VPC de gateway con puertos fijos en ambos extremos. |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Especifica la clave de etiqueta. Una clave de etiqueta contiene un máximo de 36 caracteres Unicode. No se puede dejar en blanco. No puede contener signos iguales (=), asteriscos (*), signos menor que (<), signos mayor que (>), barras invertidas (), comas (,), barras verticales (|), ni 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 puede contener un máximo de 43 caracteres Unicode y puede ser una cadena vacía. No puede contener signos iguales (=), asteriscos (*), signos menor que (<), signos mayor que (>), barras invertidas (), comas (,), barras verticales (|), ni barras (/), y los caracteres primero y último no pueden ser espacios. Mínimo: 1 Máximo: 43 |
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_message |
String |
Mensaje de error. |
Código de estado: 400
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. |
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. |
Código de estado: 401
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. |
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. |
Código de estado: 403
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. |
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. |
Código de estado: 404
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. |
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. |
Código de estado: 405
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. |
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. |
Código de estado: 406
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. |
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. |
Código de estado: 407
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. |
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. |
Código de estado: 408
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. |
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. |
Código de estado: 409
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. |
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. |
Código de estado: 500
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. |
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. |
Código de estado: 501
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. |
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. |
Código de estado: 502
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. |
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. |
Código de estado: 503
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. |
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. |
Código de estado: 504
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. |
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. |
Ejemplo de solicitudes
GET https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2- d380272eed83
Ejemplo de respuestas
Código de estado: 200
El servidor ha procesado correctamente la solicitud.
{ "id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "service_type" : "interface", "marker_id" : 16777337, "status" : "accepted", "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed83", "enable_dns" : false, "endpoint_service_name" : "test123", "endpoint_service_id" : "test123", "project_id" : "6e9dfd51d1124e8d8498dce894923a0d", "whitelist" : [ "127.0.0.1" ], "enable_whitelist" : true, "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 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 una 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.