云服务器内容精选

  • 响应示例 状态码: 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 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result Boolean 参数解释: 仓库是否存在。 取值范围: true,仓库不存在,名称可用。 false,仓库存在,名称不可用。 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息
  • URI GET /v1/repositories/{repository_uuid}/members 表1 路径参数 参数 是否必选 参数类型 描述 repository_uuid 是 String 参数解释: 仓库UUID(由CreateRepository接口返回) 约束限制: 必传。 取值范围: 可包含数字、字母,长度32位。 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 page_index 否 Integer 参数解释: 第几页。 约束限制: 不涉及。 取值范围: 数字。 默认取值: 不涉及。 page_size 否 Integer 参数解释: 每页显示size。 约束限制: 不涉及。 取值范围: 数字。 默认取值: 不涉及。 subject 否 String 参数解释: 搜索关键字,模糊匹配用户名称、用户昵称、租户名称。 约束限制: 不涉及。 取值范围: 长度限制128个字符。 默认取值: 不涉及。
  • 响应示例 状态码: 200 OK { "id": "61366", "remark": "test12123", "ip_range": "1.0.0.1", "ip_type": 0, "ip_start": "1.0.0.1", "ip_end": "1.0.0.1", "view_flag": 0, "download_flag": 0, "upload_flag": 0, "created_at": "Nov 7, 2024 9:52:01 PM", "updated_at": "Nov 7, 2024 9:52:01 PM", "order_flag": 1, "repository_id": 2111965777}
  • 响应参数 状态码: 200 表4 响应Body参数(array) 参数 参数类型 描述 id String 关联结果 repository_id Integer 仓库ID ip_range String IP范围 ip_type Integer 格式类型,指定ip,ip范围,CIDR ip_start String 起始IP ip_end String 结束IP view_flag Integer 是否允许访问代码仓库 download_flag Integer 是否允许下载代码 upload_flag Integer 是否允许提交代码 remark String 备注 created_at String 创建时间 updated_at String 更新时间 order_flag Integer 排序 表5 Error 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 请求Body 表3 请求Body参数 参数 参数类型 描述 ip_type String 格式类型,指定IP,IP范围,CIDR ip_start String 起始IP ip_end String 结束IP view_flag String 是否允许访问代码仓库 download_flag String 是否允许下载代码 upload_flag String 是否允许提交代码 remark String 备注
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 参数解释: 响应错误码 result ReviewSettingDto object 参数解释: 返回新建检视意见的相关信息。 取值范围: 无。 status String 参数解释: 响应状态。 取值范围: success,表示接口调用成功。 failed,表示接口调用失败。 表4 Error 参数 参数类型 描述 code String 参数解释: 调用此接口失败时返回的错误码。 取值范围: CH.10000,系统繁忙,请稍后再试。 message String 参数解释: 调用此接口失败时返回的提示信息。 取值范围: “系统繁忙,请稍后再试”。 表5 ReviewSettingDto 参数 参数类型 描述 categories_and_modules_enabled Boolean 参数解释: 是否启用检视意见分类与模块。 取值范围: true:启用检视意见分类与模块。 false:禁用检视意见分类与模块。 secondary_category_enabled Boolean 参数解释: 是否启用系统预置检视意见分类。 取值范围: true:启用系统预置检视意见分类。 false:禁用系统预置检视意见分类,此时可勾选分类或添加自定义分类。 primary_categories Array of CategoryDto objects 参数解释: 已勾选的分类。 取值范围: 无。 review_default_categories Array of strings 参数解释: 已勾选的分类的key。 取值范围: 无。 review_customized_categories Array of strings 参数解释: 自定义分类。 取值范围: 数量限制:20条。 单条长度限制:200字符。 单条字符限制:unicode编码\u0000 - \uffff,不支持emoji表情、部分生僻字等特殊字符。 单条blank限制:不能为null或空字符串或全是空格。 review_modules Array of strings 参数解释: 检视意见模块。 取值范围: 数量限制:20条。 单条长度限制:200字符。 单条字符限制:unicode编码\u0000 - \uffff,不支持emoji表情、部分生僻字等特殊字符。 单条blank限制:不能为null或空字符串或全是空格。 source_id Integer 参数解释: 仓库id。 取值范围: 最小值:1 最大值:2147483647 source_type String 参数解释: 项目类型,目前仅支持一种。 取值范围: Project source_path String 参数解释: 仓库路径。 取值范围: 无。 secondary_category_type String 参数解释: 系统预置检视意见分类(废弃字段)。 取值范围: HiCode secondary_categories Array of CategoryDto objects 参数解释: 系统预置检视意见。 取值范围: 无。 表6 CategoryDto 参数 参数类型 描述 key String 参数解释: 系统预置检视意见分类的key。 取值范围: 无。 name_zh String 参数解释: 系统预置检视意见分类的中文名。 取值范围: 无。 name_en String 参数解释: 系统预置检视意见分类的英文名。 取值范围: 无。 sub_categories Array of CategoryDto objects 参数解释: 系统预置检视意见分类的子分类。 取值范围: 无。
  • 响应示例 状态码: 200 OK { "result": { "categories_and_modules_enabled": true, "secondary_category_enabled": false, "primary_categories": [ { "key": "realize", "name_zh": "算法实现", "name_en": "Algorithm" } ], "review_default_categories": [ "realize" ], "review_customized_categories": [ "分类" ], "review_modules": [ "模块" ], "source_id": 2111704470, "source_type": "Project", "source_path": "sll_test00006/mr_test" }, "status": "success"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Object Error 响应错误 result MergeChangesTreesDto object 参数解释: 响应结果。 status String 参数解释: 调用此接口的响应状态。 取值范围: success,表示接口调用成功。 failed,表示接口调用失败 表4 响应Error参数 参数 参数类型 描述 code String 参数解释: 调用此接口失败时返回的错误码。 取值范围: CH.10000,系统繁忙,请稍后再试。 message String 参数解释: 调用此接口失败时返回的提示信息。 取值范围: “系统繁忙,请稍后再试”。
  • 请求Body 表2 请求Body参数 参数 参数类型 描述 ip_type String 格式类型,指定IP,IP范围,CIDR ip_start String 起始IP ip_end String 结束IP view_flag String 是否允许访问代码仓库 download_flag String 是否允许下载代码 upload_flag String 是否允许提交代码 remark String 备注
  • 响应示例 状态码: 200 OK { "id": "58119", "remark": "", "ip_range": "2.2.2.5", "ip_type": 0, "ip_start": "2.2.2.5", "ip_end": "2.2.2.5", "view_flag": 1, "download_flag": 1, "upload_flag": 1, "created_at": "Nov 6, 2024 4:58:05 PM", "updated_at": "Nov 6, 2024 4:58:05 PM", "order_flag": 1, "user_id": 7574, "domain_id": "********************************" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 关联结果 user_id Integer 用户ID domain_id String 租户ID ip_range String Ip范围 ip_type Integer 响应错误 ip_start String 起始IP ip_end String 结束IP view_flag Integer 是否允许访问代码仓库 download_flag Integer 是否允许下载代码 upload_flag Integer 是否允许提交代码 remark String 备注 created_at String 创建时间 updated_at String 更新时间 order_flag Integer 排序 表4 Error 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • V2Project 接口 说明 查询用户的所有仓库 获取用户的所有仓库信息。 创建项目、仓库 创建项目后,创建仓库组由后台生成方式 传入参数:仓库名、模板id、是否导入项目成员、归属项目。 创建项目并fork仓库 创建仓库后fork仓库 传入参数:仓库名、是否导入项目成员、归属项目。 查询项目下的所有仓库 获取仓库列表,模糊查询支持范围,如果未传入project uuid,则支持按仓库名或项目名模糊查询,否则,只按仓库名模糊匹配。 分支关联工作项 分支关联工作项。
  • Repository 接口 说明 获取分支目录下的文件 获取分支目录下的文件。 获取仓库统计数据 获取仓库统计数据。 获取一个仓库下特定分支的图片文件 获取一个仓库下特定分支的图片文件。 修改被流水线引用的仓库状态 修改被流水线引用的仓库状态。 判断用户是否有仓库的管理员权限 判断用户是否有仓库的管理员权限。 设置仓库是公开状态还是私有状态 设置仓库是公开状态还是私有状态。 获取一个仓库下特定分支指定文件内容 获取一个仓库下特定分支指定文件内容。 获取公开示例模板列表 获取公开示例模板列表。 创建仓库 用指定的名称在指定项目上创建仓库。传入参数:仓库名、模板id、是否导入项目成员、归属项目。 根据仓库名组名获取仓库短id,用以拼接与commitid对应提交详情页面url 获取仓库短id,用于获取仓库详情页面url。 根据组名和仓库名查询某仓库某分支对应的提交 根据仓库组名、仓库名和分支获取提交列表。 查询某仓库对应的分支 根据仓库id获取指定仓库的分支列表。 根据仓库id查询仓库某分支对应的提交,提供更多可选参数 根据仓库id查询仓库某分支对应的提交。 添加部署密钥 添加部署密钥。 删除仓库部署密钥 删除仓库部署密钥。 获取仓库上一次的提交统计信息 获取仓库上一次的提交统计信息。 仓库统计 根据仓库短id,查询仓库的代码提交记录统计。 删除仓库 根据仓库32位uuid删除指定的仓库。 查看仓库的创建状态 获取仓库状态。 查询某仓库的标签列表 查询指定仓库对应的分支。 新建标签 新建标签。 查询某个仓库的详细信息 根据仓库UUID获取仓库信息仓库信息。返回 包含id,name,组名,仓库访问URL。 获取代码提交行数 获取指定日期内代码仓指定分支的代码提交行数。 下载仓库 按照指定格式下载仓库。 新建保护分支 新建保护分支。 获取仓库分支列表 获取仓库分支列表。 获取仓库合并请求列表 获取仓库合并请求列表。 获取仓库合并请求详情 获取仓库合并请求详情。
  • Commit 接口 说明 查询某个仓库的提交信息 根据仓库短ID获取提交信息,支持根据文件路径,查询这个路径下所有的commits列表。 创建提交 能够一次提交位于不同目录的多个文件,目录不存在时,能自动创建目录。支持强制覆盖选项,当选择强制覆盖标志为true时,忽略冲突,强制提交。 查询某个仓库的特定提交信息 获取由commit id或分支或标记的名称标识的特定提交。 查询某个仓库的提交差异信息 根据commit id查询提交差异信息。