文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Repository/ 获取一个仓库下特定分支指定文件内容
更新时间：2024-11-18 GMT+08:00
查看PDF
分享

获取一个仓库下特定分支指定文件内容

功能介绍

获取一个仓库下特定分支指定文件内容

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/repositories/{repository_uuid}/branch/{branch_name}/file

表1 路径参数

参数

是否必选

参数类型

描述

repository_uuid

是

String

仓库id

branch_name

是

String

分支名称
表2 Query参数

参数

是否必选

参数类型

描述

path

是

String

文件路径

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释：

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

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

FilesResponseInfo object

响应结果

status

String

响应状态
表5 Error

参数

参数类型

描述

code

String

错误码

message

String

错误信息
表6 FilesResponseInfo

参数

参数类型

描述

file_name

String

文件名称

file_path

String

文件路径

size

String

文件大小

encoding

String

编码类型

ref

String

分支名称

blob_id

String

文件块id

file_type

String

文件类型

content

String

文件内容

请求示例

GET https://{endpoint}/v1/repositories/{repository_uuid}/branch/{branch_name}/file

响应示例

状态码： 200

OK

{
  "result" : [ {
    "file_name" : "README.md",
    "file_path" : "README.md",
    "size" : 666,
    "encoding" : "base64",
    "ref" : "master",
    "blob_id" : "75c19b5b1904a72c8a9959c98ae6884d0ace0279",
    "file_type" : "text/plain; charset=utf-8",
    "content" : "RUVFRUVFRUU="
  } ],
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Repository

相关文档