华为云用户手册

  • URI GET /v2/projects/{project_uuid}/repositories 表1 路径参数 参数 是否必选 参数类型 描述 project_uuid 是 String 项目的uuid 表2 Query参数 参数 是否必选 参数类型 描述 page_index 否 Integer 分页索引,从1开始计数 page_size 否 Integer 每页条目数 search 否 String 搜索关键字
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepoListInfoV2 object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 RepoListInfoV2 参数 参数类型 描述 repositories Array of RepoInfoV2 objects 仓库列表 total Integer 仓库总数 表7 RepoInfoV2 参数 参数类型 描述 created_at String 创建时间 creator_name String 创建者的用户名,在用户是租户的情况下,用户名和租户名相等 domain_name String 创建者的租户名 group_name String 仓库组名(克隆地址中域名后面项目名前的一段 示例:git@repo.alpha.devcloud.inhuawei.com:Demo00228/testword.git 组名:Demo00228 ) https_url String 使用 https 克隆仓库时所使用的 url iam_user_uuid String 用户的 iam user uuid is_owner Integer 当前用户是否是仓库的创建者,1:是,0:不是 lfs_size String 仓库 LFS 容量,单位为M,大于 1024M 则单位为 G project_is_deleted String 项目是否被删除 project_uuid String 项目的uuid repository_id Integer 仓库主键id repository_name String 仓库名 repository_size String 仓库总容量 = 仓库 LFS 容量 + git 库容量,单位为M,大于 1024M 则单位为 G repository_uuid String 仓库uuid(由CreateRepository接口返回) ssh_url String 使用 ssh 方式克隆仓库时所使用的 url star Boolean 当前用户是否收藏该仓库 status Integer 仓库状态, 0:仓库正常创建成功 1:仓库创建中 2:创建失败 3:仓库冻结 4:仓库已经关闭 updated_at String 更新时间 userRole Integer 用户在仓库中的权限:20:只读成员 30:普通成员 40:管理员 visibility_level Integer 是否可见:0私有仓库,20公有仓库 web_url String web url 路径,访问它将跳转至仓库详情页
  • 响应示例 状态码: 200 OK { "result" : { "total" : 14, "repositories" : { "repository_uuid" : "d0457f74cc5b43d989ded7248f71b4e5", "repository_id" : 468480, "repository_name" : "CreatRepository_2qD5i", "ssh_url" : "git@repo.alpha.devcloud.inhuawei.com:Demo00228/CreatRepository_2qD5i.git", "https_url" : "https://repo.alpha.devcloud.inhuawei.com/Demo00228/CreatRepository_2qD5i.git", "group_name" : "Demo00228", "web_url" : "https://alpha.devcloud.inhuawei.com/repo/468480/home", "visibility_level" : 0, "created_at" : "2019-10-15 09:40:26", "updated_at" : "2019-10-15 09:40:26", "repository_size" : "0.06M", "lfs_size" : "0.00M", "creator_name" : "repo", "domain_name" : "repo", "star" : false, "status" : 0, "is_owner" : 1, "iam_user_uuid" : "a618e34bd5704be3ae3395dfede06041", "project_uuid" : "4838955a48e2492bbe44b31bc4c272f6", "project_is_deleted" : "false", "userRole" : null } }, "status" : "success"}
  • 响应示例 状态码: 200 OK { "result" : [ { "diff" : "@@ -1,4 +1,7 @@\n y_mr_0721\n+\n+![CloudIDE成功运行](./image/截图.PNG)\n+\n edwwd\n # css \n **hhrh**\n", "old_path" : "README.md", "new_path" : "README.md", "a_mode" : "100644", "b_mode" : "100644", "new_file" : false, "renamed_file" : false, "deleted_file" : false } ], "status" : "success"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result Array of DiffCommitInfo objects 差异列表 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 DiffCommitInfo 参数 参数类型 描述 old_path String 变更前文件路径 new_path String 变更后文件路径 a_mode String 变更前文件模式 b_mode String 变更后文件模式 new_file Boolean 此次变更是否新增文件 renamed_file Boolean 此次变更是否重命名文件 deleted_file Boolean 此次变更是否删除文件 diff Boolean 差异信息
  • URI GET /v1/repositories/{group_name}/{repository_name}/commits 表1 路径参数 参数 是否必选 参数类型 描述 group_name 是 String 仓库组名(克隆地址中域名后面项目名前的一段 示例:git@repo.alpha.devcloud.inhuawei.com:Demo00228/testword.git 组名:Demo00228 ) repository_name 是 String 仓库名 表2 Query参数 参数 是否必选 参数类型 描述 page_index 否 Integer 分页索引 page_size 否 Integer 分页索引 ref_name 是 String 分支或标签名,支持SHA格式
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result CommitList object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 CommitList 参数 参数类型 描述 commits Array of Commit objects 提交列表 total Integer 提交总数 表7 Commit 参数 参数类型 描述 author_email String 作者邮箱 author_name String 作者 authored_date String 作者提交时间 committed_date String 提交时间 committer_email String 提交作者邮箱 committer_name String 提交作者 format Object 文件变更的详情信息,其格式由请求查询参数 stat_format 决定 id String 提交对应的SHA id message String 提交的信息 parent_ids Array of strings 父提交id
  • 响应示例 状态码: 200 OK { "result" : { "total" : 1, "commits" : [ { "id" : "a27fafa7d8da2dd55f691bef989226d22f50d8ce", "message" : "Initial commit", "parent_ids" : [ ], "authored_date" : null, "author_name" : "repo", "author_email" : "repo@huawei.com", "committed_date" : "2019-10-15 09:40:29", "committer_name" : "repo", "committer_email" : "repo@huawei.com" } ] }, "status" : "success"}
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 repository_uuid 是 String 仓库UUID(由CreateRepository接口返回) 最小长度:32 最大长度:32 private_key 是 String 私钥 最小长度:0 最大长度:2048
  • 请求示例 POST https://{endpoint}/v1/users/sshkey/privatekey/verify{ "private_key" : "-----BEGIN RSA PRIVATE KEY-----****-----END RSA PRIVATE KEY-----", "repository_uuid" : "9b2fab276e9240e09cd01ed0400fc439"}
  • URI GET /v1/repositories/repoid 表1 Query参数 参数 是否必选 参数类型 描述 group_name 是 String 仓库组名(克隆地址中域名后面项目名前的一段 示例:git@repo.alpha.devcloud.inhuawei.com:Demo00228/testword.git 组名:Demo00228 ) repository_name 是 String 仓库名
  • 响应示例 状态码: 200 OK { "result" : { "iid" : 1, "approval_merge_request_approvers" : [ { "nick_name" : "emily", "name" : "emily", "id" : 7513, "state" : "optional", "username" : "0c1de3e61c80d56b1f7dc01164788784" }, { "nick_name" : "lmptest02", "name" : "lmptest02", "id" : 7745, "state" : "optional", "username" : "2ef8c2c835424e988ff33a8339ee1cb4" } ], "description" : "merge \"branch123\" into \"master\"\n新建文件 dsadsad11", "created_at" : "2021-12-08T16:34:49.000+08:00", "title" : "tesafrds.", "source_branch" : "branch123", "updated_at" : "2021-12-09T11:21:02.000+08:00", "id" : 6670, "state" : "opened", "closed_at" : "2021-12-08T16:34:50.000+08:00", "author" : { "name" : "repo", "id" : 6879, "state" : "active", "username" : "e0c068bf68c44bfab87b763ff85da277" }, "is_source_branch_exist" : true, "target_branch" : "master", "merge_status" : "unchecked", "merge_request_diff" : { "merge_request_id" : 6670, "head_commit_sha" : "715fc146292edc31a588fbc74349a2b8d18dbc27", "updated_at" : "2021-12-09T11:20:58.000+08:00", "start_commit_sha" : "02f0482056d3b949699eb69683914466c84529af", "created_at" : "2021-12-09T11:20:58.000+08:00", "base_commit_sha" : "6e90282f6334433a9fe3be809a7c1eed1afbf10b", "commits_count" : 2 }, "devcloud_source_branch" : "branch123", "merge_request_assignee_list" : [ { "name" : "六月飞雪", "id" : 6743, "state" : "active", "username" : "a618e34bd5704be3ae3395dfede06041" }, { "name" : "管理员总账户", "id" : 6747, "state" : "active", "username" : "42dd0277cfb048dea856e4ee352e937d" } ] }, "status" : "success"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result MergeInfoResult object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 MergeInfoResult 参数 参数类型 描述 approval_merge_request_approvers Array of ApprovalMergeRequestApproversItem objects 评审人 author Author object 作者 closed_at String 关闭时间 created_at String 创建时间 description String 合并请求描述 devcloud_source_branch String 源分支 id Double 合并请求id iid Double 当前仓库内合并请求序号 is_source_branch_exist Boolean 源分支是否存在 merge_request_assignee_list Array of MergeRequestAssigneeListItem objects 检视人 merge_request_diff MergeRequestDiff object 合并差异 merge_status String 是否可以被合并 source_branch String 源分支 state String 合并请求状态 target_branch String 目标分支 title String 标题 updated_at String 更新时间 表6 ApprovalMergeRequestApproversItem 参数 参数类型 描述 id Double 用户id name String 用户名 nick_name String 用户昵称 state String 用户状态 username String 用户iamId 表7 Author 参数 参数类型 描述 id Double 用户id name String 用户名 state String 用户状态 username String 用户iamId 表8 MergeRequestAssigneeListItem 参数 参数类型 描述 id Double 用户id name String 用户名 state String 用户状态 username String 用户iamId 表9 MergeRequestDiff 参数 参数类型 描述 base_commit_sha String base提交 commits_count Double 提交数 created_at String 创建时间 head_commit_sha String head提交 merge_request_id Double 合并请求id start_commit_sha String start提交 updated_at String 更新时间
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result CommitList object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 CommitList 参数 参数类型 描述 commits Array of Commit objects 提交列表 total Integer 提交总数 表7 Commit 参数 参数类型 描述 author_email String 作者邮箱 author_name String 作者 authored_date String 作者提交时间 committed_date String 提交时间 committer_email String 提交作者邮箱 committer_name String 提交作者 format Object 文件变更的详情信息,其格式由请求查询参数 stat_format 决定 id String 提交对应的SHA id message String 提交的信息 parent_ids Array of strings 父提交id
  • 响应示例 状态码: 200 OK { "result" : { "total" : 1, "commits" : [ { "id" : "a27fafa7d8da2dd55f691bef989226d22f50d8ce", "message" : "Initial commit", "parent_ids" : [ ], "authored_date" : null, "author_name" : "repo", "author_email" : "repo@huawei.com", "committed_date" : "2019-10-15 09:40:29", "committer_name" : "repo", "committer_email" : "repo@huawei.com" } ] }, "status" : "success"}
  • URI GET /v1/repositories/{repository_id}/commits 表1 路径参数 参数 是否必选 参数类型 描述 repository_id 是 Integer 仓库主键id 表2 Query参数 参数 是否必选 参数类型 描述 author 否 String 提交作者 begin_date 否 String 起始提交日期,格式为yyyy-MM-dd end_date 否 String 终止提交日期,格式为yyyy-MM-dd message 否 String 提交信息 page_index 否 Integer 分页索引 缺省值:1 page_size 否 Integer 每页数据量 缺省值:10 path 否 String 文件路径 ref_name 是 String 分支或标签名,支持SHA格式 stat_format 否 String 提交的文件变更详情信息(不包含diff)
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepoStatisticsLaunch object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 RepoStatisticsLaunch 参数 参数类型 描述 can_statistics Boolean 仓库是否可以统计 join_id String sidekiq任务的 id message String 启动仓库统计返回的信息
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepoInfoV2 object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 RepoInfoV2 参数 参数类型 描述 created_at String 创建时间 creator_name String 创建者的用户名,在用户是租户的情况下,用户名和租户名相等 domain_name String 创建者的租户名 group_name String 仓库组名(克隆地址中域名后面项目名前的一段 示例:git@repo.alpha.devcloud.inhuawei.com:Demo00228/testword.git 组名:Demo00228 ) https_url String 使用 https 克隆仓库时所使用的 url iam_user_uuid String 用户的 iam user uuid is_owner Integer 当前用户是否是仓库的创建者,1:是,0:不是 lfs_size String 仓库 LFS 容量,单位为M,大于 1024M 则单位为 G project_is_deleted String 项目是否被删除 project_uuid String 项目的uuid repository_id Integer 仓库主键id repository_name String 仓库名 repository_size String 仓库总容量 = 仓库 LFS 容量 + git 库容量,单位为M,大于 1024M 则单位为 G repository_uuid String 仓库uuid(由CreateRepository接口返回) ssh_url String 使用 ssh 方式克隆仓库时所使用的 url star Boolean 当前用户是否收藏该仓库 status Integer 仓库状态, 0:仓库正常创建成功 1:仓库创建中 2:创建失败 3:仓库冻结 4:仓库已经关闭 updated_at String 更新时间 userRole Integer 用户在仓库中的权限:20:只读成员 30:普通成员 40:管理员 visibility_level Integer 是否可见:0私有仓库,20公有仓库 web_url String web url 路径,访问它将跳转至仓库详情页
  • 响应示例 状态码: 200 OK { "result" : { "repository_uuid" : "045ceabb9aea40579d5a759e84fa7f0a", "repository_id" : 468485, "repository_name" : "CreatRepository_MI9Af", "ssh_url" : "git@repo.alpha.devcloud.inhuawei.com:Demo00228/CreatRepository_MI9Af.git", "https_url" : "https://repo.alpha.devcloud.inhuawei.com/Demo00228/CreatRepository_MI9Af.git", "group_name" : "Demo00228", "web_url" : "https://alpha.devcloud.inhuawei.com/repo/468485/home", "visibility_level" : 0, "created_at" : "2019-10-15 09:40:27", "updated_at" : null, "repository_size" : null, "lfs_size" : null, "creator_name" : null, "domain_name" : null, "star" : null, "status" : null, "is_owner" : null, "iam_user_uuid" : null, "project_uuid" : "4838955a48e2492bbe44b31bc4c272f6", "project_is_deleted" : "false", "userRole" : null }, "status" : "success"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result Array of CommitStatistic objects 代码增加和删除的行数 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 CommitStatistic 参数 参数类型 描述 additions Integer 增加的行数 deletions Integer 删除的行数
  • URI GET /v2/repositories/{repository_id}/commit_lines 表1 路径参数 参数 是否必选 参数类型 描述 repository_id 是 Integer 仓库短id 表2 Query参数 参数 是否必选 参数类型 描述 ref_name 是 String 分支名称 begin_date 是 String 起始提交日期,格式为yyyy-MM-dd end_date 是 String 终止提交日期,格式为yyyy-MM-dd(begin_date和end_date时间间隔不超过60天)
  • 响应示例 状态码: 200 OK { "result" : { "repoName" : "repoName", "commitCount" : "111", "repoSize" : "0.26 MB", "lastCommitTime" : "2020-01-01 11:11:11", "codeLines" : "368965", "branchCount" : "222", "archiveUrl" : "https://devcloud.cn-north-7.ulanqab.huawei.com/repo/v1/repo/repository/2111663431/archive" }, "status" : "success"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepositoryStatisticsVO object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 RepositoryStatisticsVO 参数 参数类型 描述 repoName String 仓库名称 commitCount Integer 提交次数 repoSize String 仓库容量 lastCommitTime String 最近一次提交时间 codeLines Integer 代码行数 branchCount Integer 分支数量 archiveUrl String 代码仓下载地址
  • 响应示例 状态码: 200 OK { "result" : { "id" : "85a0a9d5c6e43bc9c3e443ac01f789e24eeef02b", "title" : "some commit message", "message" : "some commit message", "short_id" : "85a0a9d5", "author_name" : "repo", "author_email" : null, "committer_name" : "repo", "committer_email" : null, "created_at" : "2021-09-26T03:44:51.000Z", "parent_ids" : [ "5c114bb316dff4d4a046e09a5c44c816f2433140" ], "committed_date" : "2021-09-26T03:44:51.000Z", "authored_date" : null, "stats" : { "additions" : 1, "deletions" : 0, "total" : 1 }, "last_pipeline" : { "id" : 292811, "sha" : "2202af08836f0afd762d1b151d15ac510b974bdf", "ref" : "master", "status" : "running", "web_url" : "https://repo.devcloud.cn-north-208.ulanqab.huawei.com/Pipeline_Beta_sdcs00001/202107171926/pipelines/292811" } }, "status" : "success"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result SpecificCommitInfo object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 SpecificCommitInfo 参数 参数类型 描述 id String 提交对应的SHA id short_id String 提交对应的短SHA id title String 提交标题 author_name String 作者 author_email String 作者邮箱 committer_name String 提交作者 committer_email String 提交作者邮箱 created_at String 创建时间 message String 提交信息 parent_ids Array of strings 父提交id committed_date String 提交时间 authored_date String 作者提交时间 stats stats object 变更行数 last_pipeline last_pipeline object 流水线信息 表7 stats 参数 参数类型 描述 additions Integer 变更增加的行数 deletions Integer 变更删除的行数 total Integer 变更的总行数 表8 last_pipeline 参数 参数类型 描述 id Integer 流水线id sha String 提交对应的SHA id ref String 分支名 status String 流水线状态 web_url String 流水线url
  • URI GET /v2/projects/{repo_id}/repository/commits/{sha} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 Integer 仓库短id sha 是 String commit id,仓库的branch名或tag名 表2 Query参数 参数 是否必选 参数类型 描述 stats 否 Boolean 包括提交统计信息。默认值为true
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result CommitStatistic object 代码增加和删除的行数 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 CommitStatistic 参数 参数类型 描述 additions Integer 增加的行数 deletions Integer 删除的行数
  • URI GET /v3/repositories/{repository_id}/commit-lines 表1 路径参数 参数 是否必选 参数类型 描述 repository_id 是 Integer 仓库短id 表2 Query参数 参数 是否必选 参数类型 描述 ref_name 是 String 分支名称 begin_date 是 String 起始提交日期,格式为yyyy-MM-dd end_date 是 String 终止提交日期,格式为yyyy-MM-dd(begin_date和end_date时间间隔不超过60天)
  • 响应示例 状态码: 200 OK { "result" : [ { "size" : 9, "encoding" : "base64", "ref" : "master", "content" : "NDU0NTQ1NDQ1", "file_name" : "README.md", "file_path" : "README.md", "content_sha256" : "e16f4f6c41a79d120484774a625bea8a3c3dcb655aa7c7e793ac48639dc63944", "blob_id" : "3325fa3142fd66fedc8c3a5218b417f561e0ea2f", "commit_id" : "a772945ec2765e322cc83e0f467f394effa22cf3", "last_commit_id" : "a772945ec2765e322cc83e0f467f394effa22cf3" } ], "status" : "success"}
  • URI GET /v2/projects/{repo_id}/repository/files/{file_path} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 Integer 仓库短id file_path 是 String Url编码的新文件的完整路径。 表2 Query参数 参数 是否必选 参数类型 描述 ref 是 String commit id,仓库的branch名或tag名
共100000条