Modificação do nome de uma instância de proxy
Função
Essa API é usada para modificar o nome de uma instância de proxy. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/rename
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
instance_id |
Sim |
String |
ID da instância, que é compatível com o formato UUID. |
proxy_id |
Sim |
String |
ID de instância de proxy, que é compatível com o formato UUID. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
Content-Type |
Sim |
String |
Tipo de conteúdo. Valor: application/json |
X-Auth-Token |
Sim |
String |
Token do usuário. Para obter o valor, chame a API para obtenção de um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. |
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valores:
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
alias |
Sim |
String |
Novo nome da instância de proxy. |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
result |
String |
A modificação foi bem-sucedida ou falhou. |
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: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Modificação do nome de uma instância de proxy
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/4785fc80386846f3ad2bf4e0cd53a4cein07/proxy/286a4a1a45e3400c907b51b0721377f9po01/rename { "alias" : "newName" }
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "result" : "success" }
Código de status
Código de status |
Descrição |
---|---|
200 |
Bem-sucedido. |
400 |
Erro do cliente. |
500 |
Erro no servidor. |
Código de erro
Para obter detalhes, consulte Códigos de erro.