Consulta de registros de lista blanca de un servicio de punto de conexión de VPC
Función
Función Esta API se utiliza para consultar los registros de la lista blanca de un servicio de punto de conexión de VPC. Nota: Su cuenta está en la lista blanca de su propio servicio de punto de conexión de VPC de forma predeterminada.
URI
GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Project ID. 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 |
---|---|---|---|
permission |
No |
String |
Especifica el ID de cuenta de permiso en formato iam:domain::domain_id. domain_id indica el ID de cuenta del usuario autorizado, por ejemplo, iam:domain::6e9dfd51d1124e8d8498dce894923a0d. Se soporta la búsqueda difusa. Mínimo: 1 Máximo: 1000 |
limit |
No |
Integer |
Especifica el número de registros de lista blanca devueltos del servicio de punto de conexión de VPC en cada página. El valor varía de 0 a 500 y es generalmente 10, 20 o 50. El número predeterminado es 10. Mínimo: 1 Máximo: 500 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 |
sort_key |
No |
String |
Especifica el campo de ordenación de los registros de la lista blanca. El valor es create_at, que indica la hora en que se agrega el registro de la lista blanca. Predeterminado: create_at |
sort_dir |
No |
String |
Especifica el método de ordenación de los registros de la lista blanca, que puede ser: ● desc: Los registros de la lista blanca se ordenan en orden descendente. ● asc: Los registros de la lista blanca se ordenan en orden ascendente. El método predeterminado es desc. Predeterminado: desc |
Parámetros de Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Yes |
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
Status code: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
permissions |
Array of PermissionObject objects |
Muestra los registros de la lista blanca. |
total_count |
Integer |
Especifica el número total de registros de la lista blanca que cumplen los criterios de búsqueda. El número no se ve afectado por los parámetros límite y desplazamiento. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el identificador único del permiso. |
permission |
String |
Especifica los permisos. El formato de permisos es iam:domain::6e9dfd51d1124e8d8498dce894923a0d o *.
|
created_at |
String |
Especifica la hora de agregar el registro de la lista blanca. El formato de hora UTC aplicado es AAAA-MMDDTHH:MM:SSZ. |
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
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions?permission={permission}&sort_dir={sort_dir}&limit={limit}&offset={offset} This request is to query whitelist records 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/permissions
Respuestas de Ejemplo
Status code: 200
El servidor ha procesado correctamente la solicitud.
{ "permissions" : [ { "id" : "f2659906-c622-480a-83e9-ef42bdb67b90", "permission" : "*", "created_at" : "2018-10-18T13:26:40Z" } ], "total_count" : 1 }
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.