华为云用户手册

  • 响应示例 状态码: 200 OK { "result" : { "event" : null, "total" : 0, "statistics" : [ ], "all_branch_commits_count" : 1, "count" : 1, "codelines" : { "additions" : 0, "deletions" : 0, "date" : "20191015" } }, "status" : "success"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepoCommitStatistics object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 RepoCommitStatistics 参数 参数类型 描述 all_branch_commits_count Integer 仓库总提交次数 codelines Array of RepoDailyCodeline objects 近15日每日代码提交行数 count Integer 对应分支仓库总提交次数 event RepoStatisticsEvent object 仓库统计状态 statistics Array of RepoStatistics objects 仓库统计列表 total Integer 仓库统计次数 表7 RepoDailyCodeline 参数 参数类型 描述 additions Integer 每日增加代码行 date String 日期 deletions Integer 每日删除代码行 表8 RepoStatisticsEvent 参数 参数类型 描述 branch String 分支名 最小长度:1 最大长度:260 created_at String 仓库统计创建的时间 date String 仓库统计的日期 id Integer 仓库统计事件的id project_id Integer 仓库id status String 仓库统计的状态: 等待统计waiting 正在统计active 完成统计finish updated_at String 仓库统计更新的时间 user_id Integer 用户id 表9 RepoStatistics 参数 参数类型 描述 add_lines Integer 添加代码行 branch String 分支名 最小长度:1 最大长度:260 commit_count Integer 提交次数 created_at String 仓库统计创建的时间 delete_lines Integer 删除代码行 id Integer 仓库统计记录id project_id Integer 仓库id updated_at String 仓库统计更新的时间 user_name String 用户名
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepoListHook object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 RepoListHook 参数 参数类型 描述 hooks Array of RepoHook objects hook列表 表7 RepoHook 参数 参数类型 描述 build_events Boolean 是否触发build_events事件 created_at String 仓库统计创建的时间 enable_ssl_verification Boolean 是否使用ssl验证 id Integer hook id issues_events Boolean 是否触发issues_events事件 merge_requests_events Boolean 是否触发merge_requests_events事件 note_events Boolean 是否触发note_events事件 pipeline_events Boolean 是否触发pipeline_events事件 project_id Integer 仓库id push_events Boolean 是否触发push_events事件 repository_update_events Boolean 是否触发repository_update_events事件 tag_push_events Boolean 是否触发tag_push_events事件 wiki_page_events Boolean 是否触发wiki_page_events事件
  • URI GET /v1/repositories/{group_name}/{repository_name}/hooks 表1 路径参数 参数 是否必选 参数类型 描述 group_name 是 String 组名(克隆地址中 域名 后面项目名前的一段 示例:git@repo.alpha.devcloud.inhuawei.com:Demo00228/testword.git 组名:Demo00228 ) repository_name 是 String 仓库名 表2 Query参数 参数 是否必选 参数类型 描述 hook_id 否 String hook id
  • 响应示例 状态码: 200 OK { "result" : { "hooks" : [ { "id" : 2111600786, "project_id" : 2111615967, "created_at" : "2021-11-09 16:35:15", "enable_ssl_verification" : false, "push_events" : true, "tag_push_events" : false, "repository_update_events" : false, "merge_requests_events" : false, "issues_events" : false, "note_events" : false, "pipeline_events" : false, "wiki_page_events" : false } ] }, "status" : "success"}
  • 响应示例 状态码: 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"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result FileContentInfo object 文件详情 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 FileContentInfo 参数 参数类型 描述 file_name String 文件名 file_path String 文件路径 size Integer 文件大小 encoding String 文件编码 content_sha256 String sha256编码的文件内容 ref String 分支名 blob_id String blob sha commit_id String 提交对应的SHA id last_commit_id String 最后一个提交对应的SHA id content String base64编码的文件内容
  • 响应示例 状态码: 200 OK { "result" : { "repos" : [ { "uuid" : "36f532939c4b4e2191c10f5353ccf34c", "repo_id" : 487773, "repo_name" : "DDDDDDDD", "ssh_url" : "git@repo.alpha.devcloud.inhuawei.com:CHEN_TEST00001/DDDDDDDD.git", "code_url" : "https://repo.alpha.devcloud.inhuawei.com/CHEN_TEST00001/DDDDDDDD.git", "detail_url" : "https://alpha.devcloud.inhuawei.com/repo/487773/home" } ], "total_count" : 100 }, "status" : "success"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result TemplateListInfo object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 TemplateListInfo 参数 参数类型 描述 repos Array of DevstarRepoInfo objects 仓库列表 total_count Integer 仓库总数 表7 DevstarRepoInfo 参数 参数类型 描述 uuid String 仓库的uuid repo_id String 仓库ID repo_name String 仓库名称 ssh_url String 仓库SSH地址 code_url String 仓库HTTPS地址 detail_url String 仓库预览地址
  • 响应示例 状态码: 200 OK { "result" : { "total" : 1, "merge_requests" : [ { "iid" : 1, "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-08T16:39:24.000+08:00", "id" : 6670, "state" : "opened", "closed_at" : "2021-12-08T16:34:50.000+08:00", "author" : { "name" : "repo", "id" : 1234, "state" : "active", "username" : "e0c068bf68c44bfab87b763ff85da277" }, "target_branch" : "master", "merge_status" : "can_be_merged", "devcloud_source_branch" : "branch123", "merge_request_assignee_list" : [ { "name" : "示例账号", "id" : 3333, "state" : "active", "username" : "a618e34bd5704be3ae3395dfede06041" }, { "name" : "示例账号", "id" : 6747, "state" : "active", "username" : "42dd0277cfb048dea856e4ee352e937d" } ] } ], "merged" : 0, "closed" : 0, "opened" : 1 }, "status" : "success"}
  • URI GET /v2/repositories/{repository_id}/merge_request 表1 路径参数 参数 是否必选 参数类型 描述 repository_id 是 Integer 仓库短id 表2 Query参数 参数 是否必选 参数类型 描述 state 否 String 匹配条件 page 否 String 分页页数 per_page 否 String 每页数据数 search 否 String 匹配条件
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result MergeResult object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 MergeResult 参数 参数类型 描述 closed Double 已关闭合并请求数 merge_requests Array of MergeRequestsItem objects 合并请求详情 merged Double 已合并合并请求数数 opened Double 开启中合并请求数 total Double 合并请求总数 表7 MergeRequestsItem 参数 参数类型 描述 author Author object 作者 closed_at String 关闭时间 created_at String 创建时间 description String 合并请求描述 devcloud_source_branch String 源分支 id Double 合并请求id iid Double 当前仓库内合并请求序号 merge_request_assignee_list Array of Author objects 检视人 merge_status String 是否可以被合并 source_branch String 源分支 state String 合并请求状态 target_branch String 目标分支 title String 标题 updated_at String 更新时间 表8 Author 参数 参数类型 描述 id Double 用户id name String 用户名 state String 用户状态 username String 用户iamId
  • 响应示例 状态码: 200 OK { "result" : { "total" : 2, "sshkey" : [ { "id" : "1015292", "title" : "reop1@huawei.com", "key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQA*********************************************************Bqa/pE8buOrxri6AWqAky0bmtjSuVf reop1@huawei.com" }, { "id" : "1031709", "title" : "reop@huawei.com", "key" : "ssh-rsa AAAAB3NzaC1yc2EA*********************************************************U7xcma6HU8nj1E0i46VObWyOONl3gh142BV repo@huawei.com" } ] }, "status" : "success"}
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result PublicKeyList object 响应结果 status String 响应状态 表3 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表4 PublicKeyList 参数 参数类型 描述 sshkey Array of PublicKey objects 密钥列表 total Integer 密钥总数 表5 PublicKey 参数 参数类型 描述 id String 密钥id 最小长度:1 最大长度:40 key String 密钥 最小长度:0 最大长度:2048 title String 密钥名称
  • URI GET /v1/repositories/{repository_uuid}/members 表1 路径参数 参数 是否必选 参数类型 描述 repository_uuid 是 String 仓库uuid(由CreateRepository接口返回) 表2 Query参数 参数 是否必选 参数类型 描述 page_index 否 Integer 第几页 page_size 否 Integer 每页显示size subject 否 String 搜索关键字
  • 响应示例 状态码: 200 OK { "result" : { "total" : 2, "users" : [ { "user_id" : "5836", "name" : "repo", "domain_name" : "repo", "description" : null, "enabled" : null, "role" : 40, "domain_id" : "159b65b41ead484d8ddff250a4731781", "email" : null }, { "user_id" : "6057", "name" : "repo", "domain_name" : "repo", "description" : null, "enabled" : null, "role" : 30, "domain_id" : "159b65b41ead484d8ddff250a4731781", "email" : null } ] }, "status" : "success"}
  • 响应示例 状态码: 200 OK { "result" : { "trees" : [ { "blob_id" : "ef69ef5dc0c53022fe52a4d02de15f73d96e055c", "file_name" : "csharpDemo.png", "file_path" : "images/csharpDemo.png", "md5" : "8830d25fe6b4e2cd14d75ddb5cae73a7", "type" : "blob", "commit" : { "id" : "1cfd6d81fff948828c7f59bda74c0ef80e53def0", "message" : "init\n", "parent_ids" : [ ], "author_name" : "repo", "author_email" : "repo@huawei.com", "committed_date" : "2019-11-13 11:29:26", "committer_name" : "repo", "committer_email" : "repo@huawei.com" } } ], "total" : 5 }, "status" : "success"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result LogsTreeList object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 LogsTreeList 参数 参数类型 描述 trees Array of LogsTree objects 文件日志树 total Integer 记录总数 表7 LogsTree 参数 参数类型 描述 blob_id String 存储块id commit Commit object 提交信息 file_name String 文件名称 file_path String 文件路径 md5 String MD5 type String 存储类型 表8 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
  • URI GET /v1/repositories/{repository_uuid}/branch/{branch_name}/sub-files 表1 路径参数 参数 是否必选 参数类型 描述 repository_uuid 是 String 仓库id branch_name 是 String 分支名称 表2 Query参数 参数 是否必选 参数类型 描述 path 否 String 文件路径 offset 否 Integer 偏移量 limit 否 Integer 记录数量
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 template_type 是 String 模板类型 code_title 否 String 代码模板名称 creator_name 否 String 创建者名称 code_description 否 String 代码模板描述 languages 否 Array of strings 模板语言 plateform 否 Array of strings 模板平台 entertype 否 Array of strings 模板类型
  • 请求示例 PUT https://{endpoint}/v2/repositories/{repository_uuid}/template-status{"template_type": "SHARE", "code_title": "exampleTitle", "creator_name": "exampleName", "code_description": "exampleDescription", "languages": ['Java'], "plateform": ['Console'], "entertype": ['AI']}
  • V2Project 接口 说明 查询用户的所有仓库 获取用户的所有仓库信息。 创建项目、仓库 创建项目后,创建仓库组由后台生成方式 传入参数:仓库名、模板id、是否导入项目成员、归属项目。 创建项目并fork仓库 创建仓库后fork仓库 传入参数:仓库名、是否导入项目成员、归属项目。 查询项目下的所有仓库 获取仓库列表,模糊查询支持范围,如果未传入project uuid,则支持按仓库名或项目名模糊查询,否则,只按仓库名模糊匹配。 分支关联工作项 分支关联工作项。
  • Commit 接口 说明 查询某个仓库的提交信息 根据仓库短ID获取提交信息,支持根据文件路径,查询这个路径下所有的commits列表。 创建提交 能够一次提交位于不同目录的多个文件,目录不存在时,能自动创建目录。支持强制覆盖选项,当选择强制覆盖标志为true时,忽略冲突,强制提交。 查询某个仓库的特定提交信息 获取由commit id或分支或标记的名称标识的特定提交。 查询某个仓库的提交差异信息 根据commit id查询提交差异信息。
  • Repository 接口 说明 获取分支目录下的文件 获取分支目录下的文件。 获取仓库统计数据 获取仓库统计数据。 获取一个仓库下特定分支的图片文件 获取一个仓库下特定分支的图片文件。 修改被流水线引用的仓库状态 修改被流水线引用的仓库状态。 判断用户是否有仓库的管理员权限 判断用户是否有仓库的管理员权限。 设置仓库是公开状态还是私有状态 设置仓库是公开状态还是私有状态。 获取一个仓库下特定分支指定文件内容 获取一个仓库下特定分支指定文件内容。 获取公开示例模板列表 获取公开示例模板列表。 创建仓库 用指定的名称在指定项目上创建仓库。传入参数:仓库名、模板id、是否导入项目成员、归属项目。 根据仓库名组名获取仓库短id,用以拼接与commitid对应提交详情页面url 获取仓库短id,用于获取仓库详情页面url。 根据组名和仓库名查询某仓库某分支对应的提交 根据仓库组名、仓库名和分支获取提交列表。 查询某仓库对应的分支 根据仓库id获取指定仓库的分支列表。 根据仓库id查询仓库某分支对应的提交,提供更多可选参数 根据仓库id查询仓库某分支对应的提交。 添加部署密钥 添加部署密钥。 删除仓库部署密钥 删除仓库部署密钥。 获取仓库上一次的提交统计信息 获取仓库上一次的提交统计信息。 仓库统计 根据仓库短id,查询仓库的代码提交记录统计。 删除仓库 根据仓库32位uuid删除指定的仓库。 查看仓库的创建状态 获取仓库状态。 查询某仓库的标签列表 查询指定仓库对应的分支。 新建标签 新建标签。 查询某个仓库的详细信息 根据仓库UUID获取仓库信息仓库信息。返回 包含id,name,组名,仓库访问URL。 获取代码提交行数 获取指定日期内代码仓指定分支的代码提交行数。 下载仓库 按照指定格式下载仓库。 新建保护分支 新建保护分支。 获取仓库分支列表 获取仓库分支列表。 获取仓库合并请求列表 获取仓库合并请求列表。 获取仓库合并请求详情 获取仓库合并请求详情。
  • 响应示例 状态码: 200 OK { "result" : { "projects" : [ { "id" : 453613, "name" : "javaMavenDemo", "template_name" : "javaMavenDemo", "tags" : [ "UnsupportedPipeline", "OTHERS", "鲲鹏 ARM64" ], "description" : "javaMavenDemo", "brief_introduction" : "javaMavenDemo", "auto_pending_pipelines" : 0, "language" : "OTHERS", "created_at" : "Sep 25, 2019 4:03:31 PM", "used_times" : 58, "liked_times" : 1, "creator_name" : "repo", "https_url" : "https://repo.alpha.devcloud.inhuawei.com/chentest00001/javaMavenDemo.git" } ], "total" : 100 }, "status" : "success"}
  • URI GET /v2/repositories/repository-templates 表1 Query参数 参数 是否必选 参数类型 描述 platform 否 String 模板平台类型 language 否 String 语言类型 pipeline 否 String 是否支持流水线 enter_type 否 String 模板分类 search 否 String 模板名称 date_order 否 String 模板日期排序 used_time_order 否 String 模板引用次数排序 type 否 String 模板公开类型 region 否 String 大区名称 page_no 是 Integer 分页页数 page_size 是 Integer 每页数据数
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result TemplateRepositoryList object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 TemplateRepositoryList 参数 参数类型 描述 projects Array of TemplateRepository objects 模板列表 total Integer 模板总数 表6 TemplateRepository 参数 参数类型 描述 id Integer 模板唯一标识 name String 模板名称 template_name String 模板关联仓库名称 tags Array of strings 模板标签 description String 模板描述 brief_introduction String 模板简介 auto_pending_pipelines Integer 是否自动创建流水线 language String 模板语言分类 created_at String 模板创建时间 used_times Integer 模板引用次数 liked_times Integer 模板被点赞次数 creator_name String 模板创建人 https_url String 模板https链接
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepoListInfoV2 object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 RepoListInfoV2 参数 参数类型 描述 repositories Array of RepoInfoV2 objects 仓库列表 total Integer 仓库总数 表6 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" : 29, "repositories" : { "repository_uuid" : "0bf1e7ceb5b341318cb72b42901abe54", "repository_id" : 468564, "repository_name" : "test", "ssh_url" : "git@repo.alpha.devcloud.inhuawei.com:test_new00001/test.git", "https_url" : "https://repo.alpha.devcloud.inhuawei.com/test_new00001/test.git", "group_name" : "test_new00001", "web_url" : "https://alpha.devcloud.inhuawei.com/repo/468564/home", "visibility_level" : 0, "created_at" : "2019-10-15 11:00:11", "updated_at" : "2019-10-15 11:00:11", "repository_size" : "0.05M", "lfs_size" : "0.00M", "creator_name" : "repo", "domain_name" : "repo", "star" : true, "status" : 0, "is_owner" : 1, "iam_user_uuid" : "a618e34bd5704be3ae3395dfede06041", "project_uuid" : "dc19b3ca6f334ce894a1ec467689797d", "project_is_deleted" : "false", "userRole" : null } }, "status" : "success"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 templateType 是 String 模板类型 codeTitle 否 String 代码模板名称 creatorName 否 String 创建者名称 codeDescription 否 String 代码模板描述 languages 否 Array of strings 模板语言 plateform 否 Array of strings 模板平台 entertype 否 Array of strings 模板类型
共100000条