
# 获取代码导航引用关系 - ListRepositoryNavigationReferences
#### 功能介绍
获取代码导航引用关系
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/doc?api=ListRepositoryNavigationReferences&version=v4)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
当前API调用无需身份策略权限。
#### URI
GET /v4/repositories/{repository_id}/repository/nav/references
表1路径参数 
| 参数            | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| repository_id | 是    | Integer | **参数解释：** 仓库的ID，通过[查询用户所有仓库](https://support.huaweicloud.com/api-codeartsrepo/ListUserAllRepositories.html)接口查询项目列表获取。 **约束限制：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 |
   
表2Query参数 
| 参数        | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| path      | 否    | String | **参数解释：** 文件路径。 **取值范围：** 字符串长度不少于1，不超过100000。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| revision  | 否    | String | **参数解释：** 版本提交id **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ref       | 否    | String | **参数解释：** 引用，可以是分支名称、标签名称或者commitid，如果不传则为默认分支。 **取值范围：** 字符串长度不少于1，不超过2000。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| symbol    | 是    | String | **参数解释：** 搜索符号（页面选中的字符串） **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| language  | 是    | String | **参数解释：** 代码语言 **取值范围：** - C   - C++   - Go   - Java   - JavaScript   - PHP   - Python   - Ruby   - Rust    |
| blob      | 是    | String | **参数解释：** blob文件ID。通过[查询某个仓库的文件信息](https://support.huaweicloud.com/api-codeartsrepo/ListFilesByQuery.html)接口查询某个仓库的文件信息获取。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| file_path | 是    | String | **参数解释：** 文件路径。 **取值范围：** 字符串长度不少于1，不超过10000。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数      | 参数类型                                                                                      | 描述                                                                                                                                                                                                 |
|:---|:---|:---|
| result  | String                                                                                    | **参数解释：** 结果标识。 **约束限制：** 不涉及。   |
| message | String                                                                                    | **参数解释：** 结果消息。 **约束限制：** 不涉及。   |
| defs    | Array of [DefEntryDto] objects | **参数解释：** 节点信息。 **约束限制：** 不涉及。   |
| refs    | Array of [RefEntryDto] objects | **参数解释：** 索引信息列表。 **约束限制：** 不涉及。 |
   
 表5DefEntryDto 
| 参数          | 参数类型    | 描述                                                                                                                                                                                                           |
|:---|:---|:---|
| tag_name    | String  | **参数解释：** 标记名称。 **约束限制：** 不涉及。             |
| file_path   | String  | **参数解释：** 文件路径。 **约束限制：** 不涉及。             |
| blob        | String  | **参数解释：** blob文件ID。 **约束限制：** 不涉及。         |
| line_image  | String  | **参数解释：** 索引行简要内容。 **约束限制：** 不涉及。          |
| line_number | Integer | **参数解释：** 行号。 **约束限制：** 不涉及。               |
| range       | String  | **参数解释：** 范围信息。 **约束限制：** 不涉及。             |
| syntax_type | String  | **参数解释：** 语法类型。 **约束限制：** 不涉及。             |
| revision    | String  | **参数解释：** 所在版本号（commit id）。 **约束限制：** 不涉及。 |
| extend      | String  | **参数解释：** 其他信息。 **约束限制：** 不涉及。             |
   
 表6RefEntryDto 
| 参数          | 参数类型    | 描述                                                                                                                                                                                                           |
|:---|:---|:---|
| tag_name    | String  | **参数解释：** 标记名称。 **约束限制：** 不涉及。             |
| file_path   | String  | **参数解释：** 文件路径。 **约束限制：** 不涉及。             |
| blob        | String  | **参数解释：** blob文件ID。 **约束限制：** 不涉及。         |
| line_image  | String  | **参数解释：** 索引行简要内容。 **约束限制：** 不涉及。          |
| line_number | Integer | **参数解释：** 行号。 **约束限制：** 不涉及。               |
| syntax_type | String  | **参数解释：** 语法类型。 **约束限制：** 不涉及。             |
| revision    | String  | **参数解释：** 所在版本号（commit id）。 **约束限制：** 不涉及。 |
| extend      | String  | **参数解释：** 其他信息。 **约束限制：** 不涉及。             |
   
#### 请求示例
```
GET https://{endpoint}/v4/repositories/123/repository/nav/references?ref=test&file_path=aes.utlil.java&symbol=apache&revision=745cde5c18f0cxxx127db2c8e8a65856f8d&row=8&col=18&project_id=32&language=java&blob=b647455b7a4854xxxs6a3fa1a8
```
#### 响应示例
**状态码：200**
OK
```
{
  "result" : "0",
  "message" : "",
  "defs" : [ ],
  "refs" : [ {
    "tag_name" : "ObjectMapper",
    "file_path" : "Test.java",
    "blob" : "69db78cd4b81ebxxxx38149771852e7f7da71",
    "line_image" : "import com.fasterxml.jackson.databind.ObjectMapper;",
    "line_number" : 10,
    "syntax_type" : "variable",
    "revision" : "23af980a1xxxxc1d3c9e4b8e3f25ba5c9c3aa",
    "extend" : ""
  }, {
    "tag_name" : "ObjectMapper",
    "file_path" : "Test2.java",
    "blob" : "69db78cd4b81eb82f214838149771852e7f7da71",
    "line_image" : "    private static final ObjectMapper OBJECT_MAPPER = new                 ObjectMapper();",
    "line_number" : 26,
    "syntax_type" : "variable",
    "revision" : "23af980a11c1xxxxd3c9e4b8e3f25ba5c9c3aa",
    "extend" : ""
  } ]
}
```
#### 状态码
| 状态码 | 描述 |
|:---|:---|
| 200 | OK |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-codeartsrepo/ErrorCode.html)。
