文档首页 > > API参考> API> 模板任务> DevStar 模板生成代码

DevStar 模板生成代码

分享
更新时间:2020/07/31 GMT+08:00

功能介绍

通过DevStar的模板进行应用代码创建。

通过 DevStar 模板创建生成应用代码的任务,并将应用代码存储于指定的 CodeHub 仓库中,可以通过返回的任务 ID 查询相关任务状态。

  • 接口鉴权方式。通过华为云服务获取的用户token。
  • 代码生成位置。应用代码生成后的地址,目前支持 CodeHub 地址和压缩包下载地址。

调试

您可以在API Explorer中直接运行调试该接口。

URI

POST /v1/jobs/template

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

X-Language

String

语言类型,枚举值:

  • zh-cn:中文
  • en-us:英文
表2 请求Body参数

参数

是否必选

参数类型

描述

application_name

String

应用名称。

repo_type

Integer

枚举值:

  • 0:将生成的应用代码存储于 repo_info 指定的 CodeHub 仓库中。
  • 1:将生成的应用代码存储到华为云,任务创建人可以通过 ExportApplicationCode 下载代码压缩包。

template_id

String

Devstar模板 ID,可以从模板列表查询接口获取。

properties

Map<String,String>

可以从查询模板详情查看模板的动态参数列表。

repo_info

RepositoryInfo object

生成的代码框架存储的 CodeHub 信息, 当 repo_type = 0 时必填。

表3 RepositoryInfo

参数

是否必选

参数类型

描述

name

String

代码仓的名称。

project_id

String

CodeHub 仓库所属项目的 UUID。

region_id

String

CodeHub 仓库所在的 Region ID。具体请参考地区与终端节点

响应参数

状态码为 202 时:

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务id

请求示例

{
  "application_name" : "string",
  "repo_type" : "0",
  "template_id" : "string",
  "properties" : "object",
  "repo_info" : {
    "name" : "string",
    "project_id" : "string",
    "region_id" : "string"
  }
}

响应示例

状态码为 202 时:

Accepted

{
  "id" : "j_zNvQCYTy"
}

状态码为 400 时:

Bad Request

{
  "error_code" : "HDN.1001",
  "error_msg" : "参数错误"
}

状态码为 401 时:

Unauthorized

{
  "error_code" : "HDN.1001",
  "error_msg" : "权限错误"
}

状态码为 403 时:

Forbidden

{
  "error_code" : "HDN.1001",
  "error_msg" : "权限错误"
}

状态码

状态码

描述

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见 API错误中心

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问