文档首页 > > API参考> API> 查询模板> 读取模板文件内容

读取模板文件内容

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

功能介绍

该接口可以用于模板作者或模板维护人读取模板文件内容。

调试

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

URI

GET /v1/templates/{template_id}/files

表1 路径参数

参数

是否必选

参数类型

描述

template_id

String

模板ID,通过查询模板列表可获取相应的模板ID。

表2 Query参数

参数

是否必选

参数类型

描述

file_path

String

文件相对路径,基于当前根目录的相对文件路径,例如获取HELP.md文件内容,则文件相对路径为“template-resources/file/HELP.md”。

最小长度:0

最大长度:1024

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

语言类型,缺省值为“zh-cn”。

枚举值:

  • zh-cn:中文
  • en-us:英文

响应参数

状态码为 200 时:

表4 响应Body参数

参数

参数类型

描述

content

String

文件内容(返回的文件内容为encoding指定的编码格式编码后的内容)。

encoding

String

内容编码格式(固定base64)。

file_name

String

文件名。

file_path

String

文件相对路径。

file_type

String

文件 MIME Type。

请求示例

GET https://{endpoint}/v1/template/0633650ed8a7e69212eed4c348eb6b8d/files?file_path=src/%2Ftest%2Fjava%2FTest.java

响应示例

状态码为 200 时:

OK

{
  "content" : "cHVibGljIGNsYXNzIFRlc3Qgewp9",
  "encoding" : "base64",
  "file_name" : "Test.java",
  "file_path" : "src/test/java/Test.java",
  "file_type" : "text/plain; charset=utf-8"
}

状态码为 400 时:

Bad Request

{
  "error_code" : "DEVSTAR.1001",
  "error_msg" : "file_path : 非法参数"
}

状态码为 401 时:

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码为 403 时:

Forbidden

{
  "error_code" : "DEVSTAR.1034",
  "error_msg" : "无操作权限"
}

状态码为 404 时:

Not Found

{
  "error_code" : "DEVSTAR.1039",
  "error_msg" : "文件不存在"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见 API错误中心

分享:

    相关文档

    相关产品

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问