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

获取仓库动态

功能介绍

获取仓库动态(当前仅开放推送动态)

调试

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

URI

GET /v4/repositories/{repository_id}/events

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

author_id

Integer

参数解释:

操作者id。

取值范围:

1-2147483647

filter

String

参数解释:

动态类型。

约束限制:

  • all,表示全部。

  • push,表示推送。

默认取值:

all

枚举值:

  • all

  • push

before

String

参数解释:

开始日期。

after

String

参数解释:

结束日期。

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 响应Header参数

参数

参数类型

描述

X-Total

String

参数解释:

当前请求的结果总条数。

表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of RepositoryPushEventDto objects

参数解释:

推送动态。

表6 RepositoryPushEventDto

参数

参数类型

描述

action_name

String

参数解释:

操作名称。

  • pushed to,表示推送。

  • pushed new,表示推送并新建。

  • deleted,表示删除。

枚举值:

  • pushed to

  • pushed new

  • deleted

author

RepositoryEventAuthorDto object

参数解释:

触发者信息。

author_id

Integer

参数解释:

触发者ID。

取值范围:

1-2147483647

author_username

String

参数解释:

触发者名称。

created_at

String

参数解释:

创建时间。

repository_id

Integer

参数解释:

仓库ID。

取值范围:

1-2147483647

repository_name

String

参数解释:

仓库名。

push_data

PushEventPayloadDto object

参数解释:

推送信息。

表7 RepositoryEventAuthorDto

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

1-2147483647

name

String

参数解释:

用户名称。

username

String

参数解释:

用户名。

state

String

参数解释:

用户状态。

取值范围:

  • active,激活。

  • blocked,禁用。

枚举值:

  • active

  • blocked

avatar_url

String

参数解释:

头像地址。

name_cn

String

参数解释:

中文名。

nick_name

String

参数解释:

昵称。

tenant_name

String

参数解释:

租户名。

表8 PushEventPayloadDto

参数

参数类型

描述

commit_count

Integer

参数解释:

提交数量。

取值范围:

1-2147483647

action

String

参数解释:

操作类型。

ref_type

String

参数解释:

ref类型。

commit_from

String

参数解释:

源Commit。

commit_to

String

参数解释:

目标Commit。

ref

String

参数解释:

分支。

commit_title

String

参数解释:

提交标题。

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:404

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/10001/events

响应示例

状态码:200

仓库动态列表

[ {
  "action_name" : "pushed new",
  "author" : {
    "id" : 9124,
    "name" : "dev_test",
    "username" : "c369c68f1ff84679b5a8ed904d8bff1c",
    "state" : "active",
    "avatar_url" : "",
    "name_cn" : "dev_test",
    "nick_name" : "dev",
    "tenant_name" : "test_tenant"
  },
  "author_id" : 9124,
  "author_username" : "c369c68f1ff84679b5a8ed904d8bff1c",
  "created_at" : "2024-08-21T06:21:22.000Z",
  "repository_id" : 2111694664,
  "repository_name" : "lhtest00002/RepoProtal",
  "push_data" : {
    "commit_count" : 0,
    "action" : "created",
    "ref_type" : "branch",
    "commit_from" : null,
    "commit_to" : "17933c207b320a74dc10af80e0d9d9720a90dd5e",
    "ref" : "asdsada#fasdasda",
    "commit_title" : null
  }
} ]

状态码:401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "未识别到用户认证信息"
}

状态码:403

Bad Request

{
  "error_code" : "CH.00401008",
  "error_msg" : "您没有操作权限,请升级权限后重试。"
}

状态码:404

Not Found

{
  "error_code" : "CH.00402000",
  "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
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 ListRepositoryEventsSolution {

    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();
        ListRepositoryEventsRequest request = new ListRepositoryEventsRequest();
        request.withRepositoryId({repository_id});
        try {
            ListRepositoryEventsResponse response = client.listRepositoryEvents(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
# 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 = ListRepositoryEventsRequest()
        request.repository_id = {repository_id}
        response = client.list_repository_events(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
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.ListRepositoryEventsRequest{}
	request.RepositoryId = int32({repository_id})
	response, err := client.ListRepositoryEvents(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

仓库动态列表

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码

相关文档