文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ File/ 获取仓库默认分支的Readme文件内容
更新时间：2025-07-15 GMT+08:00
查看PDF
分享

获取仓库默认分支的Readme文件内容

功能介绍

获取仓库默认分支的Readme文件内容

调试

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

URI

GET /v4/repositories/{repository_id}/repository/readme-file

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

仓库的ID，通过查询用户所有仓库接口查询项目列表获取。

约束限制：

不涉及。

取值范围：

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Header参数

参数

参数类型

描述

X-Total

Integer

获取仓库默认分支的Readme文件内容
表4 响应Body参数

参数

参数类型

描述

blob_id

String

参数解释：

bolb文件ID。

约束限制：

不涉及。

content

String

参数解释：

经过base64编码后的文件内容。

约束限制：

不涉及。

encoding

AnyType

参数解释：

文件编码方式。

约束限制：

  • base64。

默认取值：

base64。

file_name

String

文件名称

file_path

String

文件路径

file_type

String

文件类型

size

Long

参数解释：

文件字节大小。

约束限制：

不涉及。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/2112015538/repository/readme-file

响应示例

状态码：200

获取仓库默认分支的Readme文件内容

{
  "blob_id" : "634be87120b8e9df12bb79f47e1a2c1f1a732848",
  "content" : "IyAwOTExXzE0MzhfY3JlYXRlCgo",
  "encoding" : "base64",
  "file_name" : "README.md",
  "file_path" : "README.md",
  "file_type" : "text/plain; charset=utf-8",
  "size" : 20
}

状态码：401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "未识别到用户认证信息"
}

状态码：403

Bad Request

{
  "error_code" : "CH.00401008",
  "error_msg" : "您没有操作权限，请升级权限后重试。"
}

状态码：404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "该仓库不存在,请检查后重试。"
}

状态码

状态码

描述

200

获取仓库默认分支的Readme文件内容

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码。

父主题： File

相关文档