Help Center/ CodeArts Artifact/ API Reference/ API/ Querying Files in the Release Repos/ Obtaining the File Version List in a Project (to Be Brought Offline)
Updated on 2026-01-22 GMT+08:00

Obtaining the File Version List in a Project (to Be Brought Offline)

Function

Obtain the file version list in a project (to be brought offline).

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:releaseRepo:read

Read

-

-

-

-

URI

GET /devreposerver/v2/release/{project_id}/files

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID, which uniquely identifies a CodeArts Req project. The value is the same as that of project_id in the URL https://{host}/cloudartifact/project/{project_id}/repository on the list page of self-hosted repos.

Constraints:

N/A

Value range:

The value can contain 1 to 32 characters. Only lowercase letters and digits are supported.

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

file_name

Yes

String

Definition:

File name used for fuzzy search.

Constraints:

N/A

Value range:

The value can contain 1 to 200 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are supported.

Default value:

N/A

limit

No

Integer

Definition:

Number of records displayed on each page.

Constraints:

N/A

Value range:

1–100

Default value:

10

offset

No

Integer

Definition:

Start position of the pagination query.

Constraints:

N/A

Value range:

Greater than 0

Default value:

0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

Definition:

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

N/A

Value range:

A string of 1 to 100,000 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

result

result object

Definition

Returned information.

Range

N/A.

Default value

None

Table 5 result

Parameter

Type

Description

data

Array of ReleaseFileVersionDo objects

Definition

List of results that match the search criteria.

Range

N/A.

Default value

None

total_records

Integer

Definition

Total number of results that match the search criteria.

Range

1–1000

Default value

None

total_pages

Integer

Definition

Total number of pages that match the search criteria.

Range

1–10,000

Default value

None

Table 6 ReleaseFileVersionDo

Parameter

Type

Description

version

String

Definition

File version in release repos.

Range

A string of 0 to 100 characters.

Default value

None

path

String

Definition

File path in release repos.

Range

A string of 0 to 100 characters.

Default value

None

download_url

String

Definition

File download link in release repos.

Range

A string of 0 to 10,000 characters.

Default value

None

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

200–599

Default value

None

error_msg

String

Definition

Error message.

Range

N/A.

Default value

None

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

200–599

Default value

None

error_msg

String

Definition

Error message.

Range

N/A.

Default value

None

Example Requests

https:// artifact.example-1.myhuaweicloud.com /devreposerver/v2/release/11111111111111111111111111111111/files? file_name=myFile&limit=10&offset=1

Example Responses

Status code: 403

Forbidden

{
  "error_code" : "CR.4102",
  "error_msg" : "You do not have permissions on the project."
}

Status code: 500

Internal Error

{
  "error_code" : "CR.5000",
  "error_msg" : "Unknown service error."
}

SDK Sample Code

The SDK sample code is as follows.

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


public class ShowReleaseProjectFilesSolution {

    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();
        ShowReleaseProjectFilesRequest request = new ShowReleaseProjectFilesRequest();
        request.withProjectId("{project_id}");
        try {
            ShowReleaseProjectFilesResponse response = client.showReleaseProjectFiles(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 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 = ShowReleaseProjectFilesRequest()
        request.project_id = "{project_id}"
        response = client.show_release_project_files(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"
    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.ShowReleaseProjectFilesRequest{}
	request.ProjectId = "{project_id}"
	response, err := client.ShowReleaseProjectFiles(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

403

Forbidden

500

Internal Error

Error Codes

See Error Codes.