Consulta de grupos de servidores back-end de um canal da VPC
Função
Esta API é usada para consultar grupos de servidores back-end de um canal da VPC.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/member-groups
| 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 | 
| dict_code | Não | String | Código do dicionário. O valor pode conter letras, dígitos, hifens (-), sublinhados (_) e pontos (.). Este parâmetro não é suportado atualmente. Mínimo: 3 Máximo: 64 | 
| member_group_name | Não | String | Nome do grupo de servidores back-end do canal da VPC. | 
| precise_search | Não | String | Nome do parâmetro para correspondência exata. Separe vários nomes de parâmetros com vírgulas (,). Atualmente, o member_group_name é suportado. | 
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. | 
| member_groups | Array of MemberGroupInfo objects | Grupos de servidores de back-end do canal da VPC. | 
| 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. | 
| 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 | 
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" : 1,
  "size" : 1,
  "member_groups" : [ {
    "member_group_name" : "vpc_member_group",
    "member_group_remark" : "remark",
    "member_group_weight" : 1,
    "dict_code" : "",
    "member_group_id" : "105c6902457144a4820dff8b1ad63331",
    "create_time" : "2020-07-23T07:24:33Z",
    "update_time" : "2020-07-23T07:24:33Z",
    "microservice_version" : "",
    "microservice_port" : 0,
    "microservice_labels" : [ ]
  } ]
}
  Código de status: 400
Solicitação inválida
{
  "error_code" : "APIG.2001",
  "error_msg" : "The request parameters must be specified, parameter name:members"
}
  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: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.
 
    