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 gateways dedicados
Atualizado em 2023-05-29 GMT+08:00
Ver PDF

Consulta de gateways dedicados

Função

Esta API é usada para consultar gateways dedicados.

URI

GET /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.
Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

offset

Não

Long

Deslocamento a partir do qual a consulta é iniciada. Se o valor estiver menor que 0, ele é automaticamente convertido para 0.

Padrão: 0

limit

Não

Integer

Número de itens exibidos em cada página. Um valor menor ou igual a 0 será automaticamente convertido em 20, e um valor maior que 500 será automaticamente convertido em 500.

Mínimo: 1

Máximo: 500

Padrão: 20

instance_id

Não

String

ID do gateway.

instance_name

Não

String

Nome do gateway.

status

Não

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

Parâmetros de solicitação

Tabela 3 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 4 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

size

Integer

Comprimento da lista de recursos retornados.

total

Long

Número de recursos que atendem às condições de consulta.

instances

Array of RespInstanceBase objects

Lista de gateways.
Tabela 5 RespInstanceBase

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: revertido 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: tempo limite de reiniciação

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

Código de status: 401

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: 403

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: 500

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.

Exemplo de solicitações

Nenhum

Exemplo de respostas

Código de status: 200

OK

{
  "total" : 2,
  "size" : 2,
  "instances" : [ {
    "cbc_metadata" : "CS2006301043A28NF:00301-734023-0--0",
    "charging_mode" : 1,
    "create_time" : 1585302825070,
    "eip_address" : "100.95.155.221",
    "enterprise_project_id" : "0",
    "id" : "eddc4d25480b4cd6b512f270a1b8b341",
    "instance_name" : "apig-Enterprise_Project_Pay-per-Use",
    "instance_status" : 6,
    "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
    "spec" : "PROFESSIONAL",
    "status" : "Running",
    "type" : "apig"
  }, {
    "charging_mode" : 0,
    "create_time" : 1594370987422,
    "eip_address" : "100.95.147.95",
    "enterprise_project_id" : "0",
    "id" : "2e2d613c64094a4a94ad38e7ca30adee",
    "instance_name" : "apig-autotest-apitest-nodelete",
    "instance_status" : 6,
    "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
    "spec" : "PROFESSIONAL",
    "status" : "Running",
    "type" : "apig",
    "is_releasable" : true
  } ]
}

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: 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

500

Erro do servidor interno

Códigos de erro

Consulte Códigos de erro.

Tópico principal: Gerenciamento de gateway