Atualização de um canal da VPC
Função
Esta API é usada para atualizar os parâmetros de um canal da VPC especificado.
URI
A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.
Método de solicitação |
URI |
---|---|
PUT |
/v1.0/apigw/vpc-channels/{id} |
A tabela a seguir lista o parâmetro no URI.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Sim |
String |
ID do canal da VPC |
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
name |
Sim |
String |
Nome do canal da VPC Um nome de canal da VPC consiste em 3 a 64 caracteres, começando com uma letra. Apenas letras, números, hifens (-) e sublinhados (_) são permitidos. |
type |
Sim |
Integer |
Tipo de canal da VPC, que pode ser:
|
member_type |
Obrigatório se o type for 2 |
String |
Tipo de membro do canal da VPC, que pode ser:
Esse parâmetro é válido somente quando o tipo de canal da VPC é definido como 2. O valor padrão é instance. |
port |
Obrigatório se o type for 2 |
Integer |
Porta do host do canal da VPC Esse parâmetro é válido somente quando o tipo de canal da VPC é definido como 2. O intervalo de valores é de 1 a 65535. |
balance_strategy |
Obrigatório se o type for 2 |
Integer |
Algoritmo de distribuição, que pode ser:
Esse parâmetro é válido somente quando o tipo de canal da VPC é definido como 2. O valor padrão é 1. |
vpc_health_config |
Obrigatório se o type for 2 |
Dicionário |
Detalhes da verificação de integridade. Esse parâmetro é válido somente quando o tipo de canal da VPC é definido como 2. |
vpc_instances |
Sim |
Dicionário |
Lista de instâncias de back-end. Apenas uma instância de back-end será incluída se o tipo de canal da VPC estiver definido como 1. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
protocol |
Sim |
String |
Protocolo para executar verificações de integridade em servidores em nuvem no canal da VPC. O valor pode ser:
|
path |
Obrigatório se protocol estiver definido como http. |
String |
Caminho de destino para verificações de integridade
NOTA:
O valor deste parâmetro deve estar em conformidade com as especificações de URI. |
port |
Não |
Integer |
Porta de destino para verificações de integridade. Por padrão, a porta do host do canal da VPC é usada. Faixa: 1–65535 |
threshold_normal |
Sim |
Integer |
Limite de integridade Refere-se ao número (x) de verificações consecutivas bem-sucedidas necessárias para que um servidor em nuvem seja marcado como íntegro. Faixa: 2–10 |
threshold_abnormal |
Sim |
Integer |
Limite não íntegro Refere-se ao número (x) de verificações consecutivas com falhas necessárias para que um servidor em nuvem seja marcado como íntegro. Faixa: 2–10 |
time_out |
Sim |
Integer |
Tempo limite para determinar se uma verificação de integridade falha. Unidade: s. O valor deve ser menor que o valor de time_interval. Faixa: 2–30 |
time_interval |
Sim |
Integer |
Intervalo entre verificações consecutivas. Unidade: s. O valor deve ser maior que o valor de time_out. Faixa: 5–300 |
http_code |
Obrigatório se protocol estiver definido como http. |
String |
Códigos de resposta HTTP para determinar uma resposta HTTP bem-sucedida O valor pode ser qualquer número inteiro entre 100 e 599 em um dos seguintes formatos:
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
instance_name |
Sim |
String |
Nome da instância de back-end O nome deve conter de 1 a 64 caracteres. Somente letras, dígitos, pontos (.), hifens (-) e sublinhados (_) são permitidos. |
instance_id |
Sim |
String |
ID da instância de back-end O ID deve conter de 1 a 64 caracteres. Apenas letras, números, hifens (-) e sublinhados (_) são permitidos. |
weight |
Obrigatório se o type for 2 |
Integer |
Peso do servidor de nuvem Quanto maior o peso, mais pedidos são encaminhados para a instância de back-end. Esse parâmetro é válido somente quando o tipo de canal da VPC é definido como 2. O intervalo de valores é de 1 a 100. |
Exemplo de solicitação:
{ "balance_strategy": 1, "name": "vpc_001", "port": 15565, "type": 2, "member_type": "instance", "vpc_health_config": { "http_code": "205", "path": "/hc", "port": 15563, "protocol": "http", "threshold_abnormal": 5, "threshold_normal": 5, "time_interval": 200, "time_out": 30 }, "vpc_instances": [ { "instance_id": "instance01", "instance_name": "instance_name01", "weight": 10 } ] }
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do canal da VPC |
name |
String |
Nome do canal da VPC |
type |
Integer |
Tipo de canal da VPC, que pode ser:
|
member_type |
String |
Tipo de membro do canal da VPC, que pode ser:
Esse parâmetro é válido somente quando o tipo de canal da VPC é definido como 2. |
status |
Integer |
O status do canal da VPC, que pode ser:
|
port |
Integer |
Porta do host do canal da VPC |
balance_strategy |
Integer |
Algoritmo de distribuição, que pode ser:
|
create_time |
Timestamp |
Hora em que o canal da VPC é criado |
Exemplo de resposta:
{ "name": "vpc_001", "type": 2, "member_type": "instance", "port": 15565, "balance_strategy": 1, "id": "c3e6a7d85d9e47be89dfcc3cd37405d7", "create_time": "2018-07-27T12:30:48.027484Z", "status": 1 }
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 |