Modificação de tabelas de rotas associadas a um ponto de extremidade da VPC
Função
Função Essa API é usada para modificar a política de um ponto de extremidade da VPC de gateway.
URI
PUT /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}/policy
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
Especifica o ID do 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 |
Obrigatório |
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 APIs usadas para carregar objetos ou imagens, o tipo MIME pode variar dependendo do tipo de fluxo. Mínimo: 1 Máximo: 64 |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
policy_statement |
Sim |
Array of PolicyStatement objects |
Apenas pontos de extremidade da VPC de gateway com ambas as extremidades fixas estão envolvidos. |
Parâmetros de resposta
Código de status: 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: configurado pelo pessoal de O&M. Você pode usá-los diretamente sem criá-los por si mesmos. ● interface: inclui serviços em nuvem configurados pela equipe de O&M e serviços privados criados pelos usuários. 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ê também pode criar um serviço do ponto de extremidade da VPC de interface criando um serviço 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: a 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. |
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. |
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 aceita. O status do ponto de extremidade da VPC pode ser accepted ou rejected. O status rejected aparece apenas quando a conexão do ponto de extremidade da VPC é aceita e, em seguida, rejeitada. |
vpc_id |
String |
Especifica o ID da VPC em que o ponto de extremidade da VPC será criado. |
subnet_id |
String |
Especifica o ID da sub-rede na VPC com base em vpc_id. O ID está no formato UUID. |
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 tags. Se não houver nenhuma tag na lista, as tags serão tomadas como uma matriz vazia. |
error |
Array of QueryError objects |
Especifica a mensagem de erro. Esse campo é retornado quando o ponto de extremidade da VPC é anormal, ou seja, o valor de status é failed. |
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 da 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. |
routetables |
Array of strings |
Especifica os IDs das tabelas de rotas. Se você não especificar esse parâmetro, o ID da tabela de rotas da VPC será retornado. Esse parâmetro só está disponível quando você cria um ponto de extremidade da VPC para conectar-se a um serviço de gateway de ponto de extremidade da VPC. |
description |
String |
Especifica o campo de descrição. O valor pode conter caracteres como letras e dígitos, mas não pode conter sinais menores (<) e sinais maiores (>). |
policy_statement |
Array of PolicyStatement objects |
Esse campo é exibido no corpo da resposta apenas para habilitar gateway do ponto de extremidade da VPC com portas fixas em ambas as extremidades. |
endpoint_pool_id |
String |
Especifica o ID do pool associado ao ponto de extremidade da VPC. |
public_border_group |
String |
Especifica as informações sobre o grupo de borda pública associado ao ponto de extremidade da VPC. Esse parâmetro é retornado somente quando o ponto final é associado a um pool de bordas. |
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 deixada 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 contém 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 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_message |
String |
Mensagem de erro. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
Effect |
String |
Especifica se aceita ou rejeita as permissões ou o objeto do OBS |
Action |
Array of strings |
Especifica as permissões de acesso do OBS. |
Resource |
Array of strings |
Especifica o objeto do OBS. |
Código de status: 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 |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 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 status: 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 status: 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 status: 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 status: 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 status: 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 status: 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 status: 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 status: 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 status: 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 status: 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 status: 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 status: 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. |
Exemplos de solicitações
PUT https://{endpoint}/v1/{project_id}/vpc-endpoints/938c8167-631e-40a4-99f9-493753fbd16b/policy { "policy_statement" : [ { "Action" : [ "obs:*:*" ], "Resource" : [ "obs:*:*:*:*/*", "obs:*:*:*:*" ], "Effect" : "Allow" } ] }
Exemplo de respostas
Código de status: 200
O servidor processou a solicitação com sucesso.
{ "id" : "938c8167-631e-40a4-99f9-493753fbd16b", "status" : "accepted", "tags" : [ ], "jobId" : "endpoint_add_938c8167-631e-40a4-99f9-493753fbd16b", "marker_id" : 302035929, "active_status" : [ "active" ], "vpc_id" : "0da03835-1dcf-4361-9b87-34139d58dd59", "service_type" : "gateway", "project_id" : "0605767a3300d5762fb7c0186d9e1779", "routetables" : [ "99477d3b-87f6-49d2-8f3b-2ffc72731a38" ], "created_at" : "2022-08-03T03:03:54Z", "updated_at" : "2022-08-03T03:03:57Z", "endpoint_service_id" : "4651bc78-5cec-41b7-b448-f77326ebbed0", "endpoint_service_name" : "br-iaas-odin1.obs_test.4651bc78-5cec-41b7-b448-f77326ebbed0", "policy_statement" : [ { "Action" : [ "obs:*:*" ], "Resource" : [ "obs:*:*:*:*/*", "obs:*:*:*:*" ], "Effect" : "Allow" } ], "specification_name" : "default", "enable_status" : "enable", "description" : "", "endpoint_pool_id" : "b0ad6a4f-55c0-43f1-a26d-278639661fc2" }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
O servidor processou a solicitação com sucesso. |
400 |
O servidor falhou ao processar a solicitação. |
401 |
Nome de usuário e senha são necessários para acessar a página solicitada. |
403 |
O acesso à página solicitada é proibido. |
404 |
O servidor não conseguiu encontrar a página solicitada. |
405 |
O método especificado na solicitação não é permitido. |
406 |
A resposta gerada pelo servidor não poderia ser aceita pelo cliente. |
407 |
A autenticação de proxy é necessária antes que a solicitação seja processada. |
408 |
A solicitação expirou o tempo limite. |
409 |
A solicitação não pôde ser processada devido a um conflito. |
500 |
Falhou na solicitação. Ocorreu um erro de serviço. |
501 |
Falhou na solicitação. O servidor não suporta a função solicitada. |
502 |
Falhou na solicitação. O servidor recebeu uma resposta inválida do servidor upstream. |
503 |
Falhou na solicitação. O sistema não está disponível. |
504 |
Gateway expirou o tempo limite. |
Códigos de erro
Consulte Códigos de erro.