Atualização de instâncias de back-end
Função
Esta API é usada para atualizar as instâncias de back-end de um canal da VPC especificado. Durante a atualização, os parâmetros de solicitação sobrescrevem as instâncias de back-end do grupo de servidores de nuvem correspondente. Se nenhum grupo de servidores de nuvem for especificado, todos os grupos de servidores de nuvem serão sobrescritos.
URI
PUT /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â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âmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| members | Não | Array of MemberInfo objects | Instâncias de back-end. |
| member_group_name | Não | String | Grupo de servidores back-end a ser modificado. Se esse parâmetro não for especificado, todos os back-ends definidos pelos membros para o canal da VPC serão modificados. Se esse parâmetro for especificado, somente as instâncias de back-end no grupo de servidores back-end definido pelos membros serão modificadas. Parâmetros de entrada de outros grupos de servidores back-end são ignorados. Por exemplo, se member_group_name=primary for passado, somente as instâncias de back-end do grupo de servidor back-end 105c6902457144a4820dff8b1ad63331 nos membros serão modificadas. |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| host | Não | String | Endereço do servidor back-end. Esse parâmetro é necessário quando o tipo de membro é endereço IP. Máximo: 64 |
| weight | Não | Integer | Peso. Quanto maior o peso, mais solicitações um serviço de back-end receberá. Mínimo: 0 Máximo: 10000 |
| is_backup | Não | 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 | Não | 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 | Não | Integer | Status do servidor back-end.
Valores de enumeração:
|
| port | Não | Integer | Porta do servidor back-end. Mínimo: 0 Máximo: 65535 |
| ecs_id | Não | 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 | Não | 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 |
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
-
Atualização de instâncias de back-end não em espera de um canal da VPC
{ "member_group_name" : "primary", "members" : [ { "host" : "192.168.2.25", "weight" : 1, "is_backup" : false, "member_group_name" : "primary" } ] } -
Atualização de todas as instâncias de back-end de um canal da VPC
{ "members" : [ { "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d", "ecs_name" : "APIGtest02", "weight" : 2 } ] }
Exemplo de respostas
Código de status: 200
OK
-
Exemplo 1
{ "total" : 1, "size" : 1, "members" : [ { "host" : "192.168.2.25", "weight" : 1, "is_backup" : false, "member_group_name" : "primary", "port" : 22, "status" : 1, "ecs_id" : "192.168.2.25", "ecs_name" : "192.168.2.25", "id" : "683b6807cad54122a6777ad047a6178e", "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59", "create_time" : "2020-07-23T09:13:24Z", "member_group_id" : "631b551cddda40478ef720163a9412ed" } ] } -
Exemplo 2
{ "total" : 1, "size" : 1, "members" : [ { "host" : "192.168.0.17", "weight" : 2, "is_backup" : false, "member_group_name" : "primary", "port" : 22, "status" : 1, "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d", "ecs_name" : "APIGtest02", "id" : "5c868f0224084710a1e188b7d3057c52", "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331", "create_time" : "2020-07-23T09:03:53Z", "member_group_id" : "631b551cddda40478ef720163a9412ed" } ] }
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.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.