Configuração de grupos de lista branca de IP
Função
Essa API é usada para configurar grupos de listas de permissões de endereços IP para uma instância específica, incluindo a criação, a desativação, a edição e a exclusão de uma lista de permissões. Novas configurações de lista branca substituirão a configuração existente. Portanto, salve a lista branca existente antes de adicionar uma nova.
URI
PUT /v2/{project_id}/instance/{instance_id}/whitelist
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| project_id | Sim | String | ID do projeto. |
| instance_id | Sim | String | ID da instância. |
Parâmetros de solicitação
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| instance_id | Não | String | ID da instância. |
| enable_whitelist | Sim | Boolean | Se ativar a lista branca. As opções são true e false. Valores de enumeração:
|
| whitelist | Sim | Array of Whitelist objects | Grupo da lista branca de IP. |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| group_name | Sim | String | Nome do grupo Whitelist. Um máximo de quatro grupos podem ser criados para cada instância. |
| ip_list | Sim | Array of strings | Lista de endereços IP no grupo whitelist. Um máximo de 20 endereços IP ou intervalos de endereços IP podem ser adicionados a uma instância. Separe vários endereços IP ou intervalos de endereços IP com vírgulas (,). O endereço IP 0.0.0.0 e o intervalo de endereços IP 0.0.0/0 não são suportados. |
Parâmetros de resposta
Código de estado: 400
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_msg | String | Mensagem de erro. Máximo: 1024 |
| error_code | String | Código de erro. Máximo: 9 |
| error_ext_msg | String | Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 401
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_msg | String | Mensagem de erro. Máximo: 1024 |
| error_code | String | Código de erro. Máximo: 9 |
| error_ext_msg | String | Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 403
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_msg | String | Mensagem de erro. Máximo: 1024 |
| error_code | String | Código de erro. Máximo: 9 |
| error_ext_msg | String | Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 404
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_msg | String | Mensagem de erro. Máximo: 1024 |
| error_code | String | Código de erro. Máximo: 9 |
| error_ext_msg | String | Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Código de estado: 500
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_msg | String | Mensagem de erro. Máximo: 1024 |
| error_code | String | Código de erro. Máximo: 9 |
| error_ext_msg | String | Informações de erro estendidas. Este parâmetro não é usado atualmente e está definido como nulo. Máximo: 1024 |
Exemplos de solicitações
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" ]
} ]
} Exemplo de respostas
Nenhum
Códigos de status
| Código de status | Descrição |
|---|---|
| 204 | Grupos de lista branca de IP configurados com sucesso. |
| 400 | Pedido inválido. |
| 401 | Informações de autenticação inválidas. |
| 403 | O pedido é rejeitado. |
| 404 | O recurso solicitado não foi encontrado. |
| 500 | Erro de serviço interno. |
Códigos de erro
Consulte Códigos de erro.
