文档首页/ 制品仓库 CodeArts Artifact/ API参考/ API/ 仓库详情/ 查询仓库详情,不会去统计仓库下的制品数量
更新时间:2024-08-06 GMT+08:00
分享

查询仓库详情,不会去统计仓库下的制品数量

功能介绍

查询仓库详情,不会去统计仓库下的制品数量

调用方法

请参见如何调用API

URI

GET /cloudartifact/v5/{tenant_id}/{project_id}/repositories

表1 路径参数

参数

是否必选

参数类型

描述

tenant_id

String

参数解释:

租户ID。

约束限制:

必传。

取值范围:

字符串长度不少于1。

默认取值:不涉及。

project_id

String

参数解释:

项目ID,对应"需求管理 CodeArts Req"项目唯一标识,私有依赖库首页地址栏url https://{host}/cloudartifact/project/{project_id}/repository中project_id变量的值。

约束限制:

必传。

取值范围:

字符串长度32。

默认取值:不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

group_id

String

参数解释:

用户组ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

page_no

Integer

参数解释:

查询获取仓库列表分页数量。

约束限制:

不涉及。

取值范围:

1~100000000。

默认取值:

1。

page_size

Integer

参数解释:

查询获取仓库列表分页后每一页展示的仓库数量。

约束限制:

不涉及。

取值范围:

1~100。

默认取值:

10。

sort

String

参数解释:

排序类型。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

qname

String

参数解释:

查询内容。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

type

String

参数解释:

仓库类型。

约束限制:

不涉及。

取值范围:

hosted,local,virtual,remote,proxy。

默认取值:

不涉及。

format

String

参数解释:

仓库格式。比如:maven2,docker,conan,debian,go等。只能指定某一种格式。

约束限制:

不涉及。

取值范围:

maven2,docker,conan,debian,go,nuget,rpm,pypi,npm,cocoapods,generic。

默认取值:

不涉及。

format_list

String

参数解释:

仓库格式列表。可以指定多种格式,格式之间用逗号分隔。

约束限制:

不涉及。

取值范围:

maven2,docker,conan,debian,go,nuget,rpm,pypi,npm,cocoapods,generic。

默认取值:

不涉及。

is_recycle_bin

Boolean

参数解释:

是否是回收站仓库。

约束限制:

不涉及。

取值范围:

true:查询回收站中仓库

false:查询活跃状态仓库

默认取值:

不涉及。

is_need_paging

Boolean

参数解释:

是否需要分页

约束限制:

不涉及。

取值范围:

true:需要分页

false:不分页

默认取值:

不涉及。

in_project

Boolean

是否在项目中。

约束限制:

不涉及。

取值范围:

true:项目中

false:不在项目中

默认取值:

不涉及。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求成功、失败状态。

取值范围:

success: 请求成功。

error:请求失败。

trace_id

String

参数解释:

请求id,当前请求唯一标识。

取值范围:

数字及中划线(-)组成的字符串。

result

Object

参数解释:

请求返回结果,接口不同,返回不同。

取值范围:

根据不同接口有不同范围。

请求示例

查询仓库详情,不会去统计仓库下的制品数量

https://artifact.cn-south-1.myhuaweicloud.com/cloudartifact/v5/00000000000000000000000000000000/00000000000000000000000000000000/repositories?in_project=true&format=&page_no=1&page_size=2&qname=&format_list=maven2,npm,go,pypi,rpm,debian,conan,nuget,docker&is_need_paging=true

响应示例

状态码: 200

OK

{
  "status" : "success",
  "trace_id" : "143006-1701221592150-283",
  "result" : {
    "total" : 183,
    "repositories" : [ {
      "id" : null,
      "name" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_conan_5",
      "description" : "1,0",
      "createdTime" : "2022-08-22 17:14:55",
      "createdUserId" : "e9253deb37654775bb3c411aca89153a",
      "createdUserName" : "devcloud_devcloud_y00226182_01",
      "modifiedTime" : "2023-10-16 20:05:59",
      "modifiedUserId" : "e9253deb37654775bb3c411aca89153a",
      "modifiedUserName" : "devcloud_devcloud_y00226182_01",
      "format" : "conan",
      "repoType" : "hosted",
      "includesPattern" : "**/*",
      "url" : "https://devrepo.devcloud.cn-north-7.ulanqab.huawei.com/artgalaxy/api/conan/cn-north-7_5a775fdcb14f4431b6c0015618140bc3_conan_5/",
      "storageSummaryInfo" : null,
      "projectId" : null,
      "shareRight" : null,
      "deploymentPolicy" : null,
      "repositoryName" : "5465653",
      "displayName" : null,
      "policy" : null,
      "tabId" : null,
      "status" : "active",
      "domainId" : "5a775fdcb14f4431b6c0015618140bc3",
      "region" : "cn-north-7",
      "uri" : null,
      "disable" : false,
      "packageType" : "conan"
    }, {
      "id" : null,
      "name" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_conan_6",
      "description" : "",
      "createdTime" : "2022-08-22 17:21:15",
      "createdUserId" : "e9253deb37654775bb3c411aca89153a",
      "createdUserName" : "devcloud_devcloud_y00226182_01",
      "modifiedTime" : "2023-10-16 20:05:59",
      "modifiedUserId" : null,
      "modifiedUserName" : "devcloud_devcloud_y00226182_01",
      "format" : "conan",
      "repoType" : "hosted",
      "includesPattern" : "**/*",
      "url" : "https://devrepo.devcloud.cn-north-7.ulanqab.huawei.com/artgalaxy/api/conan/cn-north-7_5a775fdcb14f4431b6c0015618140bc3_conan_6/",
      "storageSummaryInfo" : null,
      "projectId" : null,
      "shareRight" : null,
      "deploymentPolicy" : null,
      "repositoryName" : "12321",
      "displayName" : null,
      "policy" : null,
      "tabId" : null,
      "status" : "active",
      "domainId" : "5a775fdcb14f4431b6c0015618140bc3",
      "region" : "cn-north-7",
      "uri" : null,
      "disable" : false,
      "packageType" : "conan"
    } ]
  }
}

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.codeartsartifact.v2.region.CodeArtsArtifactRegion;
import com.huaweicloud.sdk.codeartsartifact.v2.*;
import com.huaweicloud.sdk.codeartsartifact.v2.model.*;


public class ListAllRepositoriesSolution {

    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);

        CodeArtsArtifactClient client = CodeArtsArtifactClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsArtifactRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAllRepositoriesRequest request = new ListAllRepositoriesRequest();
        request.withTenantId("{tenant_id}");
        request.withProjectId("{project_id}");
        try {
            ListAllRepositoriesResponse response = client.listAllRepositories(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 huaweicloudsdkcodeartsartifact.v2.region.codeartsartifact_region import CodeArtsArtifactRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsartifact.v2 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 = CodeArtsArtifactClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsArtifactRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAllRepositoriesRequest()
        request.tenant_id = "{tenant_id}"
        request.project_id = "{project_id}"
        response = client.list_all_repositories(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"
    codeartsartifact "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2/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 := codeartsartifact.NewCodeArtsArtifactClient(
        codeartsartifact.CodeArtsArtifactClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListAllRepositoriesRequest{}
	request.TenantId = "{tenant_id}"
	request.ProjectId = "{project_id}"
	response, err := client.ListAllRepositories(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档