Updated on 2026-01-22 GMT+08:00

Advanced Search

Function

Advanced search.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsartifact:repository:list

List

-

-

-

-

URI

POST /cloudartifact/v5/tree/repos/artifacts

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

artifact_name

Yes

String

Definition

Search by artifact name.

Constraints

Maximum length: 200 characters.

Range

N/A.

Default value

None

artifact_type

No

String

Definition

Package type.

Constraints

N/A.

Range

maven2, npm, go, pypi, rpm, composer, debian, conan, nuget, docker2, cocoapods, and ohpm.

Default value

N/A.

page_no

No

Integer

Definition

Number of pages in a pagination query.

Constraints

N/A.

Range

1–2,147,483,647

Default value

1

page_size

No

Integer

Definition

Number of records on each page during the pagination query.

Constraints

N/A.

Range

1–100

Default value

10

project_id

No

String

Definition

Project ID, which can be obtained by calling an API or from the console. For details about how to obtain the project ID, see Obtaining a Project ID (CloudArtifact_api_0015.xml).

Constraints

The value contains 32 characters. Only letters and digits are supported. This parameter is valid only when in_project is set to true.

Range

N/A.

Default value

None

in_project

No

Boolean

Definition

Whether the repository to query is in a project. If the value is true and project_id is specified, the queried repository is in a project. If project_id is not specified, the queried repository is outside of the project. If the value is false or not transferred, the repository data of the unassociated project of the current tenant is queried.

Constraints

N/A.

Range

true and false.

Default value

N/A.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

status

String

Definition

Request status.

Range

success: The request is successful.

error: The request fails.

trace_id

String

Definition

Request ID, which uniquely identifies the current request.

Range

A string of digits and hyphens (-).

result

SearchArtifactsResult object

Definition

File list.

Range

N/A.

Table 3 SearchArtifactsResult

Parameter

Type

Description

artifacts

Array of ArtifactSearchResult objects

Definition

File list.

Range

N/A.

Table 4 ArtifactSearchResult

Parameter

Type

Description

name

String

Definition

File name.

Range

N/A.

relativePath

String

Definition

Relative file path.

Range

N/A.

repo

String

Definition

Repository ID.

Range

N/A.

repoName

String

Definition

Repository name.

Range

N/A.

displayName

String

Definition

Display name.

Range

N/A.

repoType

String

Definition

Package type.

Range

N/A.

createdBy

String

Definition

Creator ID.

Range

N/A.

createdUserName

String

Definition

Creator name.

Range

N/A.

created

String

Definition

Creation time.

Range

N/A.

modified

String

Definition

Modification time.

Range

N/A.

oldRepoId

String

Definition

Old repository ID.

Range

N/A.

Example Requests

Advanced search.

https://artifact.example-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
}

Example Responses

Status code: 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 Sample Code

The SDK sample code is as follows.

Java

Advanced search.

 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

Advanced search.

 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

Advanced search.

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

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.