Modificación de una aplicación
Función
Esta API se utiliza para modificar la información sobre una aplicación específica. Los siguientes parámetros pueden ser modificados: name y remark. Si la función de personalización de claves y secretos está habilitada, también se pueden modificar app_key y app_secret. No se pueden modificar otros parámetros.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
| Método de solicitud | URI |
|---|---|
| PUT | /v1.0/apigw/apps/{id} |
En la siguiente tabla se muestra el parámetro en el URI.
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| id | Sí | String | ID de la aplicación, que se puede obtener consultando la lista de aplicaciones |
Solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| name | Sí | String | Nombre de la aplicación El nombre de una aplicación consta de 3 a 64 caracteres, comenzando con una letra. Solo se permiten letras, dígitos y guiones bajos (_). |
| remark | No | String | Descripción de la aplicación La descripción no puede superar los 255 caracteres. |
| app_key | No | String | AppKey Un AppKey consta de 8 a 64 caracteres, comenzando con una letra o un dígito. Solo se permiten letras, dígitos, guiones bajos (_) y guiones (-). NOTA: Este parámetro está disponible en algunas regiones. |
| app_secret | No | String | AppSecret Un AppSecret consta de 8 a 64 caracteres, comenzando con una letra o un dígito. Solo se permiten letras, dígitos y los siguientes caracteres especiales: _-!@#$% NOTA: Este parámetro está disponible en algunas regiones. |
Ejemplo de solicitud:
{
"name": "app_001",
"remark": "First app",
"app_key": "app_key_sample",
"app_secret": "app_secret_sample"
} Respuesta
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de la aplicación |
| name | String | Nombre de la aplicación |
| status | Integer | Estado de la aplicación |
| app_key | String | AppKey |
| app_secret | String | AppSecret |
| creator | String | Creador de aplicaciones, que puede ser:
|
| register_time | Timestamp | Tiempo de creación |
| remark | String | Descripción de la aplicación |
| update_time | Timestamp | Hora en la que se actualizó la aplicación por última vez |
| app_type | String | Tipo de aplicación. El valor predeterminado es apig. |
Ejemplo de respuesta:
{
"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 estado
| Código de estado | Descripción |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server Internal Error |
