Modificação da verificação de integridade do canal da VPC
Função
Esta API é usada para modificar a configuração de verificação de integridade de um canal da VPC.
URI
PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/health-config
| 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 |
|---|---|---|---|
| protocol | Sim | String | Protocolo para realizar verificações de integridade em servidores de back-end no canal da VPC.
Valores de enumeração:
|
| path | Não | String | Caminho de destino para verificações de integridade. Este parâmetro é necessário se o protocolo estiver definido como http ou https. |
| method | Não | String | Método de solicitação para verificações de integridade. Padrão: GET Valores de enumeração:
|
| port | Não | Integer | Porta de destino para verificações de integridade. Se esse parâmetro não for especificado ou definido como 0, a porta do host do canal da VPC será usada. Se este parâmetro for definido como um valor diferente de zero, a porta correspondente será usada para verificações de integridade. Mínimo: 0 Máximo: 65535 |
| threshold_normal | Sim | Integer | Limite íntegro. Refere-se ao número de verificações consecutivas bem-sucedidas necessárias para que um servidor de back-end seja considerado saudável. Mínimo: 2 Máximo: 10 |
| threshold_abnormal | Sim | Integer | Limite não íntegro. Refere-se ao número de verificações consecutivas falhadas necessárias para que um servidor de back-end seja considerado insalubre. Mínimo: 2 Máximo: 10 |
| time_interval | Sim | Integer | Intervalo entre verificações consecutivas. Unidade: s. O valor deve ser maior do que o valor do tempo limite. Mínimo: 5 Máximo: 300 |
| http_code | Não | String | Códigos de resposta para determinar uma resposta HTTP bem-sucedida. O valor pode ser qualquer número inteiro entre 100 e 599 em um dos seguintes formatos:
|
| enable_client_ssl | Não | Boolean | Indica se a autenticação bidirecional deve ser ativada. Se esta função é permitida, o certificado especificado no item de configuração backend_client_certificate do gateway está usado. Padrão: false |
| status | Não | Integer | Resultado da verificação de integridade.
Valores de enumeração:
|
| timeout | 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. Mínimo: 2 Máximo: 30 |
Parâmetros de resposta
Código de status: 200
| Parâmetro | Tipo | Descrição |
|---|---|---|
| protocol | String | Protocolo para realizar verificações de integridade em servidores de back-end no canal da VPC.
Valores de enumeração:
|
| path | String | Caminho de destino para verificações de integridade. Este parâmetro é necessário se o protocolo estiver definido como http ou https. |
| method | String | Método de solicitação para verificações de integridade. Padrão: GET Valores de enumeração:
|
| port | Integer | Porta de destino para verificações de integridade. Se esse parâmetro não for especificado ou definido como 0, a porta do host do canal da VPC será usada. Se este parâmetro for definido como um valor diferente de zero, a porta correspondente será usada para verificações de integridade. Mínimo: 0 Máximo: 65535 |
| threshold_normal | Integer | Limite íntegro. Refere-se ao número de verificações consecutivas bem-sucedidas necessárias para que um servidor back-end seja considerado íntegro. Mínimo: 2 Máximo: 10 |
| threshold_abnormal | Integer | Limite não íntegro. Refere-se ao número de verificações consecutivas falhadas necessárias para que um servidor back-end seja considerado não íntegro. Mínimo: 2 Máximo: 10 |
| time_interval | Integer | Intervalo entre verificações consecutivas. Unidade: s. O valor deve ser maior do que o valor do tempo limite. Mínimo: 5 Máximo: 300 |
| http_code | String | Códigos de resposta para determinar uma resposta HTTP bem-sucedida. O valor pode ser qualquer número inteiro entre 100 e 599 em um dos seguintes formatos:
|
| enable_client_ssl | Boolean | Indica se a autenticação bidirecional deve ser ativada. Se esta função é permitida, o certificado especificado no item de configuração backend_client_certificate do gateway está usado. Padrão: false |
| status | Integer | Resultado da verificação de integridade.
Valores de enumeração:
|
| timeout | 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. Mínimo: 2 Máximo: 30 |
| vpc_channel_id | String | ID do canal da VPC. |
| id | String | ID de verificação de integridade. |
| create_time | String | Tempo de criação. |
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
{
"http_code" : "200",
"path" : "/vpc/demo",
"port" : 22,
"protocol" : "http",
"threshold_abnormal" : 5,
"threshold_normal" : 2,
"time_interval" : 10,
"timeout" : 5,
"enable_client_ssl" : false
} Exemplo de respostas
Código de status: 200
OK
{
"protocol" : "http",
"path" : "/vpc/demo",
"method" : "GET",
"port" : 22,
"threshold_abnormal" : 5,
"threshold_normal" : 2,
"time_interval" : 10,
"http_code" : "200",
"enable_client_ssl" : false,
"status" : 1,
"timeout" : 5,
"id" : "3b3d02026c5f402d85e8645ea95b0816",
"vpc_channel_id" : "d38c55c926ca44c2bfb37886d93b9a0d",
"create_time" : "2020-07-23T07:11:57Z"
} 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.