链接复制成功!
创建部署任务
功能介绍
创建部署任务,并触发任务执行,当前只支持函数部署。 其中,报文中file_id为查询软件版本包接口返回版本包id; handler为在函数部署方式下,入口函数名称,从应用代码中获取,格式为“包名.类名.函数名称”,例如:com.example.demo.APIGTrigger.handler。 也可以从应用详情接口返回结构template_deployment中直接获取。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/applications/{application_id}/environments/{environment_tag}/deployment-jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
application_id |
是 |
String |
应用id |
environment_tag |
是 |
String |
环境标识,从 应用详情接口 返回报文中的环境信息获取。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Language |
否 |
String |
语言类型 中文:zh-cn 英文:en-us |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
function |
否 |
FGSDeploymentJobsParam object |
函数部署参数 |
cci |
否 |
CciDeploymentJobsParam object |
cci部署参数 |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
部署任务编号 |
job_id |
String |
任务ID |
status |
Integer |
部署状态,-2:环境准备未就绪 -1 资源准备就绪 0 部署中 1:成功 2:失败 |
address |
String |
访问地址 |
deploy_parameters |
String |
部署参数 |
time |
Integer |
部署耗时 |
creator_name |
String |
创建人 |
created_time |
String |
创建时间 |
请求示例
创建部署任务
POST https://{endpoint}/v1/applications/658942cfdfdc46ed911bc7006f1364ef/environments/dev_env/deployment-jobs
{
"function" : {
"file_id" : "658942cfdfdc46ed911bc7006f1364ef",
"handler" : "index.handler"
}
}
响应示例
状态码: 201
Created
{
"job_id" : "Asaq1542",
"status" : 0,
"address" : "127.0.0.1:8080/index",
"deploy_parameters" : "xxx",
"time" : 124,
"creator_name" : "xxx",
"created_time" : "2021-06-21T08:20:28.802Z"
}
状态码: 400
Bad Request
{
"error_code" : "DEVSTAR.2002",
"error_msg" : "未知错误"
}
状态码: 401
Unauthorized
{
"error_code" : "DEV.00000001",
"error_msg" : "未识别到用户认证信息"
}
状态码: 403
Forbidden
{
"error_code" : "DEVSTAR.1034",
"error_msg" : "没有权限"
}
状态码
状态码 |
描述 |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
错误码
请参见错误码。