文档首页/ 代码托管 CodeArts Repo/ API参考/ 历史API/ File/ 查询某个仓库的文件信息(废弃)
更新时间:2025-08-20 GMT+08:00
分享

查询某个仓库的文件信息(废弃)

功能介绍

获取仓库中文件的信息,如名称、大小、内容。请注意,文件内容是Base64编码的。

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

调试

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

URI

GET /v2/projects/{repo_id}/repository/files/{file_path}

表1 路径参数

参数

是否必选

参数类型

描述

repo_id

Integer

仓库短id

file_path

String

Url编码的新文件的完整路径。

表2 Query参数

参数

是否必选

参数类型

描述

ref

String

commit id,仓库的branch名或tag名

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

Array of FileContentInfo objects

差异列表

status

String

参数解释:

响应状态

取值范围:

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

参数

参数类型

描述

code

String

错误码

message

String

错误信息

表6 FileContentInfo

参数

参数类型

描述

file_name

String

文件名

file_path

String

文件路径

size

Integer

文件大小

encoding

String

文件编码

content_sha256

String

sha256编码的文件内容

ref

String

分支名

blob_id

String

blob sha

commit_id

String

提交对应的SHA id

last_commit_id

String

最后一个提交对应的SHA id

content

String

base64编码的文件内容

请求示例

GET https://{endpoint}/v2/projects/859341/repository/files/README%2Emd?ref=master

响应示例

状态码: 200

OK

{
  "result" : [ {
    "size" : 9,
    "encoding" : "base64",
    "ref" : "master",
    "content" : "NDU0NTQ1NDQ1",
    "file_name" : "README.md",
    "file_path" : "README.md",
    "content_sha256" : "e16f4f6c41a79d120484774a625bea8a3c3dcb655aa7c7e793ac48639dc63944",
    "blob_id" : "3325fa3142fd66fedc8c3a5218b417f561e0ea2f",
    "commit_id" : "a772945ec2765e322cc83e0f467f394effa22cf3",
    "last_commit_id" : "a772945ec2765e322cc83e0f467f394effa22cf3"
  } ],
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档