Querying File Versions in a Project
Function
This API is used to query file versions in a project.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/release/files
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| file_name | Yes | String | Definition File name used for fuzzy search. Constraints N/A. 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. Range 1–100 Default value 10 |
| offset | No | Integer | Definition Start position of the pagination query. Constraints N/A. Range The value is greater than 0. Default value 0 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| x-auth-token | Yes | String | Definition User token (value of X-Subject-Token in the response header), which can be obtained by calling the IAM API. Constraints N/A. Range String length: 1–100,000 characters. Default value N/A. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| result | result object | Definition Returned information. Range N/A. Default value None |
| 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 |
| 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
| 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
| 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/11111111111111111111111111111111/release/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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.