# 获取合并请求文件变更列表 - ListMergeRequestChanges #### 功能介绍 获取合并请求文件变更列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/doc?api=ListMergeRequestChanges&version=v4)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codeartsrepo/codeartsrepo_05_0036.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsrepo:repository:getMergeRequest | Read | - | - | - | - | #### URI GET /v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/changes 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | repository_id | 是 | Integer | **参数解释：** 仓库的ID，通过[查询用户所有仓库](https://support.huaweicloud.com/api-codeartsrepo/ListUserAllRepositories.html)接口查询项目列表获取。 **约束限制：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | | merge_request_iid | 是 | Integer | **参数解释：** 合并请求 iid。 **取值范围：** 1\~2147483647 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ignore_whitespace_change | 否 | Boolean | **参数解释：** 是否忽略空白数量更改。 **取值范围：** - true，忽略空白数量的更改。 - false，不会忽略空白数量的更改。 **默认取值：** false | | force_encode | 否 | Boolean | **参数解释：** 是否强制将文件内容转码为utf-8 \*\*约束限制 \*\* - true, 强制将文件内容转码为utf-8。 - false, 不强制将文件内容转码为utf-8。 **默认取值：** false | | file_path | 是 | String | **参数解释：** 文件路径。 **取值范围：** 字符串长度不少于1，不超过10000。 | | from_diff_id | 否 | Integer | **参数解释：** 文件变更对比源版本id | | to_diff_id | 否 | Integer | **参数解释：** 文件变更对比目标版本id | | offset | 否 | Integer | **参数解释：** 偏移量，从0开始。 **取值范围：** 0\~2147483647 **默认取值：** 0 | | limit | 否 | Integer | **参数解释：** 返回数量。 **取值范围：** 1\~100 **默认取值：** 20 | #### 请求参数 表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响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-Total | String | **参数解释：** 文件变更列表的总数 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [SimpleMergeRequestChangesDto] objects | 合并请求文件变更列表详情 | 表6SimpleMergeRequestChangesDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | MR id | | repository_id | Integer | 仓库id | | title | String | 合并请求标题 | | description | String | 合并请求描述 | | state | String | 合并请求状态 | | source_branch | String | 合并请求源分支名 | | target_branch | String | 合并请求目标分支名 | | author | [UserBasicDto] object | 用户信息 | | web_url | String | 合并请求URL链接 | | create_at | String | 合并请求创建时间 | | update_at | String | 合并请求最后更新时间 | | sha | String | 当前变更对应的目标版本commitId | | change_count | Integer | 变更文件数量 | | diff_refs | [DiffRefDto] object | 合并请求变更commit，包含base_sha、start_sha、head_sha | | added_lines | Integer | 新增行 | | removed_lines | Integer | 删除行 | | changes | Array of [FileChangeDto] objects | 变更文件详情列表 | 表7UserBasicDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释：** 部分查询接口校验到传参里的用户权限不足或不存在时，返回该用户但该字段不为空用于提示。 | 表8FileChangeDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | file_path | String | 文件路径 | | old_path | String | 变更文件源分支路径 | | new_path | String | 变更文件目标分支路径 | | a_mode | String | 旧文件权限 | | b_mode | String | 新文件权限 | | mode_changed | Boolean | 文件权限是否变更 | | file_type | String | 文件类型 | | new_file | Boolean | 是否为新增文件 | | renamed_file | Boolean | 是否为重命名文件 | | deleted_file | Boolean | 是否为删除文件 | | diff | String | 变更文件内容 | | binary | Boolean | 是否为二进制文件 | | too_large | Boolean | 是否为大文件 | | collapsed | Boolean | 是否折叠文件 | | added_lines | Integer | 文件新增行 | | removed_lines | Integer | 文件删除行 | | content_sha | String | 文件最新commitId | | diff_refs | [DiffRefDto] object | 合并请求变更commit，包含base_sha、start_sha、head_sha | 表9DiffRefDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | base_sha | String | 目标分支以及源分支的共同祖先commitId | | head_sha | String | 源分支的最新commitId | | start_sha | String | 目标分支的最新commitId | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 | | error_msg | String | **参数解释：** 错误信息。 | **状态码：401** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 | | error_msg | String | **参数解释：** 错误信息。 | #### 请求示例 ``` /v4/repositories/2111976239/merge-requests/6/changes ``` #### 响应示例 **状态码：200** OK ``` { "id" : 61415, "repository_id" : 2111784689, "title" : "更新 dev", "description" : "merge \\\"dev\\\" into \\\"master\\\"\\n更新 dev", "state" : "opened", "source_branch" : "dev", "target_branch" : "master", "author" : { "id" : 10311, "name" : "repo_xuxu", "name_cn" : "repo_xuxu", "nick_name" : "repo_xx", "tenant_name" : "example_name", "username" : "e2dd5152774149298b749e245523bc78", "state" : "active", "email" : "e2dd5152774149298b749e245523bc78@example.com", "web_url" : "https://example.com/e2dd5152774149298b749e245523bc78" }, "web_url" : "https://example.com/yx_test_repo_yangxu00001/author_approval_test/merge_requests/12", "sha" : "7817fb2d9d65e64389ce4cebc542aa2948f45da5", "change_count" : 1, "diff_refs" : { "base_sha" : "ee792e378901e39008c6cbdd5bf01b056ba56e9b", "head_sha" : "7817fb2d9d65e64389ce4cebc542aa2948f45da5", "start_sha" : "283ae4a61aefac2c6c559544ca2af6d1a85ee02b" }, "added_lines" : null, "removed_lines" : null, "changes" : [ { "file_path" : "dev", "old_path" : "dev", "new_path" : "dev", "a_mode" : 33188, "b_mode" : 33188, "mode_changed" : false, "file_type" : "text_type", "new_file" : false, "renamed_file" : false, "deleted_file" : false, "diff" : "@@ -1,3 +1,3 @@\\n-dev1111\\n+dev11112222222333\\n", "binary" : false, "too_large" : false, "collapsed" : false, "added_lines" : 1, "removed_lines" : 1, "content_sha" : "7817fb2d9d65e64389ce4cebc542aa2948f45da5", "diff_refs" : { "base_sha" : "ee792e378901e39008c6cbdd5bf01b056ba56e9b", "head_sha" : "7817fb2d9d65e64389ce4cebc542aa2948f45da5", "start_sha" : "283ae4a61aefac2c6c559544ca2af6d1a85ee02b" } } ], "create_at" : "2025-02-18T15:20:50.000+08:00", "update_at" : "2025-02-26T14:45:45.000+08:00" } ``` **状态码：400** Bad Request ``` { "error_code" : "CH.00405011", "error_msg" : "错误请求" } ``` **状态码：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 ListMergeRequestChangesSolution { 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(); ListMergeRequestChangesRequest request = new ListMergeRequestChangesRequest(); request.withRepositoryId({repository_id}); request.withMergeRequestIid({merge_request_iid}); try { ListMergeRequestChangesResponse response = client.listMergeRequestChanges(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 = ListMergeRequestChangesRequest() request.repository_id = {repository_id} request.merge_request_iid = {merge_request_iid} response = client.list_merge_request_changes(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.ListMergeRequestChangesRequest{} request.RepositoryId = int32({repository_id}) request.MergeRequestIid = int32({merge_request_iid}) response, err := client.ListMergeRequestChanges(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=ListMergeRequestChanges&version=v4)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeartsrepo/ErrorCode.html)。