Modificação de um ambiente
Função
Esta API é usada para modificar as informações sobre um ambiente específico. Somente os atributos name e remark de um ambiente podem ser modificados.
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/envs/{id} |
A tabela a seguir lista o parâmetro no URI.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Sim |
String |
ID do ambiente, que pode ser obtido consultando as informações do ambiente |
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
name |
Sim |
String |
Nome do ambiente Um nome de ambiente consiste em 3 a 64 caracteres, começando com uma letra. Apenas letras, dígitos e sublinhados (_) são permitidos. |
remark |
Não |
String |
Descrição do ambiente A descrição não pode exceder 255 caracteres. |
Exemplo de solicitação:
{ "name": "DEVELOP", "remark": "Development environment" }
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do ambiente |
name |
String |
Nome do ambiente |
create_time |
Timestamp |
Momento em que o ambiente é criado |
remark |
String |
Descrição do ambiente |
Exemplo de resposta:
{ "id": "cca3616a-f368-4b32-9064-b2a631cb3eeb", "name": "DEVELOP", "remark": "Development environment", "create_time": "2017-12-28T12:50:47Z" }
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 |