Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Nesta página

Mostrar todos

Central de ajuda/ API Gateway/ Referência de API/ APIs de gateway dedicadas (V2)/ Gerenciamento de gateway/ Criação de um gateway dedicado

Criação de um gateway dedicado

Atualizado em 2023-05-29 GMT+08:00

Ver PDF

Função

Esta API é usada para criar um gateway dedicado.

URI

POST /v2/{project_id}/apigw/instances

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	String	ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento.

Parâmetros de solicitação

**Tabela 2** Parâmetros do cabeçalho de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
X-Auth-Token	Sim	String	Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token.

**Tabela 3** Parâmetros de corpo de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
description	Não	String	Descrição do gateway.
maintain_begin	Não	String	Hora de início da janela de tempo de manutenção. Deve estar no formato "xx:00:00". O valor de xx pode ser 02, 06, 10, 14, 18 ou 22. Durante o período de manutenção, o pessoal de O&M realiza a manutenção no gateway. Durante este período, os serviços ainda podem ser usados, mas ocasionalmente pode haver interrupções temporárias. A manutenção programada ocorre com pouca frequência (normalmente uma vez a cada vários meses).
maintain_end	Não	String	Hora de término da janela de tempo de manutenção. Deve estar no formato "xx:00:00". Há uma diferença de 4 horas entre a hora de início e a hora de término. Durante o período de manutenção, o pessoal de O&M realiza a manutenção no gateway. Durante este período, os serviços ainda podem ser usados, mas ocasionalmente pode haver interrupções temporárias. A manutenção programada ocorre com pouca frequência (normalmente uma vez a cada vários meses).
instance_name	Sim	String	Nome do gateway. Mínimo: 3 Máximo: 64
instance_id	Não	String	ID do gateway, que será gerado automaticamente se você não especificar esse parâmetro.
spec_id	Sim	String	Edição de gateway. BASIC PROFESSIONAL ENTERPRISE PLATINUM BASIC_IPV6 PROFESSIONAL_IPV6 ENTERPRISE_IPV6 PLATINUM_IPV6 Valores de enumeração: BASIC PROFESSIONAL ENTERPRISE PLATINUM BASIC_IPV6 PROFESSIONAL_IPV6 ENTERPRISE_IPV6 PLATINUM_IPV6
vpc_id	Sim	String	ID de VPC Você pode obtê-lo de uma das seguintes maneiras: Método 1: faça logon no console da VPC e clique no nome de uma VPC para exibir o ID da VPC na página de detalhes exibida. Método 2: chame a API da VPC correspondente. Para obter detalhes, consulte a seção "Consulta de VPCs" na Referência de API da VPC.
subnet_id	Sim	String	ID da rede de sub-rede. Você pode obtê-lo de uma das seguintes maneiras: Método 1: faça logon no console da VPC e clique na sub-rede de destino na página Sub-redes. Você pode visualizar o ID da rede na página exibida. Método 2: chame a API da VPC correspondente. Para obter detalhes, consulte a seção "Consulta de sub-redes" na Referência de API da VPC.
security_group_id	Sim	String	ID do grupo de segurança ao qual o gateway pertence. Você pode obtê-lo de uma das seguintes maneiras: Método 1: faça logon no console da VPC. Escolha Controle de acesso > Grupos de segurança no painel de navegação. Na página Grupos de segurança, clique no grupo de segurança de destino. Em seguida, exiba o ID do grupo de segurança na página exibida. Método 2: chame a API da VPC correspondente. Para obter detalhes, consulte a seção "Consulta de grupos de segurança" na Referência de API da VPC.
eip_id	Não	String	ID do EIP. Este parâmetro é necessário se o acesso público estiver habilitado para o gateway. Depois de vincular um EIP ao gateway, os usuários podem acessar APIs no gateway a partir de redes públicas usando o EIP. Para obter um ID de EIP, faça logon no console da VPC e escolha Elastic IP e Largura de banda > EIPs no painel de navegação. Clique no nome do EIP de destino e visualize o ID do EIP na página exibida.
enterprise_project_id	Não	String	ID do projeto empresarial. Este parâmetro é necessário se você estiver usando uma conta corporativa. Você pode obtê-lo de uma das seguintes maneiras: Método 1: faça logon na página Gerenciamento de projetos corporativos, clique no nome do projeto corporativo de destino e exiba o ID do projeto na página exibida. Método 2: chame a API de gerenciamento de projetos correspondente. Para obter detalhes, consulte a seção "Consulta da lista de projetos corporativos" na Referência de API do Enterprise Management.
available_zone_ids	Sim	Array of strings	AZs. Uma AZ é uma região física onde os recursos usam fontes de alimentação e redes independentes. As AZs são fisicamente isoladas, mas interconectadas por meio de uma rede interna. Para aumentar a disponibilidade da aplicação, crie gateways em diferentes AZs. Para obter informações de AZ, chame a API usada para consultar AZs.
bandwidth_size	Não	Integer	Largura de banda de acesso de saída. Esse parâmetro é necessário se o acesso de saída público estiver habilitado para o gateway. Depois de configurar a largura de banda para o gateway, os usuários podem acessar recursos em redes públicas. Padrão: 5
ipv6_enable	Não	Boolean	Indica se o acesso público com um endereço IPv6 é suportado. Atualmente, os endereços IPv6 são suportados apenas em determinadas regiões.
loadbalancer_provider	Não	String	Tipo do balanceador de carga usado pelo gateway. LVS ELB (disponível apenas em determinadas regiões) Padrão: lvs Valores de enumeração: lvs elb
tags	Não	Array of TmsKeyValue objects	Tags. Um máximo de 20 tags podem ser criadas para um gateway.

