Modificación de una aplicación
Función
Esta API se utiliza para modificar la información sobre una aplicación. Solo se pueden modificar los parámetros name y remark. Si la función de personalizar claves y secretos está habilitada, app_key y app_secret también pueden modificarse.
Método de invocación
Para obtener más información, véase invocación de API.
URI
PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto. |
|
instance_id |
Sí |
String |
ID de gateway, que se puede obtener de la información de gateway en la consola de APIG. |
|
app_id |
Sí |
String |
ID de la aplicación. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
name |
Sí |
String |
Nombre de la aplicación. Puede contener 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. No puede exceder los 255 caracteres. |
|
app_key |
No |
String |
AppKey que puede contener de 8 a 200 caracteres, comenzando con una letra o un dígito. Solo se admiten letras, dígitos, guiones (-) y guiones bajos (_). |
|
app_secret |
No |
String |
Secreto, que puede contener de 8 a 128 caracteres, comenzando con una letra o un dígito. Solo se permiten letras, dígitos y los siguientes caracteres especiales: _-!@#$% |
Parámetros de respuesta
Código de estado: 201
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
ID. |
|
name |
String |
Nombre. |
|
remark |
String |
Descripción. |
|
creator |
String |
Creador de la aplicación.
El valor MARKET no se admite actualmente. |
|
update_time |
String |
Tiempo de actualización. |
|
app_key |
String |
AppKey. |
|
app_secret |
String |
AppSecret. |
|
register_time |
String |
Tiempo de registro. |
|
status |
Integer |
Estado.
|
|
app_type |
String |
Tipo de aplicación.
El valor predeterminado es apig. Otros tipos no son compatibles actualmente. |
|
roma_app_type |
String |
Tipo de aplicación de ROMA.
Actualmente, este parámetro no es compatible. |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 403
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 404
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Ejemplo de las solicitudes
Modificación de una aplicación
{
"name" : "app_demo",
"remark" : "Demo app"
}
Ejemplo de respuestas
Código de estado: 201
Aceptar
{
"creator" : "USER",
"update_time" : "2020-08-03T13:21:48.381148828Z",
"app_key" : "ee8f878c252747028f07eb116c2cd91b",
"name" : "app_demo",
"remark" : "Demo app",
"id" : "356de8eb7a8742168586e5daf5339965",
"app_secret" : "416************ab8",
"register_time" : "2020-08-03T13:09:13",
"status" : 1,
"app_type" : "apig"
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:id. Please refer to the support documentation"
}
Código de estado: 401
Sin autorización
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Prohibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 404
No se ha encontrado
{
"error_code" : "APIG.3002",
"error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"
}
Código de estado: 500
Error del servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
201 |
Aceptar |
|
400 |
Error en la solicitud |
|
401 |
Sin autorización |
|
403 |
Prohibido |
|
404 |
No se ha encontrado |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.