文档首页/ API网关 APIG/ API参考/ 专享版API（V1）（待下线）/ APP管理（待下线）/ 修改APP
更新时间：2024-01-19 GMT+08:00
查看PDF
分享

修改APP

功能介绍

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

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1 HTTP/HTTPS请求方法以及URI

请求方法

URI

PUT

/v1/{project_id}/apigw/instances/{instance_id}/apps/{id}

URI中的参数说明如下表所示。

表2 参数说明

名称

是否必选

类型

说明

project_id

是

String

项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。

instance_id

是

String

实例ID，可从API网关控制台的专享版实例信息中获取。

id

是

String

APP的编号，可通过查询APP列表获取。

请求消息

表3 参数说明

参数

是否必选

类型

说明

name

是

String

APP的名称

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

说明：

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

remark

否

String

APP描述

字符长度不能大于255

说明：

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

app_key

否

String

APP的key

支持英文，数字，“_”,“-”,且只能以英文或数字开头，8 ~ 64个字符。

说明：

只支持部分region自定义。

app_secret

否

String

密钥

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

说明：

只支持部分region自定义。

请求消息样例：

{
	"name": "app_001",
	"remark": "第一个APP",
        "app_key": "app_key_sample",
        "app_secret": "app_secret_sample"
}

响应消息

表4 参数说明

参数

类型

说明

id

String

编号

name

String

名称

status

Integer

状态

app_key

String

APP的key

app_secret

String

密钥

creator

String

APP的创建者，取值如下：

  • USER：用户自行创建
  • MARKET：云商店分配

register_time

Timestamp

创建时间

remark

String

描述

update_time

Timestamp

更新时间

app_type

String

APP类型，默认为apig

响应消息样例：

{
	"id": "14b39****4537e9",
	"name": "app_001",
	"status": 1,
	"app_key": "d49b1****376eb",
	"app_secret": "******",
	"creator": "USER",
	"remark": "第一个APP",
	"register_time": "2017-12-28T12:26:54Z",
	"update_time": "2017-12-28T12:28:07.2966182Z",
        "app_type": "apig"
}

状态码

表5 返回消息说明

状态码

说明

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error

相关文档