**Tabela 4** TmsKeyValue
Parâmetro	Obrigatório	Tipo	Descrição
key	Não	String	Chave. Inclua letras UTF-8, dígitos, espaços ou caracteres especiais (_.:=+-@). Não comece com _sys_ porque é um rótulo do sistema. Mínimo: 1 Máximo: 128
value	Não	String	Valor. Você pode inserir letras, dígitos e espaços ou outros caracteres especiais (_.:/=+-@) no formato UTF-8. Mínimo: 0 Máximo: 255

Parâmetros de resposta

Código de status: 202

**Tabela 5** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
instance_id	String	ID do gateway.
message	String	Informações sobre a tarefa de criação de gateway.
job_id	String	ID da tarefa.

Código de status: 400

**Tabela 6** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 401

**Tabela 7** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 403

**Tabela 8** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 404

**Tabela 9** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Código de status: 500

**Tabela 10** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
error_code	String	Código de erro.
error_msg	String	Mensagem de erro.

Exemplo de solicitações

{
  "available_zone_ids" : [ "xx-xxx-7b", "xx-xxx-7a" ],
  "bandwidth_size" : 5,
  "description" : "test create instance",
  "eip_id" : "41f961ab-2bdd-4ca7-9b59-cfc4fcef10c9",
  "enterprise_project_id" : "0",
  "instance_name" : "apig-demo",
  "maintain_begin" : "22:00:00",
  "maintain_end" : "02:00:00",
  "security_group_id" : "36d0ec18-bd10-4da7-86f3-ad7a5ddc55d7",
  "spec_id" : "PROFESSIONAL",
  "subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5",
  "vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763"
}

Exemplo de respostas

Código de status: 202

Aceito

{
  "instance_id" : "6a7d71827fd54572b1f31aa9548fcc81",
  "message" : "JOB_ASSIGNED_FOR_PROVISIONING_0003I:The job JOB-bdb370eb6f4c4c73b61b95a9da38beb5 has been assigned to the instance 6a7d71827fd54572b1f31aa9548fcc81 for running provisioning.",
  "job_id" : "JOB-edbac2355fb7433e98f173ea2e452e2d"
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIC.7211",
  "error_msg" : "Parameter value does not match the rules, parameter name[maintainBegin]"
}

Código de status: 401

Não autorizado

{
  "error_code" : "APIC.7102",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de status: 403

Proibido

{
  "error_code" : "APIC.7106",
  "error_msg" : "No permissions to request for the method"
}

Código de status: 404

Não encontrado

{
  "error_code" : "APIC.7301",
  "error_msg" : "Instance spec not found"
}

Código de status: 500

Erro do servidor interno

{
  "error_code" : "APIC.9000",
  "error_msg" : "Failed to request internal service"
}

Códigos de status

Código de status	Descrição
202	Aceito
400	Solicitação inválida
401	Não autorizado
403	Proibido
404	Não encontrado
500	Erro do servidor interno

Códigos de erro

Consulte Códigos de erro.

Tópico principal: Gerenciamento de gateway

Tópico anterior: Gerenciamento de gateway

Próximo tópico: Consulta de detalhes do gateway dedicado

Feedback

Esta página foi útil?

Sim Não

Deixar um comentário

Obrigado por seus comentários. Estamos trabalhando para melhorar a documentação.

O sistema está ocupado. Tente novamente mais tarde.

Quais dos seguintes problemas você encontrou?

O conteúdo é inconsistente com a UI do produto

Descrições pouco claras

Falta de exemplos ou código

Passos incorretos

Não encontro o que preciso

Falta de melhores práticas

Feedback (opcional)

0/500

Selecione pelo menos um tipo de problema e insira seus comentários ou sugestões.

Insira um máximo de 500 caracteres.

Enviar Cancelar