Configuración de grupos de listas blancas de IP
Función
Esta API se utiliza para configurar grupos de listas blancas de direcciones IP para una instancia específica, incluida la creación, desactivación, edición y eliminación de una lista blanca. La nueva configuración de la lista blanca sobrescribirá la configuración existente. Por lo tanto, guarde la lista blanca existente antes de agregar una nueva.
URI
PUT /v2/{project_id}/instance/{instance_id}/whitelist
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. |
instance_id |
Sí |
String |
ID de instancia. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
instance_id |
No |
String |
ID de instancia. |
enable_whitelist |
Sí |
Boolean |
Si desea habilitar la lista blanca. Las opciones son true y false. Valores de enumeración:
|
whitelist |
Sí |
Array of Whitelist objects |
Grupo de lista blanca de IP. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
group_name |
Sí |
String |
Nombre del grupo de la lista blanca. Se pueden crear un máximo de cuatro grupos para cada instancia. |
ip_list |
Sí |
Array of strings |
Lista de direcciones IP en el grupo de listas blancas. Se puede agregar un máximo de 20 direcciones IP o intervalos de direcciones IP a una instancia. Separar múltiples direcciones IP o rangos de direcciones IP con comas (,). La dirección IP 0.0.0.0 y el rango de direcciones IP 0.0.0/0 no son compatibles. |
Parámetros de respuesta
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Código de estado: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Código de estado: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Código de estado: 404
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_msg |
String |
Mensaje de error. Máximo: 1024 |
error_code |
String |
Código de error. Máximo: 9 |
error_ext_msg |
String |
Información de error extendida. Este parámetro no se utiliza actualmente y se establece en null. Máximo: 1024 |
Solicitudes de ejemplo
PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist { "enable_whitelist" : true, "whitelist" : [ { "group_name" : "test001", "ip_list" : [ "10.10.10.1", "10.10.10.2" ] } ] }
Ejemplo de respuestas
Ninguno
Códigos de estado
Código de estado |
Descripción |
---|---|
204 |
Grupos de listas blancas IP configurados correctamente. |
400 |
Solicitud no válida. |
401 |
Información de autenticación no válida. |
403 |
The request is rejected. |
404 |
La página solicitada no se encuentra. |
500 |
Error interno del servicio. |
Códigos de error
Consulte Códigos de error.