Help Center/ CodeArts Artifact/ API Reference/ API/ File Management/ Querying Repository File Details

Updated on 2025-12-05 GMT+08:00

View PDF

Querying Repository File Details

Function

This API is used to query repository file details.

Calling Method

For details, see Calling APIs.

URI

GET /cloudartifact/v5/{tenant_id}/{project_id}/{repo_name}/file-detail

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Definition Tenant ID. Constraints The value can contain 8 to 32 characters. Only letters and digits are supported. Range N/A. Default value None
project_id	Yes	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. Range N/A. Default value None
repo_name	Yes	String	Definition Repository ID. The format is {region}{domainId}{format}_{sequence}. You can find the repository ID on the general page of your self-hosted repos. It is the string located between the last two slashes (/) in the repository URL. Constraints N/A. Range The region and domainId in the repository ID must be valid values. The valid values of format are npm, go, pypi, rpm, composer, maven, debian, conan, nuget, docker2, cocoapods, and ohpm. The upper limit of sequence varies depending on the package. Default value N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
path	Yes	String	Definition Path of the file to be queried. Constraints Mandatory. The maximum length is 1,280 characters. Range N/A. Default value N/A.
format	Yes	String	Definition Package type. Constraints Mandatory. Range maven2, docker, conan, debian, go, nuget, rpm, pypi, npm, cocoapods, and generic. Default value N/A.
instance_id	No	String	Definition: Instance ID. This parameter is no longer used. Constraints N/A. Range N/A. Default value N/A.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** 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	result object	Definition File details. Range N/A.

**Table 4** result
Parameter	Type	Description
repo	String	Definition Repository ID. Range N/A.
path	String	Definition File path. Range N/A.
name	String	Definition File name. Range N/A.
created	String	Definition Creation time, in yyyy-MM-dd HH:mm:ss format. Range N/A.
createdBy	String	Definition Creator. Range N/A.
lastModified	String	Definition Last modification time, in yyyy-MM-dd HH:mm:ss format. Range N/A.
lastUpdated	String	Definition Last modification time, in yyyy-MM-dd HH:mm:ss format. Range N/A.
modifiedBy	String	Definition Modifier. Range N/A.
uri	String	Definition Access address. Range N/A.
downloadUri	String	Definition Download URL. Range N/A.
size	String	Definition File size. Range N/A.
attention	String	Definition Favorited or not. Range 1: favorited. 0: not favorited.
checksums	checksums object	Definition Checksums. Range N/A.
downloadInfo	downloadInfo object	Definition Download information. Range N/A.
gavDisplay	gavDisplay object	Definition Coordinates. Range N/A.
originalChecksums	Object	Definition Checksums. Range N/A.
displayName	String	Definition Display name. Range N/A.
display_size	String	Definition Display size. Range N/A.

**Table 5** checksums
Parameter	Type	Description
sha512	String	Definition SHA-512 checksum. Range N/A.
sha256	String	Definition SHA-256 checksum. Range N/A.
sha1	String	Definition SHA-1 checksum. Range N/A.
md5	String	Definition MD5 checksum. Range N/A.

**Table 6** downloadInfo
Parameter	Type	Description
uri	String	Definition File path. Range N/A.
downloadCount	Long	Definition Download times. Range N/A.
lastDownloaded	Long	Definition Last download time. Range N/A.
remoteDownloadCount	Long	Definition Number of remote downloads. Range N/A.
remoteLastDownloaded	Long	Definition Remote download time. Range N/A.
lastDownloadedBy	String	Definition Last downloaded by. Range N/A.

**Table 7** gavDisplay
Parameter	Type	Description
gavInfo	String	Definition Coordinates. Range N/A.
configInfo	String	Definition Configuration information. Range N/A.

Example Requests

This API is used to query repository file details.

https://{URL}/cloudartifact/v5/00000000000000000000000000000000/11111111111111111111111111111111/xxxxx-1_xxxxxxxxxxxxxxxxxxxxxxxxx_go_1/file-detail?path=/up/up/9Hn1036zgQqL4G805Ufb43H4s1t984&format=go

Example Responses

Status code: 200

{
  "status" : "success",
  "trace_id" : "143002-1701223197469-447",
  "result" : {
    "repo" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_go_19",
    "path" : "/up/up/9Hn1036zgQqL4G805Ufb43H4s1t984",
    "name" : "9Hn1036zgQqL4G805Ufb43H4s1t984",
    "created" : "2023-11-14 19:29:46",
    "createdBy" : "devcloud_devcloud_y00226182_01",
    "lastModified" : "2023-11-14 19:29:46",
    "lastUpdated" : "2023-11-14 19:29:46",
    "modifiedBy" : "devcloud_devcloud_y00226182_01",
    "uri" : "https://cloudartifacts-backend.xx-xxxxx-x.myhuaweicloud.com/artgalaxy/api/storage/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_go_19/up/up/9Hn1036zgQqL4G805Ufb43H4s1t984",
    "downloadUri" : "https://cloudartifacts-backend.xx-xxxxx-x.myhuaweicloud.com/artgalaxy/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_go_19/up/up/9Hn1036zgQqL4G805Ufb43H4s1t984",
    "mimeType" : null,
    "size" : "1056",
    "attention" : "0",
    "checksums" : {
      "sha512" : "86b14ee38fbeee9b33184b018dd7740c75acb994292a2f71db7af9952ecb7676fe759cfc3207ab4d5b7f76252c0e3a6683c00e7c0af3cb73282ee05a5441e72c",
      "sha256" : "806f31bcccdf84d133de1b307834e7f4f07810b4f5204bd449ce088c051513a4",
      "sha1" : "20691eee689efdf42e926b52b6f84c51439ab054",
      "md5" : "af5b0888060bcdabc8a5440251556461"
    },
    "packageName" : null,
    "version" : null,
    "groupId" : null,
    "artifactId" : null,
    "properties" : null,
    "downloadInfo" : {
      "uri" : "https://cloudartifacts-backend.xx-xxxxx-x.myhuaweicloud.com/artgalaxy/api/storage/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_go_19/up/up/9Hn1036zgQqL4G805Ufb43H4s1t984",
      "downloadCount" : 0,
      "lastDownloaded" : 0,
      "remoteDownloadCount" : 0,
      "remoteLastDownloaded" : 0,
      "lastDownloadedBy" : ""
    },
    "gavDisplay" : {
      "gavInfo" : null,
      "configInfo" : ""
    },
    "originalChecksums" : { },
    "displayName" : "go3",
    "display_size" : "1.03 KB"
  }
}