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

修改环境

功能介绍

修改指定环境的信息。其中可修改的属性为：name、remark，其它属性不可修改。

URI

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

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

请求方法

URI

PUT

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

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

表2 参数说明

名称

是否必选

类型

说明

project_id

是

String

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

instance_id

是

String

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

id

是

String

环境的ID，可通过查询环境信息获取该ID

请求消息

表3 参数说明

参数

是否必选

类型

说明

name

是

String

环境的名称

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

remark

否

String

描述信息

字符长度不能大于255。

说明：

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

请求消息样例：

{
	"name": "DEVELOP",
	"remark": "开发环境"
}

响应消息

表4 参数说明

参数

类型

说明

id

String

环境ID

name

String

环境名

create_time

Timestamp

创建环境的时间

remark

String

描述信息

响应参数样例：

{
	"id": "cca3616a-f368-4b32-9064-b2a631cb3eeb",
	"name": "DEVELOP",
	"remark": "开发环境",
	"create_time": "2017-12-28T12:50:47Z"
}

状态码

表5 返回消息说明

状态码

说明

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error

相关文档