更新时间:2022-08-30 GMT+08:00
分享

创建环境

功能介绍

在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测试的版本,发布在测试环境上,而v1.2的版本目前开发团队正处于开发过程中,可以发布到开发环境进行自测等。

为此,API网关提供多环境管理功能,使租户能够最大化的模拟实际场景,低成本的接入API网关。

URI

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

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

请求方法

URI

POST

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

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

表2 参数说明

名称

是否必选

类型

说明

project_id

String

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

instance_id

String

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

请求消息

表3 参数说明

参数

是否必选

类型

说明

name

String

环境的名称

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

remark

String

描述信息

字符长度不能大于255

说明:

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

请求消息样例:

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

响应消息

表4 参数说明

参数

类型

说明

id

String

环境ID

name

String

环境名称

create_time

Timestamp

创建时间

remark

String

描述信息

响应参数样例:

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

状态码

表5 返回消息说明

状态码

说明

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Internal Error

相关文档