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 canais da VPC/ Consulta de canais da VPC

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

Ver PDF

Consulta de canais da VPC

Função

Esta API é usada para consultar os canais da VPC em um gateway.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels

**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.

**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
id	Não	String	ID do canal da VPC.
name	Não	String	Nome do canal da VPC.
dict_code	Não	String	Código do dicionário do canal da VPC. O valor pode conter letras, dígitos, hifens (-), sublinhados (_) e pontos (.). Este parâmetro não é suportado atualmente. Mínimo: 3 Máximo: 64
precise_search	Não	String	Nome do parâmetro para correspondência exata. Separe vários nomes de parâmetros com vírgulas (,). Atualmente, name e member_group_name são suportados.
member_host	Não	String	Endereço do serviço de back-end. Por padrão, a correspondência exata é usada. A correspondência difusa não é suportada.
member_port	Não	Integer	Porta do servidor back-end. Mínimo: 0 Máximo: 65535
member_group_name	Não	String	Nome do grupo de servidores de back-end.
member_group_id	Não	String	ID do grupo de servidores back-end

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.
vpc_channels	Array of VpcChannelInfo objects	Lista de canais da VPC.

**Tabela 5** VpcChannelInfo
Parâmetro	Tipo	Descrição
name	String	Nome do canal da VPC. Pode conter de 3 a 64 caracteres, começando com uma letra. Apenas letras, números, hifens (-) e sublinhados (_) são permitidos.
port	Integer	Porta do host do canal da VPC. Faixa: 1–65535.
balance_strategy	Integer	Algoritmo de distribuição. 1: round robin ponderado (WRR). 2: conexões mínimas ponderadas (WLC). 3: hashing de origem. 4: hashing de URI. Padrão: 1 Valores de enumeração: 1 2 3 4
member_type	String	Tipo de membro do canal da VPC. ip ecs Padrão: ecs Valores de enumeração: ip ecs
type	Integer	Tipo de canal da VPC. O tipo padrão é servidor. 2: tipo de servidores. 3: tipo de microsserviço. Padrão: 2 Valores de enumeração: 2 3
dict_code	String	Código do dicionário do canal da VPC. O valor pode conter letras, dígitos, hifens (-), sublinhados (_) e pontos (.). Este parâmetro não é suportado atualmente. Mínimo: 3 Máximo: 64
create_time	String	Hora em que o canal da VPC é criado.
id	String	ID do canal da VPC.
status	Integer	Status do canal da VPC. 1: normal 2: anormal Valores de enumeração: 1 2
member_groups	Array of MemberGroupInfo objects	Grupos de servidores back-end.
microservice_info	MicroServiceInfo object	Informações de microsserviços.

**Tabela 6** MemberGroupInfo
Parâmetro	Tipo	Descrição
member_group_name	String	Nome do grupo de servidores de back-end do canal da VPC.
member_group_remark	String	Descrição do grupo de servidores de back-end.
member_group_weight	Integer	Peso do grupo de servidores de back-end. Se o grupo de servidores contiver servidores e um peso tiver sido definido para ele, o peso será usado automaticamente para atribuir pesos aos servidores desse grupo. Mínimo: 0 Máximo: 100
dict_code	String	Código de dicionário do grupo de servidores back-end. O valor pode conter letras, dígitos, hifens (-), sublinhados (_) e pontos (.). Atualmente, este parâmetro não é suportado. Mínimo: 3 Máximo: 64
microservice_version	String	Versão do grupo de servidores back-end. Esse parâmetro é compatível somente quando o tipo de canal da VPC é microsserviço. Máximo: 64
microservice_port	Integer	Porta do grupo de servidores back-end. Esse parâmetro é compatível somente quando o tipo de canal da VPC é microsserviço. Se o número da porta for 0, todos os endereços no grupo de servidores back-end usarão a porta de balanceamento de carga original para herdar a lógica. Mínimo: 0 Máximo: 65535
microservice_labels	Array of MicroserviceLabel objects	Tags do grupo de servidores back-end. Esse parâmetro é compatível somente quando o tipo de canal da VPC é microsserviço.
member_group_id	String	ID do grupo de servidores back-end do canal da VPC.
create_time	String	Hora em que o grupo de servidores back-end é criado.
update_time	String	Hora em que o grupo de servidores back-end é atualizado.

**Tabela 7** MicroserviceLabel
Parâmetro	Tipo	Descrição
label_name	String	Nome da tag. Comece e termine com uma letra ou dígito. Use apenas letras, dígitos, hifens (-), sublinhados (_) e pontos (.). (Máximo de 63 caracteres.) Mínimo: 1 Máximo: 63
label_value	String	Valor da tag. Comece e termine com uma letra ou dígito. Use apenas letras, dígitos, hifens (-), sublinhados (_) e pontos (.). (Máximo de 63 caracteres.) Mínimo: 1 Máximo: 63

