查看文件属性与内容
功能介绍
查看文件属性与内容
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/repository/file
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ref |
否 |
String |
参数解释: 引用,可以是分支名称、标签名称或者commitid,如果不传则为默认分支。 取值范围: 字符串长度不少于1,不超过2000。 |
file_path |
是 |
String |
参数解释: 文件路径。 取值范围: 字符串长度不少于1,不超过10000。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Total |
Integer |
查看文件属性与内容 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
文件名称 |
path |
String |
文件路径 |
size |
Long |
文件大小 取值范围: 1-9007199254740992 |
encoding |
String |
文件编码方式 |
ref |
String |
分支名称、tag名称或者commitid |
blob_id |
String |
文件标识 |
file_type |
String |
文件类型 |
commit |
RepositoryCommitDto object |
提交 |
content |
String |
文件内容 |
is_limited |
Boolean |
参数解释: 文件是否受限。 取值范围:
|
content_sha256 |
String |
sha256值 |
last_commit_id |
String |
最新提交commitid |
nick_name |
String |
用户昵称 |
tenant_name |
String |
租户名称 |
user_name |
String |
用户名称 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
id |
message |
String |
消息 |
parent_ids |
Array of strings |
父节点提交ID |
authored_date |
String |
创建该分支的时间 |
author_name |
String |
创建者名称 |
author_email |
String |
创建者邮箱 |
committed_date |
String |
代码提交的日期和时间 |
committer_name |
String |
提交者名称 |
committer_email |
String |
提交者邮箱 |
open_gpg_verified |
Boolean |
是否打开gpg校验 |
verification_status |
Integer |
验证状态 取值范围: 0-1 |
gpg_primary_key_id |
String |
GPG公钥的标识符 |
name |
String |
用户名 |
gpg_nick_name |
String |
昵称 |
gpg_tenant_name |
String |
租户名 |
gpg_user_name |
String |
特定GPG用户相关的信息 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/repositories/2112015538/repository/file?file_path=2112016471&ref=master
响应示例
状态码:200
查看文件属性与内容
{ "name" : "README.md", "path" : "README.md", "size" : 52, "encoding" : "base64", "ref" : "main", "blob_id" : "****", "file_type" : "text/plain; charset=utf-8", "commit" : { "id" : "****", "message" : "****", "parent_ids" : [ "****" ], "authored_date" : "2025-01-14T02:56:17.000Z", "author_name" : "CodeHub_beta_dev", "author_email" : "liujian@example.com", "committed_date" : "2025-01-14T02:56:17.000Z", "committer_name" : "****", "committer_email" : "****", "open_gpg_verified" : null, "verification_status" : null, "gpg_primary_key_id" : null, "name" : null, "gpg_nick_name" : null, "gpg_tenant_name" : null, "gpg_user_name" : null }, "content" : "****", "is_limited" : false, "content_sha256" : "****", "last_commit_id" : "****", "nick_name" : "****", "tenant_name" : "****", "user_name" : "****" }
状态码:401
Unauthorized
{ "error_code" : "CH.00000001", "error_msg" : "未识别到用户认证信息" }
状态码:403
Bad Request
{ "error_code" : "CH.00401008", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码:404
Not Found
{ "error_code" : "CH.00402000", "error_msg" : "该仓库不存在,请检查后重试。" }
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.codehub.v3.region.CodeHubRegion; import com.huaweicloud.sdk.codehub.v3.*; import com.huaweicloud.sdk.codehub.v3.model.*; public class ShowFileSolution { 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); CodeHubClient client = CodeHubClient.newBuilder() .withCredential(auth) .withRegion(CodeHubRegion.valueOf("<YOUR REGION>")) .build(); ShowFileRequest request = new ShowFileRequest(); try { ShowFileResponse response = client.showFile(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 huaweicloudsdkcodehub.v3.region.codehub_region import CodeHubRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodehub.v3 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 = CodeHubClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowFileRequest() response = client.show_file(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" codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v3/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 := codehub.NewCodeHubClient( codehub.CodeHubClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowFileRequest{} response, err := client.ShowFile(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查看文件属性与内容 |
401 |
Unauthorized |
403 |
Bad Request |
404 |
Not Found |
错误码
请参见错误码。