Atualização de um gateway dedicado
Função
Esta API é usada para atualizar um gateway dedicado.
URI
PUT /v2/{project_id}/apigw/instances/{instance_id}
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. |
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 |
---|---|---|---|
description |
Não |
String |
Descrição do gateway. |
maintain_begin |
Não |
String |
Hora de início da janela de tempo de manutenção. Deve estar no formato "xx:00:00". O valor de xx pode ser 02, 06, 10, 14, 18 ou 22. Durante o período de manutenção, o pessoal de O&M realiza a manutenção no gateway. Durante este período, os serviços ainda podem ser usados, mas ocasionalmente pode haver interrupções temporárias. A manutenção programada ocorre com pouca frequência (normalmente uma vez a cada vários meses). |
maintain_end |
Não |
String |
Hora de término da janela de tempo de manutenção. Deve estar no formato "xx:00:00". Há uma diferença de 4 horas entre a hora de início e a hora de término. Durante o período de manutenção, o pessoal de O&M realiza a manutenção no gateway. Durante este período, os serviços ainda podem ser usados, mas ocasionalmente pode haver interrupções temporárias. A manutenção programada ocorre com pouca frequência (normalmente uma vez a cada vários meses). |
instance_name |
Não |
String |
Nome do gateway. Mínimo: 3 Máximo: 64 |
security_group_id |
Não |
String |
Grupo de segurança ao qual o gateway pertence. Você pode obtê-lo de uma das seguintes maneiras:
|
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do gateway. |
project_id |
String |
ID do locatário ao qual o gateway pertence. |
instance_name |
String |
Nome do gateway. |
status |
String |
Status do gateway.
Valores de enumeração:
|
instance_status |
Integer |
ID de status do gateway.
Valores de enumeração:
|
type |
String |
Tipo de gateway. O valor padrão é apig. |
spec |
String |
Edição de gateway.
Valores de enumeração:
|
create_time |
Long |
Hora em que o gateway é criado. A hora está no formato carimbo de data/hora Unix. |
enterprise_project_id |
String |
ID do projeto empresarial. Este parâmetro é necessário se você estiver usando uma conta corporativa. |
eip_address |
String |
EIP vinculado ao gateway. |
charging_mode |
Integer |
Modo de cobrança do gateway.
Valores de enumeração:
|
cbc_metadata |
String |
ID do pedido de assinatura anual/mensal. |
loadbalancer_provider |
String |
Tipo do balanceador de carga usado pelo gateway.
Padrão: lvs Valores de enumeração:
|
description |
String |
Descrição sobre o gateway. |
vpc_id |
String |
ID de VPC Você pode obtê-lo de uma das seguintes maneiras:
|
subnet_id |
String |
ID da rede de sub-rede. Você pode obtê-lo de uma das seguintes maneiras:
|
security_group_id |
String |
ID do grupo de segurança ao qual o gateway pertence. Você pode obtê-lo de uma das seguintes maneiras:
|
maintain_begin |
String |
Hora de início da janela de tempo de manutenção. Deve estar no formato "xx:00:00". O valor de xx pode ser 02, 06, 10, 14, 18 ou 22. Durante o período de manutenção, o pessoal de O&M pode realizar operações de manutenção no gateway. Durante a manutenção, os serviços ainda podem ser usados, mas ocasionalmente pode haver interrupções temporárias do serviço. A manutenção programada ocorre com pouca frequência (normalmente uma vez a cada vários meses). |
maintain_end |
String |
Hora de término da janela de tempo de manutenção. Deve estar no formato "xx:00:00". Há uma diferença de 4 horas entre a hora de início e a hora de término. Durante o período de manutenção, o pessoal de O&M pode realizar operações de manutenção no gateway. Durante a manutenção, os serviços ainda podem ser usados, mas ocasionalmente pode haver interrupções temporárias do serviço. A manutenção programada ocorre com pouca frequência (normalmente uma vez a cada vários meses). |
ingress_ip |
String |
Endereço de entrada da VPC. |
ingress_ip_v6 |
String |
Endereço de acesso da VPC (IPv6). |
user_id |
String |
ID da conta à qual o gateway pertence. |
nat_eip_ipv6_cidr |
String |
Endereço público de saída (IPv6). Atualmente, os endereços IPv6 são suportados apenas em determinadas regiões. |
eip_ipv6_address |
String |
EIP (IPv6). Atualmente, os endereços IPv6 são suportados apenas em determinadas regiões. |
nat_eip_address |
String |
Endereço IP para acesso público de saída. |
bandwidth_size |
Integer |
Largura de banda de acesso de saída. |
available_zone_ids |
String |
AZ. |
instance_version |
String |
Versão de gateway. |
virsubnet_id |
String |
ID da rede de sub-rede. Atualmente, este parâmetro não é suportado. |
roma_eip_address |
String |
EIP ROMA. Atualmente, este parâmetro não é suportado. |
listeners |
Object |
Informação do ouvinte. Atualmente, este parâmetro não é suportado. |
supported_features |
Array of strings |
Funcionalidades suportadas. |
endpoint_service |
EndpointService object |
Detalhes do serviço de ponto de extremidade de VPC. Este parâmetro será depreciado. Use endpoint_services em vez disso. |
endpoint_services |
Array of EndpointService objects |
Serviços de ponto de extremidade de VPC |
node_ips |
NodeIps object |
ID do ponto de extremidade da VPC. |
publicips |
Array of IpDetails objects |
Endereços públicos de acesso de entrada. |
privateips |
Array of IpDetails objects |
Endereços privados de acesso de entrada. |
is_releasable |
Boolean |
Se o gateway pode ser liberado.
|
Parâmetro |
Tipo |
Descrição |
---|---|---|
service_name |
String |
Nome do serviço do ponto de extremidade da VPC. |
created_at |
String |
Tempo de criação. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
livedata |
Array of strings |
Endereços IP do nó LiveData. |
shubao |
Array of strings |
Endereços IP do nó Shubao. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
ip_address |
String |
endereço IP. |
bandwidth_size |
Integer |
Largura de banda. |
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
{ "description" : "test create instance", "instance_name" : "apig-demo" }
Exemplo de respostas
Código de status: 200
OK
{ "available_zone_ids" : "[xx-xxx-7a, xx-xxx-7b]", "bandwidth_size" : 5, "description" : "test create instance", "eip_id" : "41f961ab-2bdd-4ca7-9b59-cfc4fcef10c9", "enterprise_project_id" : "0", "instance_name" : "apig-demo", "maintain_begin" : "22:00:00", "maintain_end" : "02:00:00", "security_group_id" : "36d0ec18-bd10-4da7-86f3-ad7a5ddc55d7", "spec_id" : "PROFESSIONAL", "subnet_id" : "a938121c-11c4-4c91-b983-bc9acd347bb5", "vpc_id" : "0957108c-257c-4ce0-9e93-527d279ce763" }
Código de status: 400
Solicitação inválida
{ "error_code" : "APIC.7211", "error_msg" : "Parameter value does not match the rules, parameter name[maintainBegin]" }
Código de status: 401
Não autorizado
{ "error_code" : "APIC.7102", "error_msg" : "Incorrect token or token resolution failed" }
Código de status: 403
Proibido
{ "error_code" : "APIC.7106", "error_msg" : "No permissions to request for the method" }
Código de status: 404
Não encontrado
{ "error_code" : "APIC.7302", "error_msg" : "Instance not found" }
Código de status: 500
Erro do servidor interno
{ "error_code" : "APIC.9000", "error_msg" : "Failed to request internal service" }
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.