更新时间:2025-08-20 GMT+08:00
分享

获取提交差异

功能介绍

获取提交差异

调试

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

URI

GET /v4/repositories/{repository_id}/repository/commits/diff

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

sha

String

参数解释:

分支名、tag名、提交ID。

ignore_whitespace_change

Boolean

参数解释:

是否忽略空白数量更改。

取值范围:

  • true,忽略空白数量的更改。

  • false,不会忽略空白数量的更改。

默认取值:

false

not_statistic

Boolean

参数解释:

是否返回统计数量。

取值范围:

  • true,不返回统计数量。

  • false,返回统计数量。

默认取值:

false

offset

Integer

参数解释:

偏移量,从0开始。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

参数解释:

返回数量。

取值范围:

1-100

默认取值:

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

diffs

Array of DiffNoLineDto objects

参数解释:

差异信息。

取值范围:

不涉及。

diff_refs

DiffRefsDto object

参数解释:

差异ref信息。

取值范围:

不涉及。

added_lines

Integer

参数解释:

增加行数。

取值范围:

不涉及。

removed_lines

Integer

参数解释:

删除行数。

取值范围:

不涉及。

change_file_count

Integer

参数解释:

更改文件数目。

取值范围:

不涉及。

change_line_count

Integer

参数解释:

更改行数。

取值范围:

不涉及。

too_large

Boolean

参数解释:

是否过大。

取值范围:

  • true,大文件。

  • false,非大文件

表5 DiffNoLineDto

参数

参数类型

描述

old_path

String

旧文件

new_path

String

新文件

a_mode

String

旧文件类型

b_mode

String

新文件类型

file_path

String

文件路径

new_file

Boolean

是否新增

file_type

String

文件类型

renamed_file

Boolean

是否重命名

deleted_file

Boolean

是否删除文件

diff

String

比较结果

binary

Boolean

是否二进制

too_large

Boolean

是否过大

collapsed

Boolean

是否折叠

added_lines

Integer

增加行数

取值范围:

1-2147483647

removed_lines

Integer

删除行数

取值范围:

1-2147483647

表6 DiffRefsDto

参数

参数类型

描述

base_sha

String

参数解释:

目标分支的基准提交哈希。

取值范围:

不涉及。

head_sha

String

参数解释:

源分支的最新提交哈希。

取值范围:

不涉及。

start_sha

String

参数解释:

合并请求开始时的提交哈希,通常与base_sha相同。

取值范围:

不涉及。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

响应示例

状态码:200

ok

{
  "added_lines" : 0,
  "removed_lines" : 0,
  "diffs" : null,
  "change_file_count" : 0,
  "change_line_count" : 0,
  "too_large" : false,
  "diff_refs" : {
    "base_sha" : "360fc59f6ed8e90b8fa52dd4d31e65d966dc763d",
    "head_sha" : "d315e5f6dc66cdc7377dc65b14a835f153b6406c",
    "start_sha" : "360fc59f6ed8e90b8fa52dd4d31e65d966dc763d"
  }
}

状态码: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
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.v3.region.CodeHubRegion;
import com.huaweicloud.sdk.codehub.v3.*;
import com.huaweicloud.sdk.codehub.v3.model.*;


public class ShowDiffCommitSolution {

    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();
        ShowDiffCommitRequest request = new ShowDiffCommitRequest();
        try {
            ShowDiffCommitResponse response = client.showDiffCommit(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodehub.v3.region.codehub_region import CodeHubRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodehub.v3 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 = ShowDiffCommitRequest()
        response = client.show_diff_commit(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v3/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.ShowDiffCommitRequest{}
	response, err := client.ShowDiffCommit(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

ok

401

Unauthorized

错误码

请参见错误码

相关文档