Configuração de regras de controle de acesso
Função
Essa API é usada para configurar regras de controle de acesso. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/access-control
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário em uma região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
instance_id |
Sim |
String |
ID da instância, que é compatível com o formato UUID. |
proxy_id |
Sim |
String |
ID de instância de proxy, que é compatível com o formato UUID. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Se o corpo de resposta a seguir for retornado para chamar a API usada para obter um token de usuário, a solicitação será bem-sucedida. Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho da mensagem é o valor do token. |
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valor:
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
type |
Sim |
String |
Modo de controle de acesso. Valor:
|
ip_list |
Sim |
Array of AccessControlRule objects |
Matriz de endereços IP que controlam o acesso. Um máximo de 300 endereços IP ou blocos CIDR podem ser adicionados. |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
open_access_control |
Boolean |
Se o controle de acesso está ativado. Valor:
|
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Configuração de regras de controle de acesso
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/access-control { "type" : "black", "ip_list" : [ { "ip" : "192.107.0.1", "description" : "black01" } ] }
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "open_access_control" : false }
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.