# 获取合并请求文件变更页单个文件下的检视意见 - ShowMergeRequestCommentsByLine #### 功能介绍 获取合并请求文件变更页单个文件下的检视意见 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/doc?api=ShowMergeRequestCommentsByLine&version=v4)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codeartsrepo/codeartsrepo_05_0036.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsrepo:repository:getRepository | Read | - | - | - | - | #### URI GET /v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/comments-by-line 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | repository_id | 是 | Integer | **参数解释：** 仓库的ID，通过[查询用户所有仓库](https://support.huaweicloud.com/api-codeartsrepo/ListUserAllRepositories.html)接口查询项目列表获取。 **约束限制：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | | merge_request_iid | 是 | Integer | **参数解释：** 合并请求 iid。 **取值范围：** 1\~2147483647 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | line | 否 | Integer | **参数解释：** 获取特定行的检视意见列表(新增、不变行使用右侧行号；删除行使用左侧行号)。 **取值范围：** 1\~2147483647 | | with_commit_comments | 否 | Boolean | **参数解释：** 是否返回在代码页签下加的评论。 **取值范围：** - true，补充代码页签下的评论并返回。 - false，不处理。 **默认取值：** false | | path | 否 | String | **参数解释：** 文件路径。 **取值范围：** 字符串长度不少于1，不超过100000。 | | view | 否 | String | **参数解释：** 是否只返回基础信息。 **取值范围：** - basic，返回基础信息(建议)。 - sample，额外返回代码片段等信息。 | | base_sha | 否 | String | **参数解释：** 合并请求中原分支与目标分支的共同基准点。 **取值范围：** 长度为40的sha1字符串。 | | start_sha | 否 | String | **参数解释：** 合并请求中，从共同基准点开始到原分支方向的第一个提交点。 **取值范围：** 长度为40的sha1字符串。 | | head_sha | 否 | String | **参数解释：** 合并请求中原分支指向的提交点。 **取值范围：** 长度为40的sha1字符串。 | #### 请求参数 表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参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [CommentPathDto] objects | 单文件下检视意见详情。 | 表5CommentPathDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | new | Array of [LineDiscussionDto] objects | **参数解释：** 位于文件对比结果右侧的检视意见集合。 | | old | Array of [LineDiscussionDto] objects | **参数解释：** 位于文件对比结果左侧的检视意见集合。 | | path | String | **参数解释：** 文件名。 | 表6LineDiscussionDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | discussions | Array of [MergeRequestDiscussionDto] objects | **参数解释：** 位于某一侧某行的检视意见集合。 | | line | Integer | **参数解释：** 所在的行号。 | | type | String | **参数解释：** 所在的行的类型。 **取值范围：** old: 左侧删除行。 new: 右侧新增行。 unchanged-l: 左侧不变行。 unchanged-r: 右侧不变行。 | 表7MergeRequestDiscussionDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 检视意见id(主评论和回复共用)。 | | individual_note | Boolean | **参数解释：** 个人检视意见(不需要解决)。 | | notes | Array of [NoteDto] objects | **参数解释：** 评论列表(主评+回复)。 | | repository_id | Integer | **参数解释：** 仓库id。 **取值范围：** 1\~2147483647 | | noteable_type | String | **参数解释：** 意见类型。 **取值范围：** - MergeRequest: 合并请求下提的检视意见。 - Commit: 代码页或提交记录下提的检视意见。 | | commit_id | String | **参数解释：** 提交记录id。 | | repository_full_path | String | **参数解释：** 仓库路径。 | | a_mode | String | **参数解释：** 文件旧权限(默认100644)。 | | b_mode | String | **参数解释：** 文件新权限(默认100644)。 | | deleted_file | Boolean | **参数解释：** 是否为删除文件。 | | new_file | Boolean | **参数解释：** 是否为新增文件。 | | resolved | Boolean | **参数解释：** 是否已解决。 | | archived | Boolean | **参数解释：** 是否已归档。 | | review_categories | String | **参数解释：** 意见分类key。 | | review_categories_cn | String | **参数解释：** 意见分类中文。 | | review_categories_en | String | **参数解释：** 意见分类英文。 | | review_modules | String | **参数解释：** 意见模块。 | | severity | String | **参数解释：** 严重程度key。 **取值范围：** - suggestion: 建议。 - minor: 一般。 - major: 严重。 - fatal: 致命。 | | severity_cn | String | **参数解释：** 严重程度中文。 **取值范围：** - 建议 - 一般 - 严重 - 致命 | | severity_en | String | **参数解释：** 严重程度英文。 **取值范围：** - Suggestion: 建议。 - Minor: 一般。 - major: 严重。 - fatal: 致命。 | | assignee | [UserBasicDto] object | **参数解释：** 指派人。 | | proposer | [UserBasicDto] object | **参数解释：** 检视人。 | | merge_request_version_params | [MergeRequestVersionParamsDto] object | **参数解释：** 合并请求版本信息。 | | diff_file | String | **参数解释：** 变更页检视意见的代码片段。 | | added_lines | Integer | **参数解释：** 检视意见所在文件的新增行数量。 **取值范围：** 0\~2147483647 | | removed_lines | Integer | **参数解释：** 检视意见所在文件的删除行数量。 **取值范围：** 0\~2147483647 | 表8NoteDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 评论id(主评论和回复不共用)。 **取值范围：** 1\~2147483647 | | type | String | **参数解释：** 评论类型。 **取值范围：** - DiscussionNote: 需要解决的关联代码行的评论。 - DiffNote: 一般。 | | body | String | **参数解释：** 评论内容。 | | author | [UserBasicDto] object | **参数解释：** 评论作者。 | | created_at | String | **参数解释：** 创建时间。 | | updated_at | String | **参数解释：** 更新时间。 | | system | Boolean | **参数解释：** 是否为系统添加的。 | | noteable_id | Integer | **参数解释：** 合并请求id或issue id。 **取值范围：** 1\~2147483647 | | noteable_type | String | **参数解释：** 意见类型。 **取值范围：** - MergeRequest: 合并请求下提的检视意见。 - Commit: 代码页或提交记录下提的检视意见。 | | commit_id | String | **参数解释：** 提交记录id(源自合并请求下的评论commit_id为null，源自commit的评论才有值)。 **约束限制：** 不涉及。 **取值范围：** 长度为40的sha1字符串。 **默认取值：** 不涉及。 | | resolvable | Boolean | **参数解释：** 是否需要解决。 | | is_reply | Boolean | **参数解释：** 是否为回复。 | | resolved_by | [UserBasicDto] object | **参数解释：** 解决人。 | | noteable_iid | Integer | **参数解释：** 合并请求iid或issue iid。 **取值范围：** 1\~2147483647 | | discussion_id | String | **参数解释：** 检视意见id(主评论和回复共用)。 | | repository | String | **参数解释：** 仓库路径。 | | diff_file | String | **参数解释：** 关联代码行所在文件的文件名。 | | diff | String | **参数解释：** 关联代码行的代码片段。 | | archived | Boolean | **参数解释：** 是否已归档。 | | review_categories | String | **参数解释：** 意见分类key。 | | review_categories_cn | String | **参数解释：** 意见分类中文名。 | | review_categories_en | String | **参数解释：** 合并请求版本信息。 | | review_modules | String | **参数解释：** 合并请求版本信息。 | | severity | String | **参数解释：** 严重程度key。 | | severity_cn | String | **参数解释：** 严重程度中文。 **约束限制：** - 建议 - 一般 - 严重 - 致命 | | severity_en | String | **参数解释：** 严重程度英文。 | | file_path | String | **参数解释：** 文件路径(弃用)。 | | line | String | **参数解释：** 行号(弃用)。 | | assignee | [UserBasicDto] object | **参数解释：** 指派人。 | | proposer | [UserBasicDto] object | **参数解释：** 检视人。 | | position | [PositionDto] object | **参数解释：** 关联代码行位置信息。 | | resolved | Boolean | **参数解释：** 是否已解决。 | | is_outdated | Boolean | **参数解释：** 是否已过期。 | | from_robot | Boolean | **参数解释：** 是否为AI工具提供的。 | | moderation_result | Boolean | **参数解释：** 内容审核结果。 | | moderation_time | Long | **参数解释：** 内容审核时间。 | | moderation_status | Integer | **参数解释：** 内容审核状态。 | 表9PositionDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | base_sha | String | **参数解释：** 基础sha值。 | | start_sha | String | **参数解释：** 起始sha值。 | | head_sha | String | **参数解释：** 最新sha值。 | | old_path | String | **参数解释：** 文件旧路径。 | | new_path | String | **参数解释：** 文件新路径。 | | position_type | String | **参数解释：** 文件类型。 | | old_line | Integer | **参数解释：** 旧文件行号。 | | new_line | Integer | **参数解释：** 新文件行号。 | 表10UserBasicDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 用户id。 **取值范围：** 1\~2147483647 | | name | String | **参数解释：** 用户名称。 | | username | String | **参数解释：** 用户名。 | | state | String | **参数解释：** 用户状态。 **取值范围：** - active: 可用账户。 - blocked: 被锁定用户。 - error: 未查询到该用户。 | | service_license_status | Integer | 服务级权限状态 0：停用 1：启用 | | avatar_url | String | 用户头像url | | avatar_path | String | 用户头像路径 | | email | String | 用户邮箱 | | name_cn | String | 用户中文名称 | | web_url | String | 用户个人首页 | | nick_name | String | 用户昵称 | | tenant_name | String | 租户名称 | | error_message | String | **参数解释：** 部分查询接口校验到传参里的用户权限不足或不存在时，返回该用户但该字段不为空用于提示。 | 表11MergeRequestVersionParamsDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | diff_id | Integer | **参数解释：** 版本id(由合并请求id和sha值共同组成)。 | | start_sha | String | **参数解释：** 起始sha值。 | | commit_id | String | **参数解释：** 提交记录id。 | **状态码：401** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 | | error_msg | String | **参数解释：** 错误信息。 | #### 请求示例 ``` GET https://{endpoint}/v4/repositories/2112015538/merge-requests/1/comments-by-line ``` #### 响应示例 **状态码：200** 获取合并请求文件变更页单个文件下的检视意见 ``` success ``` **状态码：401** Unauthorized ``` { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsrepo.v4.region.CodeArtsRepoRegion; import com.huaweicloud.sdk.codeartsrepo.v4.*; import com.huaweicloud.sdk.codeartsrepo.v4.model.*; public class ShowMergeRequestCommentsByLineSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsRepoClient client = CodeArtsRepoClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsRepoRegion.valueOf("")) .build(); ShowMergeRequestCommentsByLineRequest request = new ShowMergeRequestCommentsByLineRequest(); request.withRepositoryId({repository_id}); request.withMergeRequestIid({merge_request_iid}); try { ShowMergeRequestCommentsByLineResponse response = client.showMergeRequestCommentsByLine(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` #### Python ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsrepo.v4.region.codeartsrepo_region import CodeArtsRepoRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsrepo.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsRepoClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsRepoRegion.value_of("")) \ .build() try: request = ShowMergeRequestCommentsByLineRequest() request.repository_id = {repository_id} request.merge_request_iid = {merge_request_iid} response = client.show_merge_request_comments_by_line(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsrepo "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartsrepo.CodeArtsRepoClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartsrepo.NewCodeArtsRepoClient(hcClient) request := &model.ShowMergeRequestCommentsByLineRequest{} request.RepositoryId = int32({repository_id}) request.MergeRequestIid = int32({merge_request_iid}) response, err := client.ShowMergeRequestCommentsByLine(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/sdk?api=ShowMergeRequestCommentsByLine&version=v4)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 获取合并请求文件变更页单个文件下的检视意见 | | 401 | Unauthorized | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeartsrepo/ErrorCode.html)。