文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Repository/ 获取仓库指定分支或者标签子模块列表
更新时间：2025-08-20 GMT+08:00
查看PDF
分享

获取仓库指定分支或者标签子模块列表

功能介绍

获取仓库指定分支或者标签子模块列表

调试

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

URI

GET /v4/repositories/{repository_id}/repository/submodules

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

1-2147483647
表2 Query参数

参数

是否必选

参数类型

描述

sha

是

String

参数解释：

分支名、tag名、提交ID。

offset

否

Integer

参数解释：

偏移量，从0开始。

取值范围：

0-2147483647

默认取值：

0

limit

否

Integer

参数解释：

返回数量。

取值范围：

1-100

默认取值：

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-Total

Integer

当前请求的结果总条数
表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of SubmoduleDto objects

子模块列表
表6 SubmoduleDto

参数

参数类型

描述

repo_id

Integer

参数解释：

仓库ID。

branch

String

参数解释：

分支名。

取值范围：

最小1个字节，最大200字节。

path

String

参数解释：

分支名。

取值范围：

最小1个字节，最大200字节

git_url

String

参数解释：

子模块Git地址。

submodule_branch

String

参数解释：

子模块分支名。

取值范围：

最小1个字节，最大200字节。

namespace_uuid

String

组织名/组织名.../仓库名

submodule_repo_id

Integer

参数解释：

子模块仓库ID。

repo_name

String

参数解释：

子模块仓库名称。

sub_commitId

String

参数解释：

子模块仓库提交。

deployKey_status

Integer

参数解释：

部署秘钥同步状态。

取值范围：

  • 0，不同步。

  • 1，同步。

默认取值：

0

status

Integer

参数解释：

子模块状态。

取值范围：

  • 0，异常。

  • 1，正常。

默认取值：

0

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/2112016472/repository/submodules?sha=111

响应示例

状态码：200

OK

[ {
  "repo_id" : 2112016472,
  "branch" : "base64",
  "path" : "repo1122",
  "git_url" : "git@.**.***example.com:12345/repo1122.git",
  "submodule_branch" : "dsds",
  "namespace_uuid" : "0379d2da2bae4c38b3d2fbbdb6asd2fs",
  "submodule_repo_id" : 2112000256,
  "repo_name" : "repo1122",
  "sub_commitId" : "7963ac02",
  "deployKey_status" : 0,
  "status" : 1
} ]

状态码：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

OK

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码。

父主题： Repository

相关文档