Updated on 2025-09-08 GMT+08:00

Querying the File or Project List

Function

Query the file or project list.

Calling Method

For details, see Calling APIs.

URI

POST /devreposerver/v5/files/list

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

page_no

No

Integer

Definition:

Number of pages in a pagination query.

Constraints:

N/A

Value 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

Value range:

1–100

Default value:

10

parent_id

No

String

Definition:

Parent directory ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

No

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 up to 32 characters. Only lowercase letters and digits are supported.

Default value:

N/A

search_name

No

String

Definition:

Keyword searching.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

search_type

No

String

Definition:

Search type.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

extension

No

String

Definition:

Suffix.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

order_by

No

String

Definition:

Sorting field.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

sort

No

String

Definition:

Sorting order.

Constraints:

N/A

Value range:

Ascending or descending.

Default value:

N/A

status

No

String

Definition:

File status.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

category

No

String

Definition:

Release package status.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

status

String

Definition:

Request status.

Value range:

success: The request is successful.

error: The request fails.

trace_id

String

Definition:

Request ID, which uniquely identifies the current request.

Value range:

A string of digits and hyphens (-).

result

RepoFileDOV5Page object

Definition:

File list.

Value range:

N/A

Table 3 RepoFileDOV5Page

Parameter

Type

Description

total_records

Integer

Definition:

Total number of records.

Value range:

N/A

total_pages

Integer

Definition:

Total number of pages.

Value range:

N/A

data

Array of RepoFileDOV5 objects

Definition:

File list.

Value range:

N/A

Table 4 RepoFileDOV5

Parameter

Type

Description

id

String

Definition:

ID.

Value range:

N/A

file_id

String

Definition:

File ID.

Value range:

N/A

repo_name

String

Definition:

Repository ID.

Value range:

N/A

project_name

String

Definition:

Project name.

Value range:

N/A

parent_id

String

Definition:

Parent directory ID.

Value range:

N/A

name

String

Definition:

File name.

Value range:

N/A

file_name

String

Definition:

File name.

Value range:

N/A

type

String

Definition:

File type. folder indicates a directory, and file indicates a file.

Value range:

N/A

category

String

Definition:

Release package status. test indicates a test package, and prod indicates a release package.

Value range:

N/A

extension

String

Definition:

File name extension.

Value range:

N/A

path

String

Definition:

File path.

Value range:

N/A

full_path

String

Definition:

File path (including the project).

Value range:

N/A

size

Long

Definition:

File size (in bytes).

Value range:

N/A

md5

String

Definition:

MD5.

Value range:

N/A

sha256

String

Definition:

SHA-256.

Value range:

N/A

download_url

String

Definition:

Download address.

Value range:

N/A

download_url_with_id

String

Definition:

Download address with an ID.

Value range:

N/A

web_url

String

Definition:

web_url.

Value range:

N/A

version_enable

Boolean

Definition:

version_enable.

Value range:

N/A

migrated_state

Integer

Definition:

migrated_state.

Value range:

N/A

upload_id

String

Definition:

upload_id.

Value range:

N/A

Example Requests

Query the file or project list.

