创建项目下的环境，并可选地根据模板自动部署该环境。 服务会部署到指定的环境中，环境可以绑定代码仓库的某个分支或者某个项目模板。环境还可以设置基础设施堆栈，被环境下的所有服务所共享。
接口说明
使用注意事项：
-
当 Environment.Spec.TemplateConfig 非空时：创建环境后，开发平台会使用您提供的模板信息异步地为您自动部署该项目（创建 PipelineTrigger、PipelineTriggerEvent、Pipeline 实体）。
-
当 Environment.Spec.TemplateConfig 为空时：仅创建环境实体，需要您手动调用 PipelineTrigger、PipelineTriggerEvent 相关 API 完成部署。
注意 通过模板完成的项目部署流程完全免费，部署后项目模板所涉及的云资源将按照各云产品的计费方式计费
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| devs:CreateEnvironment | create | *全部资源 * |
| 无 |
请求语法
POST /2023-07-14/projects/{projectName}/environments HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | Environment | 否 | 环境实体 | |
| projectName | string | 是 | 项目名 | demo-project |
返回参数
示例
正常返回示例
JSON格式
{
"name": "demo-env",
"kind": "Environment",
"uid": "1455541096***548",
"createdTime": "2021-11-19T09:34:38Z",
"description": "test env",
"spec": {
"type": "Testing",
"roleArn": "acs:ram::*******:role/aliyundevsdefaultrole",
"stagedConfigs": {
"services": {
"key": {
"props": {
"test": "test",
"test2": 1
},
"source": {
"template": {
"downloadUrl": "https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6",
"name": "start-springboot-cap"
},
"repository": {
"repositoryName": "my-repository",
"codeVersion": {
"branch": "main",
"commitID": "12721ec262d03a93809ba2bbc717963cb298ceca"
},
"filter": {
"branch": {
"name": "master"
}
}
},
"oss": {
"bucket": "demo-bucket",
"object": "demo-object"
}
},
"build": {
"default": {
"cache": {
"driver": "",
"paths": [
"~/.npm"
],
"keyPath": {
"3C75C832-0EAD-40D6-8FA1-2BA9171C926B": "~/.npm",
"D256BB7A-1886-4A19-A75B-A1FDC23D5A00": "~/.cache"
}
},
"languages": [
"Python3.9"
],
"rootPath": "./src",
"steps": [
{
"run": "npm build"
}
]
}
},
"variables": {
"key": {
"value": "object_value",
"sensitive": false,
"encrypted": false
}
},
"initialize": {
"steps": [
{
"run": "npm build"
}
]
},
"type": "Function",
"finalize": {
"steps": [
{
"run": "echo 'deleted'"
}
]
},
"token": "9D72DE01-C732-49C0-8E85-FFD9D695436B",
"component": "fc3@1.0.0",
"artifact": {
"name": "my-artifact",
"checksum": "CRC-64 code"
}
}
},
"variables": {
"key": {
"value": "object_value",
"sensitive": false,
"encrypted": false
}
}
}
},
"labels": {
"key": "value to the label key."
},
"status": {
"servicesInstances": {
"key": {
"config": {
"props": {
"test": "test",
"test2": 1
},
"source": {
"template": {
"downloadUrl": "https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6",
"name": "start-springboot-cap"
},
"repository": {
"repositoryName": "my-repository",
"codeVersion": {
"branch": "main",
"commitID": "12721ec262d03a93809ba2bbc717963cb298ceca"
},
"filter": {
"branch": {
"name": "master"
}
}
},
"oss": {
"bucket": "demo-bucket",
"object": "demo-object"
}
},
"build": {
"default": {
"cache": {
"driver": "",
"paths": [
"~/.npm"
],
"keyPath": {
"3C75C832-0EAD-40D6-8FA1-2BA9171C926B": "~/.npm",
"D256BB7A-1886-4A19-A75B-A1FDC23D5A00": "~/.cache"
}
},
"languages": [
"Python3.9"
],
"rootPath": "./src",
"steps": [
{
"run": "npm build"
}
]
}
},
"variables": {
"key": {
"value": "object_value",
"sensitive": false,
"encrypted": false
}
},
"initialize": {
"steps": [
{
"run": "npm build"
}
]
},
"type": "Function",
"finalize": {
"steps": [
{
"run": "echo 'deleted'"
}
]
},
"token": "9D72DE01-C732-49C0-8E85-FFD9D695436B",
"component": "fc3@1.0.0",
"artifact": {
"name": "my-artifact",
"checksum": "CRC-64 code"
}
},
"variables": {},
"outputs": {
"key": ""
},
"latestDeployment": {
"name": "",
"startTime": "",
"finishedTime": "",
"phase": "Running"
},
"status": "RUNNING",
"message": "OK"
}
},
"latestEnvironmentDeploymentName": "",
"servicesWithPendingChanges": [
"服务名称"
],
"observedGeneration": 1,
"observedTime": "2021-11-19T09:34:38Z"
},
"projectName": "demo-project",
"generation": 1
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-06 | OpenAPI 入参发生变更 | 查看变更详情 |