Consulta de conexiones de un servicio de punto de conexión de VPC
Función
Esta API se utiliza para consultar conexiones a un servicio de punto de conexión de VPC. El ID de marcador es el ID único de cada conexión.
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}/connections
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ámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
No |
String |
Especifica el ID único del punto de conexión de VPC. Mínimo: 1 Máximo: 64 |
marker_id |
No |
String |
Especifica el ID de paquete del punto de conexión de VPC. |
status |
No |
String |
Especifica el estado de conexión del punto de conexión de la VPC. ● pendingAcceptance: Se aceptará el punto de conexión de VPC. ● 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. |
sort_key |
No |
String |
Especifica el campo de clasificación de los puntos de conexión de VPC, que puede ser: ●create_at: los puntos de conexión de VPC se ordenan por tiempo de creación. ●update_at: los puntos de conexión de VPC se ordenan por hora de actualización. El campo predeterminado es create_at. Valor predeterminado: create_at |
sort_dir |
No |
String |
Especifica el método de clasificación de los puntos de conexión de VPC, que puede ser: ● desc: se ordenan los puntos de conexión de VPC en orden descendente. ● asc: los puntos 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 conexiones que se muestran en cada página. El valor oscila entre 0 y 1000 y generalmente es de 10, 20 o 50. El número predeterminado es 10. Mínimo: 1 Máximo: 1000 Predeterminado: 10 |
offset |
No |
Integer |
Especifica el desfase. Se consultarán todos los servicios de punto de conexión de VPC después de este desfase. El desfase debe ser un entero mayor que 0 pero menor que la cantidad de servicios punto de conexión de VPC. Mínimo: 0 |
Parámetros 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
Parámetro |
Tipo |
Descripción |
---|---|---|
connections |
Array of ConnectionEndpoints objects |
Especifica la lista de conexiones. |
total_count |
Integer |
Especifica el número total de puntos de conexión de VPC que cumplen los criterios de búsqueda. El número no se ve afectado por limit ni offset. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID único del punto de conexión de VPC. Mínimo: 1 Máximo: 64 |
marker_id |
Integer |
Especifica el ID de paquete del punto de conexión de VPC. |
created_at |
String |
Especifica el tiempo de creación del punto de conexión de la VPC. El formato de hora UTC aplicado es AAAA-MMDDTHH:MM:SSZ. |
updated_at |
String |
Especifica el tiempo de actualización del punto de conexión de VPC. El formato de hora UTC aplicado es AAAA-MMDDTHH:MM:SSZ. |
domain_id |
String |
ID de dominio de un usuario. Mínimo: 1 Máximo: 64 |
error |
Array of QueryError objects |
Especifica el mensaje de error. Este campo se devuelve cuando el punto de conexión de VPC es anormal, es decir, el valor de status es failed. |
status |
String |
Especifica el estado de conexión del punto de conexión de la VPC. ● pendingAcceptance: Se aceptará el punto de conexión de VPC. ● 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. ● rejected: Se ha rechazado la conexión de punto de conexión de VPC. ● failed: Error en la conexión de punto de conexión de VPC. ● deleting: se está eliminando la conexión de punto de conexión de VPC. |
description |
String |
Especifica la descripción de una conexión del punto de conexión de VPC. Mínimo: 0 Máximo: 512 |
Ejemplo de solicitudes
Consulta de conexiones a un servicio de punto de conexión de VPC
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections? id={vpc_endpoint_id}&marker_id={marker_id}&status={status}&sort_key={sort_key }&sort_dir={sort_dir}&limit={limit}&offset={offset} 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/connections
Ejemplo de respuestas
Código de estado: 200
El servidor procesó correctamente la solicitud.
{ "connections" : [ { "id" : "adb7b229-bb11-4072-bcc0-3327cd784263", "status" : "accepted", "marker_id" : 16777510, "domain_id" : "5fc973eea581490997e82ea11a1df31f", "created_at" : "2018-09-17T11:10:11Z", "updated_at" : "2018-09-17T11:10:12Z" }, { "id" : "fd69d29f-dc29-4a9b-80d8-b51d1e7e58ea", "status" : "accepted", "marker_id" : 16777513, "domain_id" : "5fc973eea581490997e82ea11a1df31f", "created_at" : "2018-09-17T07:28:56Z", "updated_at" : "2018-09-17T07:28:58Z" } ], "total_count" : 2 }
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.