更新时间:2024-10-11 GMT+08:00
分享

获取仓库文件内容

功能介绍

获取仓库文件内容。

调试

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

URI

GET /v1/{project_id}/git/files/{namespace}/{project}/{path}

参数说明见表1

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID。获取方法,请参考获取项目ID

namespace

String

命名空间ID或者URL编码名称。获取方法,请参考获取仓库namespaces

project

String

仓库项目ID或者URL编码名称,如果含有“/”,需要将“/”替换为“:”。获取方法,请参考获取命名空间下所有项目

path

String

文件路径,需要将“/”替换为“:”。获取方法,请参考获取仓库文件目录

表2 查询参数

参数

是否必选

参数类型

描述

ref

String

分支名称或者tag名称或者commit sha。

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式),默认取值为“application/json;charset=utf8”。

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token

X-Repo-Auth

String

授权名称,通过获取仓库授权列表获取对应的授权名称。

响应消息

表4 响应参数

参数

参数类型

描述

path

String

文件路径。

sha

String

commit哈希。

encoding

String

编码方式:base64或者text/plain。

content

String

文件内容。

请求示例

响应示例

{
  "path": "app/models/key.rb",
  "sha": "4c294617b60715c1d218e61164a3abd4808a4284cbc30e6728a01ad9aada4481",
  "encoding": "base64",
  "content": "IyA9PSBTY2hlbWEgSW5mb3..."
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

错误码

错误码格式为:SVCSTG.REPO.[Error_ID],例如:SVCSTG.REPO.0401。错误码说明请参考ServiceStage错误码

相关文档