https://{URL}/devreposerver/v5/files/list

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "trace_id" : "0d7af913dfb4462db4580fc486d91ce1",
  "result" : {
    "data" : [ {
      "region" : "xx-xxxxx-x",
      "id" : "",
      "name" : "testjk1",
      "type" : "project",
      "created_time" : "2025-07-04 16:17:17",
      "modified_time" : "2025-07-04 16:17:17",
      "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "created_user_name" : "devcloud_devcloud_y00226182_05",
      "created_user_nick_name" : "Repository helper",
      "created_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "modified_user_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_nick_name" : "Repository helper",
      "modified_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "project_id" : "8de56c5a10894ad3aaef9e6558f17ea3",
      "repo_name" : "xx-xxxxx-x_8de56c5a10894ad3aaef9e6558f17ea3_generic_0",
      "parent_id" : "0",
      "download_url_with_id" : "DevRepoServer/v1/files/download?file_id=null&type=archive",
      "web_url" : "releaseman/project/8de56c5a10894ad3aaef9e6558f17ea3/private/general?parentId=0",
      "version_enable" : false,
      "migrated_state" : 0,
      "repo_same_trash_file_name" : "trash_null_testjk1",
      "repo_file_path" : "nulltestjk1"
    }, {
      "region" : "xx-xxxxx-x",
      "id" : "",
      "name" : "Scrum-yc",
      "type" : "project",
      "created_time" : "2025-07-04 16:06:32",
      "modified_time" : "2025-07-04 16:06:32",
      "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "created_user_name" : "devcloud_devcloud_y00226182_05",
      "created_user_nick_name" : "Repository helper",
      "created_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "modified_user_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_nick_name" : "Repository helper",
      "modified_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "project_id" : "4fad59a4d2be49039f2f18724a57dbff",
      "repo_name" : "xx-xxxxx-x_4fad59a4d2be49039f2f18724a57dbff_generic_0",
      "parent_id" : "0",
      "download_url_with_id" : "DevRepoServer/v1/files/download?file_id=null&type=archive",
      "web_url" : "releaseman/project/4fad59a4d2be49039f2f18724a57dbff/private/general?parentId=0",
      "version_enable" : false,
      "migrated_state" : 0,
      "repo_same_trash_file_name" : "trash_null_Scrum-yc",
      "repo_file_path" : "nullScrum-yc"
    }, {
      "region" : "xx-xxxxx-x",
      "id" : "",
      "name" : "wwy2",
      "type" : "project",
      "created_time" : "2025-06-27 16:05:41",
      "modified_time" : "2025-06-27 16:05:41",
      "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "created_user_name" : "devcloud_devcloud_y00226182_05",
      "created_user_nick_name" : "Repository helper",
      "created_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "modified_user_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_nick_name" : "Repository helper",
      "modified_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "project_id" : "782ac1a952164acdb6d37924fae0828d",
      "repo_name" : "xx-xxxxx-x_782ac1a952164acdb6d37924fae0828d_generic_0",
      "parent_id" : "0",
      "download_url_with_id" : "DevRepoServer/v1/files/download?file_id=null&type=archive",
      "web_url" : "releaseman/project/782ac1a952164acdb6d37924fae0828d/private/general?parentId=0",
      "version_enable" : false,
      "migrated_state" : 0,
      "repo_same_trash_file_name" : "trash_null_wwy2",
      "repo_file_path" : "nullwwy2"
    }, {
      "region" : "xx-xxxxx-x",
      "id" : "",
      "name" : "330 patch version.",
      "type" : "project",
      "created_time" : "2025-06-16 15:28:35",
      "modified_time" : "2025-06-16 15:28:35",
      "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "created_user_name" : "devcloud_devcloud_y00226182_05",
      "created_user_nick_name" : "Repository helper",
      "created_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "modified_user_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_nick_name" : "Repository helper",
      "modified_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "project_id" : "27edc4a6f5364d4bbe195ee5c046c581",
      "repo_name" : "xx-xxxxx-x_27edc4a6f5364d4bbe195ee5c046c581_generic_0",
      "parent_id" : "0",
      "download_url_with_id" : "DevRepoServer/v1/files/download?file_id=null&type=archive",
      "web_url" : "releaseman/project/27edc4a6f5364d4bbe195ee5c046c581/private/general?parentId=0",
      "version_enable" : false,
      "migrated_state" : 0,
      "repo_same_trash_file_name" : "trash_null_330 patch version",
      "repo_file_path" : "null330%E8%A1%A5%E4%B8%81%E7%89%88%E6%9C%AC"
    }, {
      "region" : "xx-xxxxx-x",
      "id" : "",
      "name" : "Version test.",
      "type" : "project",
      "created_time" : "2025-04-14 11:04:16",
      "modified_time" : "2025-04-14 11:04:16",
      "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "created_user_name" : "devcloud_devcloud_y00226182_05",
      "created_user_nick_name" : "Repository helper",
      "created_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "modified_user_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_nick_name" : "Repository helper",
      "modified_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "project_id" : "9202db82a84c4dac9313ea8df0f2a2d4",
      "repo_name" : "xx-xxxxx-x_9202db82a84c4dac9313ea8df0f2a2d4_generic_0",
      "parent_id" : "0",
      "download_url_with_id" : "DevRepoServer/v1/files/download?file_id=null&type=archive",
      "web_url" : "releaseman/project/9202db82a84c4dac9313ea8df0f2a2d4/private/general?parentId=0",
      "version_enable" : false,
      "migrated_state" : 0,
      "repo_same_trash_file_name" : "trash_null_version test",
      "repo_file_path" : "null%E7%89%88%E6%9C%AC%E6%B5%8B%E8%AF%95"
    }, {
      "region" : "xx-xxxxx-x",
      "id" : "",
      "name" : "landingzone test",
      "type" : "project",
      "created_time" : "2024-11-12 15:54:57",
      "modified_time" : "2024-11-12 15:54:57",
      "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "created_user_name" : "devcloud_devcloud_y00226182_05",
      "created_user_nick_name" : "Repository helper",
      "created_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "modified_user_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_nick_name" : "Repository helper",
      "modified_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "project_id" : "74698d06d75f41b782f834c802c9bae7",
      "repo_name" : "xx-xxxxx-x_74698d06d75f41b782f834c802c9bae7_generic_0",
      "parent_id" : "0",
      "download_url_with_id" : "DevRepoServer/v1/files/download?file_id=null&type=archive",
      "web_url" : "releaseman/project/74698d06d75f41b782f834c802c9bae7/private/general?parentId=0",
      "version_enable" : false,
      "migrated_state" : 0,
      "repo_same_trash_file_name" : "trash_null_landingzone test",
      "repo_file_path" : "nulllandingzone%20test"
    }, {
      "region" : "xx-xxxxx-x",
      "id" : "",
      "name" : "CodeArtsArtifact_Apig_Sonar",
      "type" : "project",
      "created_time" : "2024-10-24 20:53:51",
      "modified_time" : "2024-10-24 20:53:51",
      "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "created_user_name" : "devcloud_devcloud_y00226182_05",
      "created_user_nick_name" : "Repository helper",
      "created_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "modified_user_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_nick_name" : "Repository helper",
      "modified_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "project_id" : "bc634ac7a3894a1d91ca72aad5e72bdf",
      "repo_name" : "xx-xxxxx-x_bc634ac7a3894a1d91ca72aad5e72bdf_generic_0",
      "parent_id" : "0",
      "download_url_with_id" : "DevRepoServer/v1/files/download?file_id=null&type=archive",
      "web_url" : "releaseman/project/bc634ac7a3894a1d91ca72aad5e72bdf/private/general?parentId=0",
      "version_enable" : false,
      "migrated_state" : 0,
      "repo_same_trash_file_name" : "trash_null_CodeArtsArtifact_Apig_Sonar",
      "repo_file_path" : "nullCodeArtsArtifact_Apig_Sonar"
    }, {
      "region" : "xx-xxxxx-x",
      "id" : "",
      "name" : "donglingshi",
      "type" : "project",
      "created_time" : "2024-10-15 17:30:46",
      "modified_time" : "2024-10-15 17:30:46",
      "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "created_user_name" : "devcloud_devcloud_y00226182_05",
      "created_user_nick_name" : "Repository helper",
      "created_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "modified_user_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_nick_name" : "Repository helper",
      "modified_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "project_id" : "eb2429dc4f3349e5b47163a9bfd1210b",
      "repo_name" : "xx-xxxxx-x_eb2429dc4f3349e5b47163a9bfd1210b_generic_0",
      "parent_id" : "0",
      "download_url_with_id" : "DevRepoServer/v1/files/download?file_id=null&type=archive",
      "web_url" : "releaseman/project/eb2429dc4f3349e5b47163a9bfd1210b/private/general?parentId=0",
      "version_enable" : false,
      "migrated_state" : 0,
      "repo_same_trash_file_name" : "trash_null_donglingshi",
      "repo_file_path" : "nulldonglingshi"
    }, {
      "region" : "xx-xxxxx-x",
      "id" : "",
      "name" : "test0416-001",
      "type" : "project",
      "created_time" : "2024-04-16 16:25:41",
      "modified_time" : "2024-04-16 16:25:41",
      "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "created_user_name" : "devcloud_devcloud_y00226182_05",
      "created_user_nick_name" : "Repository helper",
      "created_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "modified_user_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_nick_name" : "Repository helper",
      "modified_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "project_id" : "bef3419620d743eca6a57881a0f006fd",
      "repo_name" : "xx-xxxxx-x_bef3419620d743eca6a57881a0f006fd_generic_0",
      "parent_id" : "0",
      "download_url_with_id" : "DevRepoServer/v1/files/download?file_id=null&type=archive",
      "web_url" : "releaseman/project/bef3419620d743eca6a57881a0f006fd/private/general?parentId=0",
      "version_enable" : false,
      "migrated_state" : 0,
      "repo_same_trash_file_name" : "trash_null_test0416-001",
      "repo_file_path" : "nulltest0416-001"
    }, {
      "region" : "xx-xxxxx-x",
      "id" : "",
      "name" : "Dedicated project for function automation (do not delete/modify)",
      "type" : "project",
      "created_time" : "2024-03-26 14:41:57",
      "modified_time" : "2024-03-29 15:58:06",
      "created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "created_user_name" : "devcloud_devcloud_y00226182_05",
      "created_user_nick_name" : "Repository helper",
      "created_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
      "modified_user_name" : "devcloud_devcloud_y00226182_05",
      "modified_user_nick_name" : "Repository helper",
      "modified_user_domain_name" : "devcloud_devcloud_y00226182_05",
      "project_id" : "99b6617f8e0a4b67a856738d6355b2f0",
      "repo_name" : "xx-xxxxx-x_99b6617f8e0a4b67a856738d6355b2f0_generic_0",
      "parent_id" : "0",
      "download_url_with_id" : "DevRepoServer/v1/files/download?file_id=null&type=archive",
      "web_url" : "releaseman/project/99b6617f8e0a4b67a856738d6355b2f0/private/general?parentId=0",
      "version_enable" : false,
      "migrated_state" : 0,
      "repo_same_trash_file_name" : "trash_null_dedicated project for function automation (do not delete/modify)",
      "repo_file_path" : "null%E5%8A%9F%E8%83%BD%E8%87%AA%E5%8A%A8%E5%8C%96%E4%B8%93%E7%94%A8%E9%A1%B9%E7%9B%AE(%E5%8B%BF%E5%8A%A8%E5%8B%BF%E5%88%A0)"
    } ],
    "total_records" : 151,
    "total_pages" : 16
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.