Criação de um ponto de extremidade da VPC
Função
Função Essa API é usada para criar um ponto de extremidade da VPC para acessar um serviço do ponto de extremidade da VPC.
URI
POST /v1/{project_id}/vpc-endpoints
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID de projeto. 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 |
---|---|---|---|
subnet_id |
Não |
String |
Observação: esse parâmetro é obrigatório para criar um ponto de extremidade da VPC de interface. O ID deve ser o ID da sub-rede criada na VPC especificado pelo vpc_id e no formato UUID. Para obter detalhes, consulte o campo id nas informações de resposta da seção "Consulta de detalhes da sub-rede" na Referência de API da Virtual Private Cloud. Esse parâmetro é obrigatório quando você cria um ponto de extremidade da VPC para conectar-se a um serviço de interface do ponto de extremidade da VPC. Observação: ● O bloco CIDR de sub-rede da VPC não pode se sobrepor a 198.19.128.0/17. ● O endereço de destino da rota personalizada na tabela de rotas da VPC não pode se sobrepor a 198.19.128.0/17. Mínimo: 1 Máximo: 64 |
endpoint_service_id |
Sim |
String |
Especifica o ID do serviço do ponto de extremidade da VPC. Você pode obter o ID do serviço do ponto de extremidade da VPC a ser conectado consultando a seção "Visão geral de serviço do VPCEP". Mínimo: 1 Máximo: 64 |
vpc_id |
Sim |
String |
Especifica o ID da VPC onde o ponto de extremidade da VPC é localizado. Para obter detalhes, consulte o campo id nas informações de resposta da seção "Consulta de detalhes da VPC" na Referência de API do Elastic Cloud Server. Mínimo: 1 Máximo: 64 |
enable_dns |
Não |
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. O valor padrão é false. 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. Padrão: false |
tags |
Não |
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. |
routetables |
Não |
Array of strings |
Especifica os IDs das tabelas de rotas. Para obter detalhes, consulte o campo id nas informações de resposta da seção "Consulta de uma rota da VPC" na Referência de API da Virtual Private Cloud. Esse parâmetro é obrigatório quando você cria um ponto de extremidade da VPC para conectar-se a um serviço de gateway do ponto de extremidade da VPC. Observação: se esse parâmetro não estiver configurado, use a tabela de rotas padrão. |
port_ip |
Não |
String |
Especifica o endereço IP para acessar o serviço do ponto de extremidade da VPC associado. Você pode especificar endereços IP para acessar o serviço do ponto de extremidade da VPC associado ao criar um ponto de extremidade da VPC. Apenas endereços IPv4 são suportados. Esse parâmetro é obrigatório quando você cria um ponto de extremidade da VPC para conectar-se a um serviço de interface do ponto de extremidade da VPC. Mínimo: 1 Máximo: 128 |
whitelist |
Não |
Array of strings |
Especifica as listas brancas adicionadas para controlar o acesso ao ponto de extremidade da VPC. Os endereços IPv4 ou blocos CIDR podem ser especificados para controlar o acesso ao criar um ponto de extremidade da VPC. A lista branca é deixada em branco por padrão. 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. |
enable_whitelist |
Não |
Boolean |
Especifica se o controle de acesso está habilitado. |
description |
Não |
String |
Especifica a descrição de um ponto de extremidade da VPC O valor pode conter caracteres como letras e dígitos, mas não pode conter sinais menores (<) e maiores (>). |
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
key |
Não |
String |
Especifica a chave de tag. A 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 |
Não |
String |
Especifica a chave de tag. O 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 |
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 da VPC desse tipo são configurados pelo pessoal de O&M. Você pode usá-los diretamente sem criá-los por si mesmos. ● interface: serviços de nuvem configurados pelo pessoal de O&M e serviços privados criados por você estão incluídos. Você não pode configurar esses serviços em 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: 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. ● ativo: 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 |
Lista de tag. Se nenhuma tag for correspondida, uma matriz vazia é retornada. |
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 do 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 está disponível quando você cria um ponto de extremidade da VPC para conectar-se a um serviço de gateway do ponto de extremidade da VPC. |
specification_name |
String |
Especifica o nome da especificação. |
description |
String |
Especifica a descrição de um ponto de extremidade da VPC. |
policy_statement |
Array of strings |
Esse campo é exibido no corpo da resposta apenas para habilitar o gateway do ponto de extremidade da VPC com portas fixas em ambas as extremidades. |
enable_status |
String |
Especifica se o ponto de extremidade da VPC está desativado. The value can be enable or disable. |
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. O 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 |
code |
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
POST https://{endpoint}/v1/{project_id}/vpc-endpoints { "subnet_id" : "5d1c1d71-2613-4274-b34e-d82af550f967", "vpc_id" : "4e65f8b1-306d-4522-8ecd-aa374000e2a4", "endpoint_service_id" : "813d9300-8473-405b-bfcd-f711117bad65", "enable_dns" : "false" }
Exemplo de respostas
Código de estado: 200
O servidor processou a solicitação com sucesso.
{ "id" : "492c776f-2cb9-40a2-9735-d7279ab2bbb6", "status" : "accepted", "ip" : "172.16.0.154", "tags" : [ ], "whitelist" : [ ], "marker_id" : 302010104, "active_status" : [ "active" ], "vpc_id" : "0da03835-1dcf-4361-9b87-34139d58dd59", "service_type" : "interface", "project_id" : "0605767a3300d5762fb7c0186d9e1779", "subnet_id" : "fb1b8b7e-f34c-4ff1-b3a7-221acef3b3aa", "enable_dns" : false, "created_at" : "2022-04-28T02:44:50Z", "updated_at" : "2022-04-28T02:56:15Z", "endpoint_service_id" : "8843fac2-bc01-445a-a822-c8124ff3968c", "endpoint_service_name" : "br-iaas-odin1.vm_test.8843fac2-bc01-445a-a822-c8124ff3968c", "enable_whitelist" : false, "specification_name" : "default", "enable_status" : "enable" }
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.