# 获取仓库Fork列表 - ListRepositoryForks #### 功能介绍 获取仓库Fork列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/doc?api=ListRepositoryForks&version=v4)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codeartsrepo/codeartsrepo_05_0036.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsrepo:repository:getRepository | Read | - | - | - | - | #### URI GET /v4/repositories/{repository_id}/forks 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | repository_id | 是 | Integer | **参数解释：** 仓库的ID，通过[查询用户所有仓库](https://support.huaweicloud.com/api-codeartsrepo/ListUserAllRepositories.html)接口查询项目列表获取。 **约束限制：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释：** 偏移量，从0开始。 **取值范围：** 0\~2147483647 **默认取值：** 0 | | limit | 否 | Integer | **参数解释：** 返回数量。 **取值范围：** 1\~100 **默认取值：** 20 | | order_by | 否 | String | **参数解释：** 排序字段。 **约束限制：** 必须为枚举值中的选项。 **取值范围：** - created_at，创建时间。 - updated_at，更新时间。 **默认取值：** created_at。 **默认取值：** created_at | | sort | 否 | String | **参数解释：** 排列顺序。 **约束限制：** 必须为枚举值中的选项。 **取值范围：** - asc - desc **默认取值：** desc。 **默认取值：** desc | | view | 否 | String | **参数解释：** 视图。 **约束限制：** 必须为枚举值中的选项。 **取值范围：** - basic，基本信息。 - least，最简信息。 **默认取值：** least。 **默认取值：** least | #### 请求参数 表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响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [ForkRepositoryDto] objects | 仓库信息 | 表5ForkRepositoryDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 ``` 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 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); CodeArtsRepoClient client = CodeArtsRepoClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsRepoRegion.valueOf("")) .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 ``` # 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 = 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 ``` 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.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](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/sdk?api=ListRepositoryForks&version=v4)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 仓库信息 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeartsrepo/ErrorCode.html)。