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

统筹搜索

功能介绍

统筹搜索

调用方法

请参见如何调用API

URI

POST /cloudartifact/v5/tree/repos/artifacts

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

artifact_name

String

参数解释:

搜索制品名称。

约束限制:

最大长度200。

取值范围:

不涉及。

默认取值:

无。

artifact_type

String

参数解释:

制品类型。

约束限制:

不涉及。

取值范围:

允许的类型为: maven2|npm|go|pypi|rpm|composer|debian|conan|nuget|docker2|cocoapods|ohpm。

默认取值:

不涉及。

page_no

Integer

参数解释:

分页查询的页数。

约束限制:

不涉及。

取值范围:

最小值1,最大值2147483647。

默认取值:

1

page_size

Integer

参数解释:

分页查询的每页数据量。

约束限制:

不涉及。

取值范围:

最小值1,最大值100。

默认取值:

10

project_id

String

参数解释:

项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参考获取项目ID

约束限制:

只能由英文字母、数字组成,且长度为32个字符。参数in_project值为true值时此参数生效。

取值范围:

不涉及。

默认取值:

无。

in_project

Boolean

参数解释:

是否在项目中,值为true,project_id有值时,查询指定项目数据;project_id无值时,查询当前账号所有项目数据。值为false或不传值时查询当前租户下未关联项目的仓库数据。

约束限制:

不涉及。

取值范围:

true or false。

默认取值:

不涉及。

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求成功、失败状态。

取值范围:

success:请求成功。

error:请求失败。

trace_id

String

参数解释:

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

取值范围:

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

result

SearchArtifactsResult object

参数解释:

文件列表。

取值范围:

不涉及。

表3 SearchArtifactsResult

参数

参数类型

描述

artifacts

Array of ArtifactSearchResult objects

参数解释:

文件列表。

取值范围:

不涉及。

表4 ArtifactSearchResult

参数

参数类型

描述

name

String

参数解释:

文件名。

取值范围:

不涉及。

relativePath

String

参数解释:

文件相对路径。

取值范围:

不涉及。

repo

String

参数解释:

仓库id。

取值范围:

不涉及。

repoName

String

参数解释:

仓库名。

取值范围:

不涉及。

displayName

String

参数解释:

展示名称。

取值范围:

不涉及。

repoType

String

参数解释:

制品类型。

取值范围:

不涉及。

createdBy

String

参数解释:

创建人id。

取值范围:

不涉及。

createdUserName

String

参数解释:

创建人名字。

取值范围:

不涉及。

created

String

参数解释:

创建时间。

取值范围:

不涉及。

modified

String

参数解释:

修改时间。

取值范围:

不涉及。

oldRepoId

String

参数解释:

旧仓库id。

取值范围:

不涉及。

请求示例

统筹搜索

https://artifact.cn-south-1.myhuaweicloud.com/cloudartifact/v5/tree/repos/artifacts

{
  "artifact_name" : "mod.txt",
  "artifact_type" : "pypi",
  "page_no" : 1,
  "page_size" : 10,
  "project_id" : "e2ee90487d6349dd944a5767225f6f55",
  "in_project" : true
}

响应示例

状态码:200

OK

{
  "status" : "success",
  "trace_id" : "143002-1701221035715-403",
  "result" : {
    "artifacts" : [ {
      "name" : "mod.txt",
      "relativePath" : "1/1/mod.txt",
      "createdBy" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_e9253deb37654775bb3c411aca89153a",
      "createdUserName" : "devcloud_devcloud_y00226182_01",
      "created" : "1701220753711",
      "modified" : "2023-11-29T09:19:13.711+08:00",
      "repo" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_pypi_40",
      "repoName" : "testpypi",
      "displayName" : null,
      "oldRepoId" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_pypi_40",
      "repoType" : "pypi"
    } ]
  }
}

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
48
49
50
51
52
53
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 SearchArtifactsSolution {

    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();
        SearchArtifactsRequest request = new SearchArtifactsRequest();
        IDERepoSearchDO body = new IDERepoSearchDO();
        body.withInProject("true");
        body.withProjectId("e2ee90487d6349dd944a5767225f6f55");
        body.withPageSize(10);
        body.withPageNo(1);
        body.withArtifactType("pypi");
        body.withArtifactName("mod.txt");
        request.withBody(body);
        try {
            SearchArtifactsResponse response = client.searchArtifacts(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
33
34
35
36
37
38
# 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 = SearchArtifactsRequest()
        request.body = IDERepoSearchDO(
            in_project="true",
            project_id="e2ee90487d6349dd944a5767225f6f55",
            page_size=10,
            page_no=1,
            artifact_type="pypi",
            artifact_name="mod.txt"
        )
        response = client.search_artifacts(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
38
39
40
41
42
43
44
45
46
47
48
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.SearchArtifactsRequest{}
	inProjectIdeRepoSearchDo:= "true"
	projectIdIdeRepoSearchDo:= "e2ee90487d6349dd944a5767225f6f55"
	pageSizeIdeRepoSearchDo:= int32(10)
	pageNoIdeRepoSearchDo:= int32(1)
	artifactTypeIdeRepoSearchDo:= "pypi"
	request.Body = &model.IdeRepoSearchDo{
		InProject: &inProjectIdeRepoSearchDo,
		ProjectId: &projectIdIdeRepoSearchDo,
		PageSize: &pageSizeIdeRepoSearchDo,
		PageNo: &pageNoIdeRepoSearchDo,
		ArtifactType: &artifactTypeIdeRepoSearchDo,
		ArtifactName: "mod.txt",
	}
	response, err := client.SearchArtifacts(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

错误码

请参见错误码