Essa API é usada para atualizar a descrição da conexão do ponto de extremidade da VPC.
Função
Função Essa API é usada para atualizar a descrição de um ponto de extremidade de VPC.
URI
PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections/description
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
Especifica o ID do locatário. Mínimo: 36 Máximo: 64 |
vpc_endpoint_service_id |
Sim |
String |
Especifica o ID do serviço do ponto de extremidade da VPC. Mínimo: 36 Máximo: 64 |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
connections |
Sim |
Array of ConnectionsDesc objects |
Especifica os campos de descrição do gerenciamento de conexão. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Sim |
String |
Especifica o ID do ponto de extremidade da VPC no formato UUID. |
description |
Sim |
String |
Especifica o campo de descrição. O valor pode conter caracteres como letras e dígitos, mas não pode conter sinais menores (<) e sinais maiores (>). |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
connections |
Array of ConnectionEndpoints objects |
Lista de conexões |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
Especifica o ID exclusivo do ponto de extremidade da VPC. |
marker_id |
Integer |
Especifica o ID do pacote do ponto de extremidade da VPC. |
created_at |
String |
Especifica o horário de criação de ponto de extremidade da VPC. O formato de hora UTC aplicado é AAAA-MMDDTHH:MM:SSZ. |
updated_at |
String |
Especifica o horário de atualização de ponto de extremidade da VPC. O formato de hora UTC aplicado é AAAA-MMDDTHH:MM:SSZ. |
domain_id |
String |
ID de domínio de um usuário. |
error |
Array of QueryError objects |
Especifica a mensagem de erro. Esse campo é retornado quando o ponto de extremidade da VPC é anormal, ou seja, o valor de status é failed. |
status |
String |
Especifica o status da conexão do ponto de extremidade da VPC. ● pendingAcceptance: a conexão do ponto de extremidade da VPC deve ser aceita. ● creating: a conexão do ponto de extremidade da VPC está sendo criada. ● accepted: a conexão do ponto de extremidade da VPC foi aceita. ● rejected: a conexão do ponto de extremidade da VPC foi rejeitada. ● failed: a conexão do ponto de extremidade da VPC falhou. ● deleting: a conexão do ponto de extremidade da VPC está sendo criada. |
description |
String |
Especifica a descrição de uma conexão do ponto de extremidade da VPC. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_message |
String |
Mensagem de erro. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 401
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 403
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 404
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 405
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 406
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 407
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 408
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 409
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 501
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 502
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 503
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de status: 504
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Exemplos de solicitações
-
https://{endpoint}/v1/{project_id}/vpc-endpoint-services/813d9300-8473-405b-bfcd-f711117bad65/connections/description { "connections" : [ { "id" : "0df78897-35b0-4a93-ad17-0bc0585f546b", "description" : "Specifies the VPC endpoint 2, which belongs to account [0605767a3300d5762fb7c0186d9e1779]iaas_commonnet_odin_26." }, { "id" : "0d837f75-90d5-4528-bd11-5d974238ebca", "description" : "Specifies the VPC endpoint 2, which belongs to account [7876999999999]iaas_commonnet_odin_26." } ] }
-
{ "endpoint_service_name" : "test222_name_23432" }
Exemplo de respostas
Código de status: 200
{ "connections" : [ { "id" : "0d837f75-90d5-4528-bd11-5d974238ebca", "status" : "accepted", "description" : "Specifies the VPC endpoint 2, which belongs to account [0605767a3300d5762fb7c0186d9e1779]iaas_commonnet_odin_26.", "marker_id" : 302008767, "domain_id" : "05b5408a0a80d2b10f06c0184a774460", "created_at" : "2022-04-14T02:09:08Z", "updated_at" : "2022-04-14T07:55:40Z" }, { "id" : "0df78897-35b0-4a93-ad17-0bc0585f546b", "status" : "accepted", "description" : "Specifies the VPC endpoint 2, which belongs to account [0605767a3300d5762fb7c0186d9e1779]iaas_commonnet_odin_26.", "marker_id" : 302001833, "domain_id" : "05b5408a0a80d2b10f06c0184a774460", "created_at" : "2022-04-14T01:59:31Z", "updated_at" : "2022-04-14T07:57:39Z" } ] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
O servidor processou a solicitação com sucesso. |
400 |
O servidor falhou ao processar a solicitação. |
401 |
Nome de usuário e senha são necessários para acessar a página solicitada. |
403 |
O acesso à página solicitada é proibido. |
404 |
O servidor não conseguiu encontrar a página solicitada. |
405 |
O método especificado na solicitação não é permitido. |
406 |
A resposta gerada pelo servidor não poderia ser aceita pelo cliente. |
407 |
A autenticação de proxy é necessária antes que a solicitação seja processada. |
408 |
A solicitação expirou o tempo limite. |
409 |
A solicitação não pôde ser processada devido a um conflito. |
500 |
Falhou na solicitação. Ocorreu um erro de serviço. |
501 |
Falhou na solicitação. O servidor não suporta a função solicitada. |
502 |
Falhou na solicitação. O servidor recebeu uma resposta inválida do servidor upstream. |
503 |
Falhou na solicitação. O sistema não está disponível. |
504 |
Gateway expirou o tempo limite. |
Códigos de erro
Consulte Códigos de erro.