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

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

功能介绍

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

当前API已经废弃，请使用查看文件属性与内容。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

repository_uuid

是

String

参数解释：

仓库UUID(参考获取仓库详情接口返回uuid)。

约束限制：

不涉及。

取值范围：

由数字和字母组成，且长度为32个字符。

默认取值：

不涉及。

branch_name

是

String

参数解释：

分支名称。

约束限制：

不涉及。

取值范围：

分支名称长度为[0-200]。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

path

是

String

参数解释：

文件路径。

约束限制：

不涉及。

取值范围：

0-200

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

长度为[1,100000]个字符。

默认取值：

不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

参数解释：

响应错误。

取值范围：

不涉及。

result

FilesResponseInfo object

参数解释：

响应结果。

取值范围：

不涉及。

status

String

参数解释：

响应状态。

取值范围：

  • success，表示接口调用成功。
  • failed，表示接口调用失败。
表5 Error

参数

参数类型

描述

code

String

参数解释：

错误码。

取值范围：

符合错误码格式字符串，长度[0,100]。

message

String

参数解释：

错误信息。

取值范围：

不涉及。
表6 FilesResponseInfo

参数

参数类型

描述

file_name

String

参数解释：

文件名称

取值范围：

不涉及。

file_path

String

参数解释：

文件路径

取值范围：

不涉及。

size

Integer

参数解释：

文件大小

取值范围：

不涉及。

encoding

String

参数解释：

编码类型

取值范围：

不涉及。

ref

String

参数解释：

分支或Tag名称

取值范围：

不涉及。

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

相关文档