Atualização da lista branca de um ponto de extremidade da VPC
Função
Função Essa API é usada para atualizar ou excluir a lista branca de um ponto de extremidade da VPC.
URI
PUT /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
Especifica o ID do projeto. Para obter detalhes sobre como obter o ID de projeto, consulte "Obtenção de um ID de projeto". Mínimo: 1 Máximo: 64 |
|
vpc_endpoint_id |
Sim |
String |
Especifica o ID do ponto de extremidade da VPC. Mínimo: 1 Máximo: 64 |
Parâmetros de solicitação
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Especifica o token do usuário. Ele pode ser obtido chamando a API do IAM. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. Mínimo: 1 Máximo: 2048 |
|
Content-Type |
Sim |
String |
Especifica o tipo MIME do corpo da solicitação. O valor padrão application/json é recomendado. Para as API usadas para carregar objetos ou imagens, o tipo MIME pode variar dependendo do tipo de fluxo. Mínimo: 1 Máximo: 64 |
|
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
|---|---|---|---|
|
whitelist |
Não |
Array of strings |
Especifica a lista branca atualizada ou excluída para controlar o acesso aos pontos de extremidade da VPC. O valor pode ser um endereço IPv4 ou bloco CIDR. As descrições da configuração são seguintes: ● Se o valor for especificado, a lista branca será atualizada para o valor especificado. ● Se este parâmetro for deixado em branco, todas as listas brancas serão excluídas. A lista branca é deixada em branco por padrão. |
|
enable_whitelist |
Não |
Boolean |
Especifica se deve ativar o isolamento da ACL de rede. ● true: o isolamento da ACL de rede está habilitado. ● false: o isolamento ACL de rede está desabilitado. O valor padrão é false. |
Parâmetros de resposta
Código de estado: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
Especifica o ID exclusivo do ponto de extremidade da VPC. |
|
service_type |
String |
Especifica o tipo de serviço do ponto de extremidade da VPC associado ao ponto de extremidade da VPC. ● gateway: os serviços do ponto de extremidade de VPC desse tipo são configurados por equipe de O&M. Você pode usá-los diretamente sem criá-los por si mesmos. ● interface: serviços de nuvem configurados pela equipe de O&M e serviços privados criados por você estão incluídos. Você não pode configurar esses serviços de nuvem, mas pode usá-los. Você pode consultar serviços públicos do ponto de extremidade da VPC para visualizar os serviços do ponto de extremidade da VPC visíveis e acessíveis a todos os usuários configurados pela equipe de O&M. Você pode criar um serviço de interface do ponto de extremidade da VPC. |
|
status |
String |
Especifica o status da conexão do ponto de extremidade da VPC. ●pendingAcceptance: a conexão do ponto de extremidade da VPC deve ser aceita. ● creating: s conexão do ponto de extremidade da VPC está sendo criada. ●accepted: a conexão do ponto de extremidade da VPC foi aceita. ● failed: a conexão do ponto de extremidade da VPC falhou. |
|
ip |
String |
Especifica o endereço IP para acessar o serviço do ponto de extremidade da VPC associado. Este parâmetro é retornado somente quando as seguintes condições são atendidas: ● Você consulta um ponto de extremidade da VPC para acessar um serviço de interface de ponto de extremidade da VPC. ● A função de aprovação de conexão está habilitada para o serviço do ponto de extremidade da VPC, e a conexão foi aprovada. O status do ponto de extremidade da VPC pode ser accepted ou rejected. O status rejected aparece apenas quando o ponto de extremidade da VPC é aceito e, em seguida, rejeitado. |
|
active_status |
Array of strings |
Especifica o status da conta. ● frozen: a conta está congelada. ● active: a conta está descongelada. |
|
endpoint_service_name |
String |
Especifica o nome do serviço do ponto de extremidade da VPC. |
|
marker_id |
Integer |
Especifica o ID do pacote do ponto de extremidade da VPC. |
|
endpoint_service_id |
String |
Especifica o ID do serviço do ponto de extremidade da VPC. |
|
enable_dns |
Boolean |
Especifica se deve ou não criar um nome de domínio. ● true: um nome de domínio é necessário. ● false: um nome de domínio não é necessário. Observação: quando você cria um ponto de extremidade da VPC para conectar um serviço de gateway do ponto de extremidade da VPC, nenhum nome de domínio é criado se enable_dns estiver definido como true ou false. |
|
dns_names |
Array of strings |
Especifica o nome de domínio para acessar o serviço do ponto de extremidade da VPC associado. Este parâmetro só está disponível quando enable_dns é definido como true. |
|
subnet_id |
String |
Especifica o ID da sub-rede na VPC com base em vpc_id. O ID está no formato UUID. |
|
vpc_id |
String |
Especifica o ID da VPC em que o ponto de extremidade da VPC será criado. |
|
created_at |
String |
Especifica o horário de criação de ponto de extremidade da VPC. O formato de hora UTC aplicado é AAAA-MM-DDTHH:MM:SSZ. |
|
updated_at |
String |
Especifica o horário de atualização de ponto de extremidade da VPC. O formato de hora UTC aplicado é AAAA-MM-DDTHH:MM:SSZ. |
|
project_id |
String |
Especifica o ID do projeto. Para obter detalhes sobre como obter o ID de projeto, consulte "Obtenção de um ID de projeto". |
|
tags |
Array of TagList objects |
Especifica a lista de marcas. Se não houver nenhuma tag na lista, as tags serão tomadas como uma matriz vazia. |
|
whitelist |
Array of strings |
Especifica a lista branca para controlar o acesso ao ponto de extremidade da VPC. Se você não especificar este parâmetro, uma lista branca vazia é retornada. Esse parâmetro só está disponível quando você cria um ponto de extremidade da VPC para conectar-se a um serviço de interface de ponto de extremidade da VPC. |
|
enable_whitelist |
Boolean |
Especifica se deve ativar o isolamento da ACL de rede. ● true: o isolamento da ACL de rede está habilitado. ● false: o isolamento ACL de rede está desabilitado. Se você não especificar esse parâmetro, o isolamento da ACL de rede será desabilitado. Esse parâmetro só está disponível quando você cria um ponto de extremidade da VPC para conectar-se a um serviço de interface de ponto de extremidade da VPC. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
key |
String |
Especifica a chave de tag. Uma chave de tag contém um máximo de 36 caracteres Unicode. Não pode ser deixado em branco. Não pode conter sinais iguais (=), asteriscos (*), sinais menores (<), sinais maiores (>), barras invertidas (), vírgulas (,), barras verticais (|) e barras (/), e o primeiro e último caracteres não podem ser espaços. Mínimo: 1 Máximo: 36 |
|
value |
String |
Especifica a chave de tag. Um valor de tag pode conter um máximo de 43 caracteres Unicode e pode ser uma cadeia vazia. Não pode conter sinais iguais (=), asteriscos (*), sinais menores (<), sinais maiores (>), barras invertidas (), vírgulas (,), barras verticais (|) e barras (/), e o primeiro e último caracteres não podem ser espaços. Mínimo: 1 Máximo: 43 |
Código de estado: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
Código |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 401
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 403
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 404
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 405
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 406
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 407
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 408
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 409
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 501
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 502
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 503
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 504
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
message |
String |
Descrição do erro da tarefa |
|
code |
String |
Código de erro de uma exceção de tarefa. |
Exemplo de solicitações
PUT https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2- d380272eed83
{
"whitelist":
[
"192.168.1.1",
"192.168.1.2"
],
"enable_whitelist":true,
}
Exemplo de respostas
Código de estado: 200
O servidor processou a solicitação com sucesso.
{
"id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
"service_type" : "interface",
"status" : "accepted",
"ip" : "10.32.xx.xx",
"marker_id" : 322312312312,
"vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
"enable_dns" : true,
"endpoint_service_name" : "test123",
"endpoint_service_id" : "test123",
"project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
"whitelist" : [ "192.168.1.1", "192.168.1.2" ],
"enable_whitelist" : true,
"created_at" : "2022-04-14T09:35:47Z",
"updated_at" : "2022-04-14T09:36:47Z",
"tags" : [ {
"key" : "test1",
"value" : "test1"
} ]
}
Códigos de estado
|
Código de estado |
Descrição |
|---|---|
|
200 |
O servidor processou a solicitação com sucesso. |
|
400 |
A solicitação não pôde ser entendida pelo servidor devido à sintaxe mal formada. |
|
401 |
A página solicitada requer um nome de usuário e senha. |
|
403 |
O servidor entendeu o pedido, mas está se recusando a cumpri-lo. |
|
404 |
A página solicitada não foi encontrada. |
|
405 |
O método especificado na linha de solicitação não é permitido para o recurso identificado pelo URI da solicitação. |
|
406 |
O recurso identificado pela solicitação só é capaz de gerar entidades de resposta que tenham características de conteúdo não aceitáveis de acordo com os cabeçalhos de aceitação enviados na solicitação. |
|
407 |
O cliente deve primeiro autenticar-se com o proxy. |
|
408 |
O cliente não produziu uma solicitação dentro do tempo que o servidor estava preparado para esperar. |
|
409 |
A solicitação não pôde ser concluída devido a um conflito com o estado atual do recurso. |
|
500 |
Falhou ao concluir a solicitação. Anormalidade de serviço. |
|
501 |
Falhou ao concluir a solicitação. O servidor não suporta a função solicitada. |
|
502 |
Falhou ao concluir a solicitação. porque o servidor recebe uma resposta inválida. |
|
503 |
Falhou ao concluir a solicitação. porque o sistema não está disponível. |
|
504 |
Gateway expirou o tempo limite |
Códigos de erro
Consulte Códigos de erro.