Modificação de uma aplicação
Função
Esta API é usada para modificar as informações sobre uma aplicação especificada. Os seguintes parâmetros podem ser modificados: name e remark. Se a função de personalizar chaves e segredos estiver habilitada, app_key e app_secret também podem ser modificados. Outros parâmetros não 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/apps/{id} |
A tabela a seguir lista o parâmetro no URI.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Sim |
String |
ID de aplicação, que pode ser obtido consultando a lista de aplicações |
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
name |
Sim |
String |
Nome de aplicação Um nome de aplicação 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 da aplicação A descrição não pode exceder 255 caracteres. |
app_key |
Não |
String |
AppKey Um AppKey é composto de 8 a 64 caracteres, começando com uma letra ou dígito. Apenas letras, dígitos, sublinhados (_) e hifens (-) são permitidos.
NOTA:
Este parâmetro está disponível em algumas regiões. |
app_secret |
Não |
String |
AppSecret Um AppSecret é composto de 8 a 64 caracteres, começando com uma letra ou dígito. Somente letras, dígitos e os seguintes caracteres especiais são permitidos: _-!@#$%
NOTA:
Este parâmetro está disponível em algumas regiões. |
Exemplo de solicitação:
{ "name": "app_001", "remark": "First app", "app_key": "app_key_sample", "app_secret": "app_secret_sample" }
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID de aplicação |
name |
String |
Nome de aplicação |
status |
Integer |
Status de aplicação |
app_key |
String |
AppKey |
app_secret |
String |
AppSecret |
creator |
String |
Criador de aplicações, que pode ser:
|
register_time |
Timestamp |
Hora em que a aplicação é registrada |
remark |
String |
Descrição da aplicação |
update_time |
Timestamp |
Hora em que a aplicação foi atualizada pela última vez |
app_type |
String |
Tipo de aplicação. O valor padrão é apig. |
Exemplo de resposta:
{ "id": "14b399ac-967f-4115-bb62-c0346b4537e9", "name": "app_001", "status": 1, "app_key": "d49b1cbf-cc81-4a5f-b2a0-61b568e376eb", "app_secret": "******", "creator": "USER", "remark": "First app", "register_time": "2017-12-28T12:26:54Z", "update_time": "2017-12-28T12:28:07.2966182Z", "app_type": "apig" }
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 |