代码管理
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 文件 | ||
CreateFile | 创建代码库文件 | 查看文档去调试 |
| GetFileBlobs | 查询代码库某个文件的具体内容 | 查看文档去调试 |
| ListRepositoryTree | 查询代码库的文件树 | 查看文档去调试 |
| UpdateFile | 修改代码库某个文件 | 查看文档去调试 |
| DeleteFile | 删除代码库指定文件 | 查看文档去调试 |
| 提交 | ||
| CreateCommitWithMultipleFiles | 创建一个提交，并能够变更多个文件。一般在日常开发中，一个提交通常会有多个文件变动，当前API就是应用于该情况 | 查看文档去调试 |
| GetFileLastCommit | 查询指定文件的最近一次Git提交 | 查看文档去调试 |
| GetRepositoryCommit | 查询代码库的单个提交信息 | 查看文档去调试 |
| ListRepositoryCommits | 查询代码库的提交历史信息，支持滚动分页 | 查看文档去调试 |
| ListRepositoryCommitDiff | 根据代码库ID（repositoryId）和SHA值（sha），可选上下文行数参数（contextLine），获取到当前代码库中单个提交的提交内容 | 查看文档去调试 |
| 成员 | ||
| AddRepositoryMember | 增加代码库成员，以阿里云账号ID（aliyunPk）作为标识，支持以阿里云账号ID批量添加成员（aliyunPks以逗号作为分隔符号） | 查看文档去调试 |
| AddGroupMember | 添加代码组的成员 | 查看文档去调试 |
| ListRepositoryMemberWithInherited | 查询代码库成员列表，无分页 | 查看文档去调试 |
| GetProjectMember | 根据阿里云账号ID（aliyunPk）查询代码库成员信息 | 查看文档去调试 |
| ListGroupMember | 查询代码组下的成员列表，无分页，无排序 | 查看文档去调试 |
| UpdateRepositoryMember | 根据代码库ID（repositoryId）、用户ID（userId）以及更新内容，更改当前代码库下对应成员的权限或角色。 注意：后续会将用户ID统一为阿里云账号ID（aliyunPk），请注意关注 | 查看文档去调试 |
| UpdateGroupMember | 修改组成员，主要是成员的权限修改 | 查看文档去调试 |
| DeleteRepositoryMember | 根据阿里云账号ID来移除某个指定的代码库成员 | 查看文档去调试 |
| DeleteGroupMember | 根据阿里云账号ID来删除指定代码组下的某个成员 | 查看文档去调试 |
| 仓库 | ||
| CreateRepository | 创建或者导入代码库 | 查看文档去调试 |
| ListRepositories | 查询代码库列表，支持分页、排序功能，支持关键字搜索，支持归档条件过滤 | 查看文档去调试 |
| GetRepository | 查询代码库，支持按代码库ID和代码库路径(Path)查询 | 查看文档去调试 |
| UpdateRepository | 更新代码库基本信息、常用设置 | 查看文档去调试 |
| TriggerRepositoryMirrorSync | 从其他平台导入到Codeup的仓库，触发Codeup仓库从远程同步 | 查看文档去调试 |
| TransferRepository | 转移代码库至指定的代码组，其中groupId和repositoryId均可使用全路径 | 查看文档去调试 |
| DeleteRepository | 删除代码库。（为了保证规范性，必须填写删除理由） | 查看文档去调试 |
| 分支 | ||
| CreateBranch | 创建代码库分支 | 查看文档去调试 |
| CreateProtectdBranch | 创建代码库保护分支 | 查看文档去调试 |
| GetBranchInfo | 查询代码库分支的信息 | 查看文档去调试 |
| ListRepositoryBranches | 查询代码库分支列表 | 查看文档去调试 |
| ListProtectedBranches | 查询代码库保护分支列表 | 查看文档去调试 |
| UpdateProtectedBranches | 更改保护分支设置。 支持对于保护分支规则的详细设置，包括分支、推送规则、合并规则、要求合并前通过代码评审以及要求合并前通过自动化状态检查 | 查看文档去调试 |
| DeleteBranch | 删除代码库分支 | 查看文档去调试 |
| DeleteProtectedBranch | 删除代码库保护分支 | 查看文档去调试 |
| 合并请求 | ||
| CreateMergeRequest | 创建合并请求 | 查看文档去调试 |
| CreateComment | 创建合并请求评论，可创建整体评论和行内评论。创建的评论层级一般不要超过3层 | 查看文档去调试 |
| GetMergeRequest | 查询单个合并请求详情 | 查看文档去调试 |
| ListMergeRequests | 查询合并请求列表，支持分页、排序和筛选。 该API能同时查询旧版和新版的合并请求，若没有使用过旧版合并请求，或者已经没有旧版合并请求数据，那么直接忽略返回信息中跟旧版合并请求相关的字段 | 查看文档去调试 |
| ListMergeRequestPatchSets | 查询合并请求下的所有版本信息，包括合并源的版本和合并目标的版本 | 查看文档去调试 |
| GetMergeRequestChangeTree | 查询合并请求的Diff统计信息，包括总变更文件树、总新增行、总删减行以及每个文件的新增行与删减行 | 查看文档去调试 |
| ListMergeRequestFilesReads | 查询合并请求变更文件的已读情况，主要获取变更文件的已读人列表 | 查看文档去调试 |
| ListMergeRequestComments | 查询合并请求中的评论列表，不分页。其中，评论仅支持三级结构 | 查看文档去调试 |
| UpdateMergeRequest | 该API仅支持修改合并请求的标题和描述信息 | 查看文档去调试 |
| UpdateMergeRequestPersonnel | 更新合并请求的干系人，包含评审人、订阅人 | 查看文档去调试 |
| MergeMergeRequest | 合并当前合并请求 | 查看文档去调试 |
| ReviewMergeRequest | 评审合并请求，发表评审意见 | 查看文档去调试 |
| CloseMergeRequest | 关闭指定的合并请求 | 查看文档去调试 |
| ReopenMergeRequest | 对关闭的合并请求重新打开，其中已合并的合并请求无法执行重新代开操作 | 查看文档去调试 |
| 比较 | ||
| GetCompareDetail | 比较两个commit（branch和tag本质也是commit），返回两个commit之间的commits列表以及diff内容（可从diff内容中获取到文件变更树） | 查看文档去调试 |
| 提交状态 | ||
| CreateCommitStatus | 给指定的Commit添加一条提交状态记录 | 查看文档去调试 |
| ListCommitStatuses | 查询提交状态列表，支持分页 | 查看文档去调试 |
| 检查运行 | ||
| CreateCheckRun | 添加检查运行记录，仅创建 | 查看文档去调试 |
| GetCheckRun | 查询单个check run记录 | 查看文档去调试 |
| ListCheckRuns | 查询check run列表，支持分页功能 | 查看文档去调试 |
| UpdateCheckRun | 更新check run记录信息，须当前身份与check run的写入人身份一致，才能进行更新 | 查看文档去调试 |
| 标签 | ||
| CreateTag | 创建代码库标签（Tag） | 查看文档去调试 |
| GetRepositoryTag | 查询代码库的单个标签信息 | 查看文档去调试 |
| ListRepositoryTags | 查询代码库的标签（Tag）列表 | 查看文档去调试 |
| DeleteTag | 删除代码库标签（Tag） | 查看文档去调试 |
| 类标 | ||
| CreateProjectLabel | 创建代码库类标 | 查看文档去调试 |
| ListProjectLabels | 查询代码库类标列表，支持分页、字段排序以及关键字搜索 | 查看文档去调试 |
| ListMergeRequestLabels | 查询指定合并请求下关联的类标列表 | 查看文档去调试 |
| UpdateProjectLabel | 更新代码库类标信息 | 查看文档去调试 |
| LinkMergeRequestLabel | 将类标（Label）关联到合并请求中 | 查看文档去调试 |
| DeleteProjectLabel | 删除代码库类标 | 查看文档去调试 |
| Webhook | ||
| AddWebhook | 创建代码库Webhook | 查看文档去调试 |
| ListRepositoryWebhook | 批量查询在代码仓库上配置的webhook记录，支持分页功能 | 查看文档去调试 |
| DeleteRepositoryWebhook | 删除代码库下的Webhook | 查看文档去调试 |
| 代码组 | ||
| CreateRepositoryGroup | 创建代码组 | 查看文档去调试 |
| GetGroupDetail | 查询指定的某个代码组信息 | 查看文档去调试 |
| GetGroupByPath | 根据代码组全路径查询代码组信息 | 查看文档去调试 |
| ListRepositoryGroups | 查询代码组列表，支持分页、按创建时间和更新时间排序以及关键字搜索 | 查看文档去调试 |
| ListGroupRepositories | 根据代码组ID查询其组下的代码库列表 | 查看文档去调试 |
| UpdateGroup | 更新单个代码组信息，以pathWithNamespace作为唯一标识 | 查看文档去调试 |
| DeleteRepositoryGroup | 删除某个指定的代码库 | 查看文档去调试 |
| 推送评审 | ||
| UpdatePushReviewOnOff | 打开或关闭指定代码库的推送评审设置（需要有管理员权限） | 查看文档去调试 |
| 推送规则 | ||
| CreatePushRule | 创建推送规则 | 查看文档去调试 |
| ListPushRules | 查询指定代码库下的推送规则列表，无分页 | 查看文档去调试 |
| UpdatePushRule | 更新指定的推送规则，更新方式为覆盖式更新，若是新增规则项，需要确保原有的也存在，否则会被新内容覆盖 | 查看文档去调试 |
| DeletePushRule | 删除指定的推送规则 | 查看文档去调试 |
| 部署密钥 | ||
| CreateDeployKey | 在代码库中创建新的部署密钥 | 查看文档去调试 |
| EnableDeployKey | 启用代码库中已有的部署密钥 | 查看文档去调试 |
| SSH密钥 | ||
| CreateUserKey | 创建当前用户的SSH-Key密钥 | 查看文档去调试 |
| ListUserKeys | 查询当前用户的SSH密钥列表 | 查看文档去调试 |
| DeleteUserKey | 为当前用户删除指定的SSH密钥 | 查看文档去调试 |
| 代码搜索 | ||
| ListSearchSourceCode | 根据筛选条件搜索相应的代码片段 | 查看文档去调试 |
| ListSearchRepository | 根据查询条件搜索代码仓库数据 | 查看文档去调试 |
| ListSearchCommit | 根据筛选条件搜索提交的相关数据 | 查看文档去调试 |
| GetSearchCodePreview | 根据文档ID和关键字获取到预览代码片段 | 查看文档去调试 |
| 企业信息 | ||
| GetCodeupOrganization | 根据企业标识（云效企业ID或者企业路径）获取Codeup侧的企业信息 | 查看文档去调试 |
| ListOrganizations | 查询当前用户的企业列表 | 查看文档去调试 |
| 用户 | ||
| GetUserInfo | 该接口用于获取Codeup侧的用户信息 | 查看文档去调试 |
| 审计 | ||
| ListUserResources | 获取指定用户名下的有权限的代码库和代码组信息，以及角色信息，支持分页，以用户维度进行分页。请注意，仅限企业管理员以上权限的用户可调用 | 查看文档去调试 |
| 鉴权 | ||
| CreateOAuthToken | 创建OAuthToken（此接口内测中，暂不支持使用） | 查看文档去调试 |
流水线
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 服务连接 | ||
| CreateServiceConnection | 创建服务连接 | 查看文档去调试 |
| CreateServiceAuth | 创建服务授权 | 查看文档去调试 |
| CreateServiceCredential | 创建用户名密码类型的证书 | 查看文档去调试 |
| ListServiceCredentials | 获取服务证书列表 | 查看文档去调试 |
| ListServiceAuths | 获取服务授权列表 | 查看文档去调试 |
| ListServiceConnections | 可以获取服务连接列表 | 查看文档去调试 |
| 主机部署 | ||
| GetVMDeployOrder | 可以获取部署单详情 | 查看文档去调试 |
| LogVMDeployMachine | 可以查询机器部署日志 | 查看文档去调试 |
| StopVMDeployOrder | 可以终止机器部署 | 查看文档去调试 |
| SkipVMDeployMachine | 可以跳过机器部署 | 查看文档去调试 |
| RetryVMDeployMachine | 可以重试机器部署 | 查看文档去调试 |
| ResumeVMDeployOrder | 可以继续部署单运行 | 查看文档去调试 |
| 流水线分组 | ||
| CreatePipelineGroup | 创建流水线分组 | 查看文档去调试 |
| GetPipelineGroup | 获取流水线分组 | 查看文档去调试 |
| ListPipelineGroupPipelines | 获取流水线分组下流水线列表 | 查看文档去调试 |
| ListPipelineGroups | 获取流水线分组列表 | 查看文档去调试 |
| JoinPipelineGroup | 将流水线加入流水线分组 | 查看文档去调试 |
| UpdatePipelineGroup | 更新流水线分组 | 查看文档去调试 |
| DeletePipelineGroup | 删除流水线分组 | 查看文档去调试 |
| 标签 | ||
| CreateFlowTag | 创建标签 | 查看文档去调试 |
| CreateFlowTagGroup | 创建标签分类 | 查看文档去调试 |
| GetFlowTagGroup | 获取标签分类 | 查看文档去调试 |
| ListFlowTagGroups | 获取流水线分类列表 | 查看文档去调试 |
| UpdateFlowTag | 更新标签 | 查看文档去调试 |
| UpdateFlowTagGroup | 更新标签分类 | 查看文档去调试 |
| DeleteFlowTagGroup | 删除标签分类 | 查看文档去调试 |
| DeleteFlowTag | 删除标签 | 查看文档去调试 |
| 其它 | ||
| CreateSshKey | 可以创建企业公钥 | 查看文档去调试 |
| ResetSshKey | 可以重置企业公钥 | 查看文档去调试 |
| 成员 | ||
| CreateResourceMember | 可以插入资源成员 | 查看文档去调试 |
| ListResourceMembers | 可以获取资源成员列表 | 查看文档去调试 |
| UpdateResourceMember | 可以更新资源成员 | 查看文档去调试 |
| DeleteResourceMember | 可以删除资源成员 | 查看文档去调试 |
| 主机组 | ||
| CreateHostGroup | 可以创建主机组 | 查看文档去调试 |
| GetHostGroup | 可以获取主机组 | 查看文档去调试 |
| ListHostGroups | 可以获取主机组列表 | 查看文档去调试 |
| UpdateHostGroup | 可以更新主机组 | 查看文档去调试 |
| DeleteHostGroup | 可以删除主机组 | 查看文档去调试 |
| 变量组 | ||
| CreateVariableGroup | 可以创建变量组 | 查看文档去调试 |
| GetVariableGroup | 可以获取变量组 | 查看文档去调试 |
| ListVariableGroups | 可以获取变量组列表 | 查看文档去调试 |
| UpdateVariableGroup | 可以更新变量组 | 查看文档去调试 |
| DeleteVariableGroup | 可以删除变量组 | 查看文档去调试 |
| 流水线 | ||
| CreatePipeline | 创建流水线API，支持创建YAML化流水线 | 查看文档去调试 |
| GetPipeline | 可以获取流水线信息 | 查看文档去调试 |
| GetPipelineRun | 可以获取流水线运行实例 | 查看文档去调试 |
| ListPipelineRuns | 可以获取流水线运行实例列表 | 查看文档去调试 |
| ListPipelines | 获取流水线列表 | 查看文档去调试 |
| GetPipelineArtifactUrl | 获取流水线构建产物下载地址 | 查看文档去调试 |
| GetPipelineEmasArtifactUrl | 获取流水线emas构建产物临时下载地址 | 查看文档去调试 |
| GetPipelineScanReportUrl | 获取流水线扫描报告临时下载地址 | 查看文档去调试 |
| ListPipelineJobHistorys | 获取流水线任务的执行历史 | 查看文档去调试 |
| ListPipelineJobs | 按任务分类获取流水线执行的任务 | 查看文档去调试 |
| LogPipelineJobRun | 可以查询任务运行日志 | 查看文档去调试 |
| ListPipelineRelations | 获取流水线关联列表 | 查看文档去调试 |
| UpdatePipeline | 只支持更新YAML化流水线 | 查看文档去调试 |
| StartPipelineRun | 可以运行流水线 | 查看文档去调试 |
| StopPipelineJobRun | 可以终止流水线任务运行 | 查看文档去调试 |
| StopPipelineRun | 可以终止流水线运行 | 查看文档去调试 |
| UpdatePipelineBaseInfo | 更新流水线基本信息 | 查看文档去调试 |
| RetryPipelineJobRun | 可以重试流水线任务运行 | 查看文档去调试 |
| SkipPipelineJobRun | 可以跳过流水线任务运行 | 查看文档去调试 |
| PassPipelineValidate | 可以通过人工卡点 | 查看文档去调试 |
| RefusePipelineValidate | 可以拒绝人工卡点 | 查看文档去调试 |
| AddPipelineRelations | 添加流水线关联 | 查看文档去调试 |
| DeletePipeline | 可以删除流水线 | 查看文档去调试 |
| DeletePipelineRelations | 删除流水线关联 | 查看文档去调试 |
项目管理（Projex）
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 工作项 | ||
| WorkitemAttachmentCreate | 将文件作为工作项的附件，这是工作项上传附件的第三步，前两步可以查看 GetWorkitemAttachmentCreatemeta(获取工作项上传附件的信息) 接口的描述 | 查看文档去调试 |
| CreateWorkitemV2 | 创建工作项，可以用于创建项目下的工作项，包含（需求、缺陷、任务、风险、主题等） | 查看文档去调试 |
| CreateWorkitemRecord | 登记实际工时 | 查看文档去调试 |
| CreateWorkitem | 创建工作项 | 查看文档去调试 |
| CreateWorkitemComment | 创建工作项评论 | 查看文档去调试 |
| CreateWorkitemEstimate | 创建预计工时接口，登记一个工作项预计花费工时信息 | 查看文档去调试 |
| ListWorkitemAttachments | 获取工作项附件列表 | 查看文档去调试 |
| GetWorkitemAttachmentCreatemeta | 获取工作项附件上传的信息接口，这是工作项上传附件中的第一步。整个过程需要完成三步， 第一步，调用该接口获取工作项的上传信息。 第二步，根据该接口的返回信息将文件上传到oss中。 第三步，将文件作为工作项的附件，对应的接口为 WorkitemAttachmentCreate(关联文件为工作项的附件) 第二步上传文件时可以参考oss的文档：https://help.aliyun.com/document_detail/31926.html， 注意请求为POST方法，数据是表单提交的方式 | 查看文档去调试 |
| GetWorkitemTimeTypeList | 获取工时类型列表 | 查看文档去调试 |
| GetWorkitemRelations | 获得工作项关联项 | 查看文档去调试 |
| GetWorkitemCommentList | 获得工作项的评论列表 | 查看文档去调试 |
| GetCustomFieldOption | 获取字段自定义选项 | 查看文档去调试 |
| GetWorkItemActivity | 查询工作项动态信息 | 查看文档去调试 |
| GetWorkItemInfo | 获取工作项的基本信息 | 查看文档去调试 |
| GetWorkItemWorkFlowInfo | 获取工作项工作流信息 | 查看文档去调试 |
| ListProjectWorkitemTypes | 获取项目中的工作项类型 | 查看文档去调试 |
| ListWorkItemAllFields | 获取工作项字段列表 | 查看文档去调试 |
| ListWorkItemWorkFlowStatus | 获取工作项工作流状态列表 | 查看文档去调试 |
| ListWorkitems | 获取工作项列表 | 查看文档去调试 |
| ListWorkitemTime | 获取工作项工时明细列表 | 查看文档去调试 |
| ListWorkitemEstimate | 获取工作项预计工时登记列表 | 查看文档去调试 |
| GetWorkitemFile | 获取工作项的文件信息，例如工作项的描述中的图片信息 | 查看文档去调试 |
| UpdateWorkitemComment | 更新工作项评论 | 查看文档去调试 |
| UpdateWorkItem | 更新工作项信息 | 查看文档去调试 |
| UpdateWorkitemField | 更新工作项字段，可以支持批量更新多个字段 | 查看文档去调试 |
| DeleteWorkitemComment | 删除工作项下单个评论 | 查看文档去调试 |
| DeleteWorkitemAllComment | 删除当前工作项所有评论 | 查看文档去调试 |
| DeleteWorkitem | 删除工作项 | 查看文档去调试 |
| 项目 | ||
| CreateProject | 可以创建项目 | 查看文档去调试 |
| CreateSprint | 可以创建项目的迭代 | 查看文档去调试 |
| GetProjectInfo | 根据projectId获取项目基本信息 | 查看文档去调试 |
| ListProjectMembers | 获取项目成员 | 查看文档去调试 |
| GetSprintInfo | 获取迭代详情 | 查看文档去调试 |
| ListProjects | 获取项目列表，支持条件搜索 | 查看文档去调试 |
| ListProjectTemplates | 获取项目模板列表 | 查看文档去调试 |
| ListSprints | 获取迭代列表 | 查看文档去调试 |
| UpdateProjectMember | 添加项目成员 | 查看文档去调试 |
| UpdateProjectField | 更新项目自身属性与自定义字段，以及项目状态 | 查看文档去调试 |
| DeleteProject | 可以删除项目 | 查看文档去调试 |
效能洞察
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| ExportWorkitemActivity | 获取效能洞察中指定企业的workitem_activity表数据 | 查看文档去调试 |
| ExportInsightWorkitemVersion | 获取效能洞察中指定企业的workitem_version表数据 | 查看文档去调试 |
| ExportInsightWorkitemStatusJoinWorkitemDefectExtra | 获取效能洞察中指定企业的workitem_status表 join worktem_defect_extra表数据 | 查看文档去调试 |
| ExportInsightWorkitemStatus | 获取效能洞察中指定企业的workitem_status表数据 | 查看文档去调试 |
| ExportInsightWorkTime | 获取效能洞察中指定企业的workitem_time表数据 | 查看文档去调试 |
| ExportInsightTagRef | 获取效能洞察中指定企业的tag_ref表数据 | 查看文档去调试 |
| ExportInsightSprint | 获取效能洞察中指定企业的sprint表数据 | 查看文档去调试 |
| ExportInsightSpaceRef | 获取效能洞察中指定企业的space_ref表数据 | 查看文档去调试 |
| ExportInsightSpace | 获取效能洞察中指定企业的space表数据 | 查看文档去调试 |
| ExportInsightField | 获取效能洞察中指定企业的field表数据 | 查看文档去调试 |
| ExportInsightExpectedWorkTime | 获取效能洞察中指定企业的expected_work_time表数据 | 查看文档去调试 |
| ExportInsightCustomValue | 获取效能洞察中指定企业的custom_value表数据 | 查看文档去调试 |
应用交付
| OpenAPI 名称 | 描述 | 操作 |
|---|---|---|
| 应用 | ||
| GetApplication | 查询应用详情 | 查看文档去调试 |
| ListApplications | 查询应用列表信息 | 查看文档去调试 |
| UpdateApplication | 更新应用的拥有者 | 查看文档去调试 |
| 应用成员 | ||
| CreateAppMembers | 创建应用成员 | 查看文档去调试 |
| ListApplicationMembers | 查询应用成员列表 | 查看文档去调试 |
| UpdateAppMember | 更新应用成员 | 查看文档去调试 |
| DeleteAppMember | 删除应用成员 | 查看文档去调试 |
| 应用研发流程 | ||
| GetReleaseStagePipelineRun | 可以获取研发阶段流水线运行实例相关信息 | 查看文档去调试 |
| ListAllReleaseWorkflows | 查找应用下所有的研发流程 | 查看文档去调试 |
| ListAppReleaseStageExecutions | 批量查询研发阶段执行记录 | 查看文档去调试 |
| ListAppReleaseStageExecutionIntegratedMetadata | 查询研发阶段执行记录集成变更信息 | 查看文档去调试 |
| ExecuteChangeRequestReleaseStage | 可以执行研发阶段流水线 | 查看文档去调试 |
| CancelExecutionReleaseStage | 可以取消执行研发阶段流水线 | 查看文档去调试 |
| RefuseReleaseStagePipelineValidate | 可以拒绝研发阶段流水线中的人工卡点 | 查看文档去调试 |
| PassReleaseStagePipelineValidate | 可以通过研发阶段流水线中的人工卡点 | 查看文档去调试 |
| 变更 | ||
| CreateChangeRequest | 创建应用变更 | 查看文档去调试 |
| ListChangeRequests | 查询变更列表 | 查看文档去调试 |
| ListChangeRequestWorkflowExecutions | 查询变更研发流程运行记录 | 查看文档去调试 |