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

获取仓库Fork列表

功能介绍

获取仓库Fork列表

调试

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

URI

GET /v4/repositories/{repository_id}/forks

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

偏移量,从0开始。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

参数解释:

返回数量。

取值范围:

1-100

默认取值:

20

order_by

String

参数解释:

排序字段。

约束限制:

必须为枚举值中的选项。

取值范围:

  • created_at,创建时间。

  • updated_at,更新时间。

默认取值:

created_at。

默认取值:

created_at

枚举值:

  • created_at

  • updated_at

sort

String

参数解释:

排列顺序。

约束限制:

必须为枚举值中的选项。

取值范围:

  • asc

  • desc

默认取值:

desc。

默认取值:

desc

枚举值:

  • asc

  • desc

view

String

参数解释:

视图。

约束限制:

必须为枚举值中的选项。

取值范围:

  • basic,基本信息。

  • least,最简信息。

默认取值:

least。

默认取值:

least

枚举值:

  • basic

  • least

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ForkRepositoryDto objects

仓库信息

表5 ForkRepositoryDto

参数

参数类型

描述

id

Integer

参数解释:

仓库ID。

约束限制:

不涉及。

取值范围:

1-2147483647

name

String

参数解释:

仓库名称。

约束限制:

不涉及。

archived

Boolean

参数解释:

是否归档。

约束限制:

不涉及。

product_id

String

参数解释:

产品ID。

约束限制:

不涉及。

product_name

String

参数解释:

产品名称。

约束限制:

不涉及。

path_with_namespace

String

参数解释:

带命名空间的仓库路径。

约束限制:

view=least时返回

namespace

String

参数解释:

命名空间。

约束限制:

view=basic时返回

path

String

参数解释:

仓库路径。

约束限制:

view=basic时返回

develop_mode

String

参数解释:

开发模式。

约束限制:

view=basic时返回

visibility

String

参数解释:

可见性。

约束限制:

view=basic时返回

security

String

参数解释:

安全级别。

约束限制:

view=basic时返回

star_count

Integer

参数解释:

关注数。

约束限制:

view=basic时返回

取值范围:

1-2147483647

forks_count

Integer

参数解释:

Fork数。

约束限制:

view=basic时返回

取值范围:

1-2147483647

open_merge_requests_count

Integer

参数解释:

开启的合并请求数。

约束限制:

view=basic时返回

取值范围:

1-2147483647

starred

Boolean

参数解释:

是否已关注。

约束限制:

view=basic时返回

name_with_namespace

String

参数解释:

带命名空间的仓库名称。

约束限制:

view=basic时返回

last_activity_at

String

参数解释:

最后活动时间。

约束限制:

view=basic时返回

created_at

String

参数解释:

创建时间。

约束限制:

view=basic时返回

请求示例

响应示例

状态码:200

仓库信息

[ {
  "id" : 2111851926,
  "path_with_namespace" : "41bcec7bf2c84efea690e987ca98ee40/test",
  "name" : "test",
  "product_id" : "41bcec7bf2c84efea690e987ca98ee40",
  "product_name" : "lhtest",
  "archived" : false
}, {
  "id" : 2111965407,
  "path_with_namespace" : "41bcec7bf2c84efea690e987ca98ee40/222",
  "name" : "222",
  "product_id" : "41bcec7bf2c84efea690e987ca98ee40",
  "product_name" : "lhtest",
  "archived" : false
} ]

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 ListRepositoryForksSolution {

    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();
        ListRepositoryForksRequest request = new ListRepositoryForksRequest();
        request.withRepositoryId({repository_id});
        try {
            ListRepositoryForksResponse response = client.listRepositoryForks(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 = ListRepositoryForksRequest()
        request.repository_id = {repository_id}
        response = client.list_repository_forks(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.ListRepositoryForksRequest{}
	request.RepositoryId = int32({repository_id})
	response, err := client.ListRepositoryForks(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

仓库信息

错误码

请参见错误码

相关文档