**Tabela 8** MicroServiceInfo
Parâmetro	Tipo	Descrição
id	String	ID do microsserviço.
service_type	String	Tipo de microsserviço. CSE: centro de registro de microsserviços CSE. CCE: Cloud Container Engine (CCE). Valores de enumeração: CSE CCE
cse_info	MicroServiceInfoCSE object	Detalhes do microsserviço CSE.
cce_info	MicroServiceInfoCCE object	Detalhes do microsserviço CCE.
update_time	String	Tempo de atualização do microsserviço.
create_time	String	Tempo de criação de microsserviços.

**Tabela 9** MicroServiceInfoCSE
Parâmetro	Tipo	Descrição
engine_id	String	ID do mecanismo de microsserviço. Máximo: 64
service_id	String	ID do microsserviço. Máximo: 64
engine_name	String	Nome do mecanismo de microsserviço.
service_name	String	Nome do microsserviço.
register_address	String	Endereço do centro de registro.
cse_app_id	String	Aplicação ao qual o microsserviço pertence.
version	String	Versão do microsserviço, que foi descartada e é refletida na versão do grupo de servidores back-end. Máximo: 64

**Tabela 10** MicroServiceInfoCCE
Parâmetro	Tipo	Descrição
cluster_id	String	ID do cluster de CCE. Máximo: 64
namespace	String	Namespace. Máximo: 64
workload_type	String	Tipo de carga de trabalho. deployment statefulset daemonset Valores de enumeração: deployment statefulset daemonset
app_name	String	Nome de aplicação. Máximo: 64
cluster_name	String	Nome do cluster de CCE.

Código de status: 400

**Tabela 11** 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 12** 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 13** 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 14** 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 15** 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

{
  "total" : 2,
  "size" : 2,
  "vpc_channels" : [ {
    "name" : "channel 1",
    "port" : 8080,
    "balance_strategy" : 1,
    "member_type" : "ip",
    "dict_code" : "",
    "create_time" : "2020-07-23T07:24:33Z",
    "id" : "105c6902457144a4820dff8b1ad63331",
    "status" : 1,
    "member_groups" : [ ],
    "type" : 2,
    "microservice_info" : {
      "id" : "",
      "project_id" : "",
      "instance_id" : "",
      "service_type" : "",
      "cse_info" : {
        "cse_app_id" : "",
        "engine_id" : "",
        "engine_name" : "",
        "register_address" : "",
        "service_id" : "",
        "service_name" : ""
      },
      "cce_info" : {
        "cluster_id" : "",
        "cluster_name" : "",
        "namespace" : "",
        "workload_type" : "",
        "app_name" : ""
      },
      "create_time" : "",
      "update_time" : ""
    }
  }, {
    "name" : "channel 2",
    "port" : 8088,
    "balance_strategy" : 2,
    "member_type" : "ip",
    "dict_code" : "",
    "create_time" : "2020-07-23T07:11:57Z",
    "id" : "56a7d7358e1b42459c9d730d65b14e59",
    "status" : 1,
    "member_groups" : [ ],
    "type" : 3,
    "microservice_info" : {
      "id" : "9483afa235be45158a70c19ab817ac65",
      "project_id" : "73d69ae0cfcf460190522d06b60f05ad",
      "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e",
      "service_type" : "CCE",
      "cse_info" : {
        "cse_app_id" : "",
        "engine_id" : "",
        "engine_name" : "",
        "register_address" : "",
        "service_id" : "",
        "service_name" : ""
      },
      "cce_info" : {
        "cluster_id" : "ab1485b4f91b45abbcd560be591f7309",
        "cluster_name" : "cce-test",
        "namespace" : "default",
        "workload_type" : "deployment",
        "app_name" : "testapp"
      },
      "create_time" : "2020-07-23T07:11:57.244829604Z",
      "update_time" : "2020-07-23T07:11:57.244829604Z"
    }
  } ]
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2011",
  "error_msg" : "The request parameters must be specified,parameterName:name. Please refer to the support documentation"
}

Código de status: 401

Não autorizado

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de status: 403

Proibido

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de status: 404

Não encontrado

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:eddc4d25480b4cd6b512f270a1b8b341"
}

Código de status: 500

Erro do servidor interno

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de status

Código de status	Descrição
200	OK
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 canais da VPC

Tópico anterior: Consulta de detalhes do canal da VPC

Próximo tópico: Adição ou atualização de instâncias de back-end

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.