查看文件树 - ListLogsTree
功能介绍
查看文件树
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型(*为必须) |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
codeartsrepo:repository:getRepository |
Read |
- |
- |
- |
- |
URI
GET /v4/repositories/{repository_id}/repository/logs-tree
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 默认取值: 不涉及。 取值范围: 1~2147483647 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ref |
否 |
String |
参数解释: 引用,可以是分支名称、标签名称或者commitid,如果不传则为默认分支。 取值范围: 字符串长度不少于1,不超过2000。 |
|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0~2147483647 默认取值: 0 |
|
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1~100 默认取值: 20 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of LogTreeDto objects |
文件树列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 文件名 |
|
path |
String |
参数解释: 路径 |
|
type |
String |
参数解释: 文件类型 |
|
commit |
commit object |
参数解释: 最近提交信息 |
|
blob_id |
String |
参数解释: 文件id |
|
submodule_url |
String |
参数解释: 子模块url地址 |
|
is_limited |
Boolean |
参数解释: 文件是否受限 |
|
submodule_link |
String |
参数解释: 子模块链接 |
|
md5 |
String |
参数解释: 文件md5 |
|
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 |
参数解释: 错误信息。 |
请求示例
无
响应示例
状态码:200
文件树信息
[ {
"name" : "eer",
"path" : "eer",
"type" : "tree",
"commit" : {
"id" : "188680745edb3955***a6f9b110019c145955",
"message" : "rr",
"parent_ids" : [ "456ac4f94816****deec9a95a2faf33f199fc" ],
"authored_date" : "2024-10-29T03:02:10.000Z",
"author_name" : "****",
"author_email" : "aan@example.com",
"committed_date" : "2024-10-29T03:02:10.000Z",
"committer_name" : "****",
"committer_email" : "aa@example.com",
"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
},
"blob_id" : "****",
"submodule_url" : null,
"is_limited" : false,
"submodule_link" : null,
"md5" : "****",
"nick_name" : "****",
"tenant_name" : "****",
"user_name" : "****"
} ]
状态码:401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
}
状态码:403
Bad Request
{
"error_code" : "CH.004403",
"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 46 |
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.codeartsrepo.v4.region.CodeArtsRepoRegion; import com.huaweicloud.sdk.codeartsrepo.v4.*; import com.huaweicloud.sdk.codeartsrepo.v4.model.*; public class ListLogsTreeSolution { 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); CodeArtsRepoClient client = CodeArtsRepoClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsRepoRegion.valueOf("<YOUR REGION>")) .build(); ListLogsTreeRequest request = new ListLogsTreeRequest(); request.withRepositoryId({repository_id}); try { ListLogsTreeResponse response = client.listLogsTree(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 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsrepo.v4.region.codeartsrepo_region import CodeArtsRepoRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsrepo.v4 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 = CodeArtsRepoClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsRepoRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListLogsTreeRequest() request.repository_id = {repository_id} response = client.list_logs_tree(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 36 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsrepo "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/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 := codeartsrepo.NewCodeArtsRepoClient( codeartsrepo.CodeArtsRepoClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListLogsTreeRequest{} request.RepositoryId = int32({repository_id}) response, err := client.ListLogsTree(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
文件树信息 |
|
401 |
Unauthorized |
|
403 |
Bad Request |
错误码
请参见错误码。