获取合并请求文件变更列表树
功能介绍
获取合并请求文件变更列表树
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/changes-trees
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
merge_request_iid |
是 |
Integer |
参数解释: 合并请求 iid。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
approval_user_id |
否 |
Integer |
参数解释: 审核人ID。 |
commit_id |
是 |
String |
参数解释: commit ID。 取值范围: 字符串长度不少于1,不超过40。 |
from_diff_id |
否 |
Integer |
参数解释: 文件变更对比源版本id |
to_diff_id |
否 |
Integer |
参数解释: 文件变更对比目标版本id |
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of ChangesTreeDto objects |
合并请求文件变更列表详情 |
参数 |
参数类型 |
描述 |
---|---|---|
can_show_my_approval_files |
Boolean |
参数解释: 展示审核文件。 |
tree |
Array of ChangesTreeObjectDto objects |
参数解释: 变更树。 |
参数 |
参数类型 |
描述 |
---|---|---|
title |
String |
参数解释: 变更文件名。 |
level |
Integer |
参数解释: 文件层级。 |
file_path |
String |
参数解释: 文件路径。 |
file_type |
String |
参数解释: 文件类型。 |
diff |
ChangesTreeObjectDiffDto object |
参数解释: 文件变更对比。 |
items |
Array of ChangesTreeObjectDto objects |
参数解释: 子文件变更。 |
参数 |
参数类型 |
描述 |
---|---|---|
diff |
String |
参数解释: 变更内容。 |
new_path |
String |
参数解释: 变更新路径。 |
old_path |
String |
参数解释: 变更旧。 |
a_mode |
String |
参数解释: 旧文件权限。 |
b_mode |
String |
参数解释: 新文件权限。 |
new_file |
Boolean |
参数解释: 是否是新文件。 |
renamed_file |
Boolean |
参数解释: 是否是改名文件。 |
deleted_file |
Boolean |
参数解释: 是否是删除文件。 |
too_large |
Boolean |
参数解释: 是否内容过长。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
/v4/repositories/2111976239/merge-requests/6/changes
响应示例
状态码:200
OK
{ "can_show_my_approval_files" : null, "tree" : [ { "title" : "test2", "level" : 1, "file_path" : "test2", "file_type" : "file", "diff" : { "diff" : "", "new_path" : "test2", "old_path" : "test2", "a_mode" : "0", "b_mode" : "100644", "new_file" : true, "renamed_file" : false, "deleted_file" : false, "too_large" : false } } ] }
状态码:400
Bad Request
{ "error_code" : "CH.00405011", "error_msg" : "错误请求" }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
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.codehub.v4.region.CodeHubRegion; import com.huaweicloud.sdk.codehub.v4.*; import com.huaweicloud.sdk.codehub.v4.model.*; public class ListMergeRequestChangesTreesSolution { 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); CodeHubClient client = CodeHubClient.newBuilder() .withCredential(auth) .withRegion(CodeHubRegion.valueOf("<YOUR REGION>")) .build(); ListMergeRequestChangesTreesRequest request = new ListMergeRequestChangesTreesRequest(); request.withRepositoryId({repository_id}); request.withMergeRequestIid({merge_request_iid}); try { ListMergeRequestChangesTreesResponse response = client.listMergeRequestChangesTrees(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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodehub.v4.region.codehub_region import CodeHubRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodehub.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 = CodeHubClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListMergeRequestChangesTreesRequest() request.repository_id = {repository_id} request.merge_request_iid = {merge_request_iid} response = client.list_merge_request_changes_trees(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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codehub.NewCodeHubClient( codehub.CodeHubClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListMergeRequestChangesTreesRequest{} request.RepositoryId = int32({repository_id}) request.MergeRequestIid = int32({merge_request_iid}) response, err := client.ListMergeRequestChangesTrees(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。