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.

Central de ajuda/ API Gateway/ Referência de API/ APIs de gateway dedicadas (V2)/ Gerenciamento de gateway/ Consulta de detalhes do gateway dedicado

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

Ver PDF

Consulta de detalhes do gateway dedicado

Função

Esta API é usada para consultar os detalhes de um gateway dedicado.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}

**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.
instance_id	Sim	String	ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG.

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.

Parâmetros de resposta

Código de status: 200

**Tabela 3** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
id	String	ID do gateway.
project_id	String	ID do locatário ao qual o gateway pertence.
instance_name	String	Nome do gateway.
status	String	Status do gateway. Creating CreateSuccess CreateFail Initing Registering Running InitingFailed RegisterFailed Installing InstallFailed Updating UpdateFailed Rollbacking RollbackSuccess RollbackFailed Deleting DeleteFailed Unregistering UnRegisterFailed CreateTimeout InitTimeout RegisterTimeout InstallTimeout UpdateTimeout RollbackTimeout DeleteTimeout UnregisterTimeout Starting Freezing Frozen Restarting RestartFail Unhealthy RestartTimeout Valores de enumeração: Creating CreateSuccess CreateFail Initing Registering Running InitingFailed RegisterFailed Installing InstallFailed Updating UpdateFailed Rollbacking RollbackSuccess RollbackFailed Deleting DeleteFailed Unregistering UnRegisterFailed CreateTimeout InitTimeout RegisterTimeout InstallTimeout UpdateTimeout RollbackTimeout DeleteTimeout UnregisterTimeout Starting Freezing Frozen Restarting RestartFail Unhealthy RestartTimeout
instance_status	Integer	ID de status do gateway. 1: criando 2: criado 3: a criação falhou 4: inicializando 5: registrando 6: em execução 7: falha na inicialização 8: falha no registro 10: instalando 11: falha na instalação 12: atualizando 13: falha na atualização 20: revertendo 21: rolado para trás 22: falha na reversão 23: excluindo 24: falha na exclusão 25: cancelando o registro 26: falha no registro 27: tempo limite de criação 28: tempo limite de inicialização 29: tempo limite de registro 30: tempo limite de instalação 31: tempo limite de atualização 32: tempo limite de reversão 33: tempo limite de exclusão 34: tempo limite de cancelamento do registro 35: iniciando 36: congelando 37: congelado 38: reiniciando 39: falha ao reiniciar 40: anormal 41: reiniciando o tempo limite Valores de enumeração: 1 2 3 4 5 6 7 8 10 11 12 13 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
type	String	Tipo de gateway. O valor padrão é apig.
spec	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
create_time	Long	Hora em que o gateway é criado. A hora está no formato carimbo de data/hora Unix.
enterprise_project_id	String	ID do projeto empresarial. Este parâmetro é necessário se você estiver usando uma conta corporativa.
eip_address	String	EIP vinculado ao gateway.
charging_mode	Integer	Modo de cobrança do gateway. 0: pagamento por uso 1: anual/mensal Valores de enumeração: 0 1
cbc_metadata	String	ID do pedido de assinatura anual/mensal.
loadbalancer_provider	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
description	String	Descrição sobre o gateway.
vpc_id	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	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	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.
maintain_begin	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 pode realizar operações de manutenção no gateway. Durante a manutenção, os serviços ainda podem ser usados, mas ocasionalmente pode haver interrupções temporárias do serviço. A manutenção programada ocorre com pouca frequência (normalmente uma vez a cada vários meses).
maintain_end	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 pode realizar operações de manutenção no gateway. Durante a manutenção, os serviços ainda podem ser usados, mas ocasionalmente pode haver interrupções temporárias do serviço. A manutenção programada ocorre com pouca frequência (normalmente uma vez a cada vários meses).
ingress_ip	String	Endereço de entrada da VPC.
ingress_ip_v6	String	Endereço de acesso da VPC (IPv6).
user_id	String	ID da conta à qual o gateway pertence.
nat_eip_ipv6_cidr	String	Endereço público de saída (IPv6). Atualmente, os endereços IPv6 são suportados apenas em determinadas regiões.
eip_ipv6_address	String	EIP (IPv6). Atualmente, os endereços IPv6 são suportados apenas em determinadas regiões.
nat_eip_address	String	Endereço IP para acesso público de saída.
bandwidth_size	Integer	Largura de banda de acesso de saída.
available_zone_ids	String	AZ.
instance_version	String	Versão de gateway.
virsubnet_id	String	ID da rede de sub-rede. Atualmente, este parâmetro não é suportado.
roma_eip_address	String	EIP ROMA. Atualmente, este parâmetro não é suportado.
listeners	Object	Informação do ouvinte. Atualmente, este parâmetro não é suportado.
supported_features	Array of strings	Funcionalidades suportadas.
endpoint_service	EndpointService object	Detalhes do serviço de ponto de extremidade de VPC. Este parâmetro será depreciado. Use endpoint_services em vez disso.
endpoint_services	Array of EndpointService objects	Serviços de ponto de extremidade de VPC
node_ips	NodeIps object	ID do ponto de extremidade da VPC.
publicips	Array of IpDetails objects	Endereços públicos de acesso de entrada.
privateips	Array of IpDetails objects	Endereços privados de acesso de entrada.
is_releasable	Boolean	Se o gateway pode ser liberado. verdadeiro: o gateway pode ser liberado. falso: o gateway não pode ser liberado.

