根据文件完整路径查询文件详情 - ShowFileDetailByFullName
功能介绍
在日常数据管理工作中,根据文件完整路径查询指定文件详情,包含文件名、文件大小、下载地址、校验和、文件状态和发布状态等信息。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型(*为必须) |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
codeartsartifact:releaseRepo:read |
Read |
- |
- |
- |
- |
URI
GET /devreposerver/v5/files/info
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
file_name |
是 |
String |
参数解释: 文件名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释: 请求成功或失败状态。 取值范围:
|
|
trace_id |
String |
参数解释: 请求ID,当前请求的唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 |
|
result |
RepoFileDOV5 object |
参数解释: 文件信息。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: id。 取值范围: 不涉及。 |
|
file_id |
String |
参数解释: 文件id。 取值范围: 不涉及。 |
|
repo_name |
String |
参数解释: 仓库id。 取值范围: 不涉及。 |
|
project_name |
String |
参数解释: 项目名称。 取值范围: 不涉及。 |
|
parent_id |
String |
参数解释: 父级目录ID。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 文件名。 取值范围: 不涉及。 |
|
file_name |
String |
参数解释: 文件名。 取值范围: 不涉及。 |
|
type |
String |
参数解释: 文件类型, folder代表是目录,file代表文件。 取值范围: 不涉及。 |
|
category |
String |
参数解释: 发布包状态 test为测试包 prod为发布包。 取值范围: 不涉及。 |
|
extension |
String |
参数解释: 文件扩展名。 取值范围: 不涉及。 |
|
path |
String |
参数解释: 文件路径。 取值范围: 不涉及。 |
|
full_path |
String |
参数解释: 文件路径(含项目)。 取值范围: 不涉及。 |
|
size |
Long |
参数解释: 文件大小,单位为byte。 取值范围: 不涉及。 |
|
md5 |
String |
参数解释: md5校验和。 取值范围: 不涉及。 |
|
sha256 |
String |
参数解释: sha256校验和。 取值范围: 不涉及。 |
|
download_url |
String |
参数解释: 下载地址。 取值范围: 不涉及。 |
|
download_url_with_id |
String |
参数解释: 带有id的下载地址。 取值范围: 不涉及。 |
|
web_url |
String |
参数解释: 历史版本遗留字段,请忽略。 取值范围: 不涉及。 |
|
version_enable |
Boolean |
参数解释: 判断当前文件或文件夹父目录是否为版本路径,即仓库下第一层子目录。 取值范围:
|
|
migrated_state |
Integer |
参数解释: migrated_state。 取值范围: 该参数为内部数据改造参数,无业务含义,请忽略。 |
|
upload_id |
String |
参数解释: 该参数无返回值,请忽略。 取值范围: 不涉及。 |
请求示例
查询文件详情
https://{URL}/devreposerver/v5/files/info?file_name=f132b62084774001b84c294c0eef27f2/tool_version.json
响应示例
状态码:200
OK
{
"status" : "success",
"trace_id" : "290e1f8beed846c6ae3ea11c8dc30ed9",
"result" : {
"status" : "active",
"region" : "xx-xxxxx-7",
"id" : "a3770843d8594b0a9b3a1131a613689a",
"name" : "tool_version.json",
"type" : "file",
"category" : "test",
"extension" : "json",
"path" : "/",
"size" : 157,
"md5" : "c25d932898e4b63d1447d9c37b957513",
"sha256" : "bd992ba958893fa9aabdf63fecbfdaf91583959b9c383054c5a5f66c9b109887",
"domain_id" : "09d2ca2f5080d5b60f51c00ae5bad0a0",
"created_time" : "2025-05-13 16:55:53",
"modified_time" : "2025-05-13 16:55:53",
"created_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
"created_user_name" : "devcloud_devcloud_y00226182_05",
"modified_user_id" : "09d2ca2ffd00d3c21ff8c00a4dd1e080",
"modified_user_name" : "devcloud_devcloud_y00226182_05",
"build_version" : "latest",
"repo_url" : "",
"project_id" : "f132b62084774001b84c294c0eef27f2",
"file_id" : "3fe9d7a21bf04df2b0159ae958b6f9ad",
"repo_name" : "xx-xxxxx-7_f132b62084774001b84c294c0eef27f2_generic_0",
"parent_id" : "0",
"download_url" : "DevRepoServer/v1/files/download?filename=f132b62084774001b84c294c0eef27f2/tool_version.json",
"download_url_with_id" : "DevRepoServer/v1/files/download?file_id=a3770843d8594b0a9b3a1131a613689a",
"web_url" : "releaseman/project/f132b62084774001b84c294c0eef27f2/private/general?parentId=0",
"version_enable" : false,
"migrated_state" : 3,
"repo_same_trash_file_name" : "trash_3fe9d7a21bf04df2b0159ae958b6f9ad_tool_version.json",
"repo_file_path" : "/tool_version.json"
}
}
SDK代码示例
SDK代码示例如下。
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 |
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 ShowFileDetailByFullNameSolution { 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(); ShowFileDetailByFullNameRequest request = new ShowFileDetailByFullNameRequest(); try { ShowFileDetailByFullNameResponse response = client.showFileDetailByFullName(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 |
# 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 = ShowFileDetailByFullNameRequest() response = client.show_file_detail_by_full_name(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 |
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.ShowFileDetailByFullNameRequest{} response, err := client.ShowFileDetailByFullName(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。