Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ API Gateway/ Referencia de la API/ Las API de gateway dedicado (V2)/ Gestión de aplicaciones/ Modificación de una aplicación
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF
Compartir

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.

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}

Tabla 1 Parámetros de path

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento.

instance_id

Sí

String

Gateway ID, que se puede obtener de la información de gateway en la consola APIG.

app_id

Sí

String

ID de la aplicación.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Token de usuario. Se puede obtener llamando 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.
Tabla 3 Parámetros de body de solicitud

Parámetro

Obligatorio

Tipo

Descripción

name

Sí

String

Nombre de la aplicación. Puede contener de 3 a 64 caracteres, empezando por una letra. Solo se permiten letras, dígitos y guiones bajos (_).

remark

No

String

Descripción de la aplicación. No puede superar los 255 caracteres.

app_key

No

String

AppKey. Puede contener de 8 a 64 caracteres, comenzando con una letra o un dígito. Solo se permiten letras, dígitos, guiones (-) y guiones bajos (_).

app_secret

No

String

AppSecret. Puede contener de 8 a 64 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

Tabla 4 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

id

String

ID.

name

String

Nombre.

remark

String

Descripción.

creator

String

Creador de la aplicación.

  • USER: La aplicación es creada por un usuario de API.

  • MARKET: KooGallery asigna la aplicación.

El valor MARKET no se admite actualmente.

Valores de enumeración:

  • USER

  • MARKET

update_time

String

Hora de actualización.

app_key

String

AppKey.

app_secret

String

AppSecret.

register_time

String

Hora de registro.

status

Integer

Estado.

  • 1: válido

Valores de enumeración:

  • 1

app_type

String

Tipo de aplicación.

  • apig: aplicación de APIG, que no se recomienda.

  • roma: Aplicación de integración de ROMA.

El valor predeterminado es apig. Otros tipos no son compatibles actualmente.

Valores de enumeración:

  • apig

  • roma

roma_app_type

String

Tipo de aplicación de ROMA.

  • suscripción: aplicación de suscripción

  • integración: aplicación de integración

Actualmente, este parámetro no es compatible.

Código de estado: 400

Tabla 5 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 401

Tabla 6 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 403

Tabla 7 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 404

Tabla 8 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 9 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitudes de ejemplo

{
  "name" : "app_demo",
  "remark" : "Demo app"
}

Ejemplo de respuestas

Código de estado: 201

OK

{
  "creator" : "USER",
  "update_time" : "2020-08-03T13:21:48.381148828Z",
  "app_key" : "ee8f878c252747028f07eb116c2cd91b",
  "name" : "app_demo",
  "remark" : "Demo app",
  "id" : "356de8eb7a8742168586e5daf5339965",
  "app_secret" : "416b6b2a1d394111b9bc1df0e6842ab8",
  "register_time" : "2020-08-03T13:09:13",
  "status" : 1,
  "app_type" : "apig"
}

Código de estado: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:id. Please refer to the support documentation"
}

Código de estado: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de estado: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de estado: 404

Not Found

{
  "error_code" : "APIG.3002",
  "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"
}

Código de estado: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de estado

Código de estado

Descripción

201

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de aplicaciones