文档

ListRepositoryTree - 查询文件树

查询代码库的文件树。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /repository/{repositoryId}/files/tree

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

624666bd54d036291ae13a36
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

f0b1e61db5961df5975a93f9129d2513
repositoryIdlong

代码库 ID

2851516
pathstring

代码仓库内的文件路径,获取该路径下的文件目录,默认获取代码库文件树的全部结构

module
refNamestring

分支名称、标签名称或 CommitID,默认为代码库库默认分支

master / tag1.0 / sjjfssa
typestring

查找策略 DIRECT:仅展示当前目录下的内容 RECURSIVE:递归查找当前路径下的所有文件 FLATTEN:扁平化展示(如果是目录,递归查找,直到子目录包含文件或多个目录为止)

RECURSIVE

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

6557983C-FB08-51A9-AC5A-A7A0D0950A07
errorMessagestring

错误信息

""
errorCodestring

错误码

SYSTEM_UNKNOWN_ERROR
successboolean

调用是否成功

true
resultobject []

返回结果列表

pathstring

文件路径

test-codeup
isLFSboolean

是否是大文件

false
idstring

文件版本,唯一标识

76c3f251f414ac31f2e01faf6f2008a9d756a437
namestring

文件名称

test-codeup
typestring

文件类型 tree: 目录 blob:文件 commit:commit 支持 submodule

blob
modestring

类型、权限信息

100644

示例

正常返回示例

JSON格式

{
  "requestId": "6557983C-FB08-51A9-AC5A-A7A0D0950A07",
  "errorMessage": "\"\"",
  "errorCode": "SYSTEM_UNKNOWN_ERROR",
  "success": true,
  "result": [
    {
      "path": "test-codeup",
      "isLFS": false,
      "id": "76c3f251f414ac31f2e01faf6f2008a9d756a437",
      "name": "test-codeup",
      "type": "blob",
      "mode": "100644"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.UserNotAdminOrOwnerThe current user is not an admin or owner in the organization and is not authorized to perform the operation.当前用户非该企业管理员或拥有者,无权进行操作。
403Forbidden.UserNotInCurrentOrganizationThe user is not in the organization and is not authorized to perform the operation.当前用户不在该企业中,无权进行操作。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