CreateEnvironment - 创建环境

创建环境。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apig:CreateEnvironmentnone
*全部资源
*

请求语法

POST /v1/environments HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求 Body。

namestring

环境名称。

test
aliasstring

环境别名。

测试环境
descriptionstring

环境的描述信息,可以填写环境用途,所有人等信息。

这是xxx的xx项目测试环境
gatewayIdstring

网关 id。

gw-cq7l5s5lhtgi6qasrdc0

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id,用于追溯 API 调用链路。

3C3B9A12-3868-5EB9-8BEA-F99E03DD125C
codestring

响应码。

Ok
messagestring

响应消息。

success
dataobject

响应数据。

environmentIdstring

环境 id。

env-cq7l5s5lhtgi6qasrdc0

示例

正常返回示例

JSON格式

{
  "requestId": "3C3B9A12-3868-5EB9-8BEA-F99E03DD125C",
  "code": "Ok",
  "message": "success",
  "data": {
    "environmentId": "env-cq7l5s5lhtgi6qasrdc0"
  }
}

错误码

访问错误中心查看更多错误码。