Consulta de servidores de back-end de um canal da VPC
Função
Esta API é usada para consultar as instâncias de back-end de um canal da VPC especificado.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members
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. |
vpc_channel_id |
Sim |
String |
ID do canal da VPC. |
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 |
name |
Não |
String |
Nome do servidor em nuvem. |
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 |
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. |
Parâmetros 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
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. |
members |
Array of VpcMemberInfo objects |
Lista de servidores de nuvem. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
host |
String |
Endereço do servidor back-end. Esse parâmetro é necessário quando o tipo de membro é endereço IP. Máximo: 64 |
weight |
Integer |
Peso. Quanto maior o peso, mais solicitações um serviço de back-end receberá. Mínimo: 0 Máximo: 10000 |
is_backup |
Boolean |
Indica se o serviço de back-end é um nó em espera. Depois de ativar esta função, o serviço de back-end funciona como um nó em espera. Funciona somente quando todos os nós não em espera estão com defeito. Esta função é suportada somente quando seu gateway foi atualizado para a versão correspondente. Se o gateway não suportar essa função, entre em contato com o suporte técnico. Padrão: false |
member_group_name |
String |
Nome do grupo de servidores de back-end. O grupo de servidores facilita a modificação do endereço de serviço de back-end. |
status |
Integer |
Status do servidor back-end.
Valores de enumeração:
|
port |
Integer |
Porta do servidor back-end. Mínimo: 0 Máximo: 65535 |
ecs_id |
String |
ID do servidor back-end Esse parâmetro é necessário se o tipo de instância de back-end for ecs. O valor pode conter de 1 a 64 caracteres, incluindo letras, dígitos, hifens (-) e sublinhados (_). Máximo: 255 |
ecs_name |
String |
Nome do servidor back-end. Esse parâmetro é necessário se o tipo de instância de back-end for ecs. O valor pode conter de 1 a 64 caracteres, incluindo letras, dígitos, hifens (-), sublinhados (_) e pontos (.). Máximo: 64 |
id |
String |
ID do servidor back-end |
vpc_channel_id |
String |
ID do canal da VPC. |
create_time |
String |
Hora em que o servidor de back-end é adicionado ao canal da VPC. |
member_group_id |
String |
ID do grupo de servidores back-end |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 401
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 403
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 404
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
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, "members" : [ { "host" : "192.168.0.5", "weight" : 1, "is_backup" : false, "member_group_name" : "", "status" : 1, "port" : 22, "ecs_id" : "192.168.0.5", "ecs_name" : "192.168.0.5", "id" : "be63c6260a1043888187f84af39c9f0e", "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59", "create_time" : "2020-07-23T07:11:57Z", "member_group_id" : "" }, { "host" : "192.168.1.124", "weight" : 2, "is_backup" : false, "member_group_name" : "", "status" : 1, "port" : 22, "ecs_id" : "192.168.1.124", "ecs_name" : "192.168.1.124", "id" : "a57b13f1b89b417ca8acd76909e6df67", "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59", "create_time" : "2020-07-23T07:11:57Z", "member_group_id" : "" } ] }
Código de status: 400
Solicitação inválida
{ "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,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.3023", "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59" }
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.