文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-凭据管理/ 修改APP
更新时间：2024-11-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改APP

功能介绍

修改指定APP的信息。其中可修改的属性为：name、remark，当支持用户自定义key和secret的开关开启时，app_key和app_secret也支持修改，其它属性不可修改。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

app_id

是

String

应用编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

APP的名称。支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3 ~ 64个字符。

说明：

中文字符必须为UTF-8或者unicode编码。

remark

否

String

APP描述。字符长度不能大于255。

说明：

中文字符必须为UTF-8或者unicode编码。

app_key

否

String

APP的key。支持英文，数字，“_”，“-”，且只能以英文或数字开头，8 ~ 200个字符。

app_secret

否

String

密钥。支持英文，数字，“_”，“-”，“!”，“@”，“#”，“$”，“%”，且只能以英文或数字开头，8 ~ 128个字符。

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

id

String

编号

name

String

名称

remark

String

描述

creator

String

APP的创建者

  • USER：用户自行创建

  • MARKET：云商店分配

暂不支持MARKET

update_time

String

更新时间

app_key

String

APP的key

app_secret

String

密钥

register_time

String

注册时间

status

Integer

状态

  • 1： 有效

app_type

String

APP的类型：

  • apig：存量apig应用，不推荐使用

  • roma：roma集成应用

默认apig，暂不支持其他类型

roma_app_type

String

ROMA_APP的类型：

  • subscription：订阅应用

  • integration：集成应用

暂不支持

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

修改一个app的信息

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

响应示例

状态码： 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" : "416************ab8",
  "register_time" : "2020-08-03T13:09:13",
  "status" : 1,
  "app_type" : "apig"
}

状态码： 400

Bad Request

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

状态码： 401

Unauthorized

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

状态码： 403

Forbidden

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

状态码： 404

Not Found

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

状态码： 500

Internal Server Error

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

状态码

状态码

描述

201

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 专享版-凭据管理