**Tabela 4** EndpointService
Parâmetro	Tipo	Descrição
service_name	String	Nome do serviço do ponto de extremidade da VPC.
created_at	String	Tempo de criação.

**Tabela 5** NodeIps
Parâmetro	Tipo	Descrição
livedata	Array of strings	Endereços IP do nó LiveData.
shubao	Array of strings	Endereços IP do nó Shubao.

**Tabela 6** IpDetails
Parâmetro	Tipo	Descrição
ip_address	String	endereço IP.
bandwidth_size	Integer	Largura de banda.

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

Nenhum

Exemplo de respostas

Código de status: 200

{
  "id" : "8dfxxxxxxxxxxxxxxxxxxxxxxxxxx00p",
  "spec" : "BASIC",
  "project_id" : "78xxxxxxxxxxxxxxxxxxxxxxxxxxxxoi",
  "instance_name" : "apig-demo",
  "status" : "Running",
  "instance_status" : 6,
  "eip_address" : null,
  "type" : null,
  "create_time" : 1635890506328,
  "charging_mode" : 0,
  "enterprise_project_id" : "0",
  "loadbalancer_provider" : "elb",
  "description" : "test create instance",
  "instance_version" : "acc6d368a3cb4d47840380bf62b0ab32",
  "available_zone_ids" : "[xx-xxx-7a, xx-xxx-7b]",
  "user_id" : "e966ff7227ef4df49df7d57aaf00f8ed",
  "vpc_id" : "0402ea19-5457-4032-9d1b-eb48b98f6c66",
  "subnet_id" : "a3bd29e4-d5bc-414c-a79a-1f35ee4ead88",
  "virsubnet_id" : "a3bd29e4-d5bc-414c-a79a-1f35ee4ead88",
  "security_group_id" : "4b95a790-5cfc-463d-8de5-42199e55371c",
  "maintain_begin" : "22:00:00",
  "maintain_end" : "02:00:00",
  "ingress_ip" : "192.168.0.152",
  "ingress_ip_v6" : null,
  "nat_eip_address" : "100.95.159.18",
  "roma_eip_address" : null,
  "bandwidth_size" : 5,
  "nat_eip_ipv6_cidr" : null,
  "eip_ipv6_address" : null,
  "supported_features" : [ "lts", "gateway_responses", "ratelimit", "request_body_size", "backend_timeout", "app_token", "app_basic", "app_secret", "multi_auth", "route", "sign_basic", "app_route", "backend_client_certificate", "ssl_ciphers", "cors", "app_quota", "app_acl", "real_ip_from_xff", "set_resp_headers", "vpc_backup", "throttle_strategy", "watch_instance", "sign_aes", "mock_status_code_and_header", "backend_retry_count", "custom_log", "real_ip_header_getter", "policy_sys_param", "vpc_name_modifiable", "breaker", "default_group_host_trustlist" ],
  "node_ips" : {
    "livedata" : [ ],
    "shubao" : [ "192.168.0.123", "192.168.0.114" ]
  },
  "endpoint_service" : null,
  "endpoint_services" : [ {
    "service_name" : "xx-xxx-7a.apig.20bc4a91-1542-43s2-a278-b1e49c0hh6f9",
    "created_at" : "2021-8-03 06:04:43"
  } ],
  "publicips" : [ {
    "ip_address" : "100.95.156.198",
    "bandwidth_size" : 5
  } ],
  "privateips" : [ {
    "ip_address" : "100.95.156.198",
    "bandwidth_size" : 5
  } ]
}

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.7302",
  "error_msg" : "Instance 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
200	OK
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: Criação de um gateway dedicado

Próximo tópico: Atualização de um 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.