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 2025-12-05 GMT+08:00
View PDF

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.

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.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."
}

Status Codes

Status Code

Description

200

OK

403

Forbidden

500

Internal Error

Error Codes

See Error Codes.