文档首页/代码托管 CodeArts Repo/API参考/API/V4/Repository/获取代码导航功能的模式信息 - ShowRepositoryNavigationSchema
更新时间:2026-04-07 GMT+08:00
分享

获取代码导航功能的模式信息 - ShowRepositoryNavigationSchema

功能介绍

获取代码导航功能的模式信息,包括最近索引创建时间,做大统计的文件数量信息等

调试

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

授权信息

当前API调用无需身份策略权限。

URI

GET /v4/repositories/{repository_id}/repository/nav/schema

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

默认取值:

不涉及。

取值范围:

1~2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

String

参数解释:

结果标识。

约束限制:

不涉及。

message

String

参数解释:

结果消息。

约束限制:

不涉及。

schema

SchemaDto object

参数解释:

代码导航功模式信息

表4 SchemaDto

参数

参数类型

描述

version

String

参数解释:

代码导航版本。

约束限制:

不涉及。

默认取值:

不涉及

maximum_file_size

Integer

参数解释:

支持的最大文件大小。

约束限制:

不涉及。

默认取值:

0

maximum_line_length

Integer

参数解释:

支持的最大行数。

约束限制:

不涉及。

默认取值:

0

maximum_truncate_line

Integer

参数解释:

每行支持的最大字符数,超过将截断。

约束限制:

不涉及。

默认取值:

0

create_at

String

参数解释:

索引创建时间。

约束限制:

不涉及。

默认取值:

不涉及

update_at

String

参数解释:

索引更新时间。

约束限制:

不涉及。

默认取值:

不涉及

rebuild_at

String

参数解释:

索引重建时间。

约束限制:

不涉及。

默认取值:

不涉及

last_build_at

String

参数解释:

索引最近构建时间。

约束限制:

不涉及。

默认取值:

不涉及

build_times

Integer

参数解释:

索引构建次数。

约束限制:

不涉及。

默认取值:

0

query_times

Integer

参数解释:

请求次数。

约束限制:

不涉及。

默认取值:

0

outline_times

Integer

参数解释:

索引大纲请求次数。

约束限制:

不涉及。

默认取值:

0

请求示例

响应示例

状态码:200

OK

{
  "result" : "0",
  "message" : "",
  "schema" : {
    "version" : "VERSION 1.5",
    "maximum_file_size" : 358400,
    "maximum_line_length" : 4096,
    "maximum_truncate_line" : 1000,
    "create_at" : "2026-01-08T16:29:52+08:00",
    "update_at" : "",
    "rebuild_at" : "",
    "last_build_at" : "2026-01-08T16:29:52+08:00",
    "build_times" : 0,
    "query_times" : 0,
    "outline_times" : 0
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档