备案控制台
文档
产品文档
输入文档关键字查找
首页 云效 开发参考 API手册（新版） API概览

API概览

更新时间：
一键部署
提交缺陷
产品详情
相关技术圈
我的收藏
本产品（云效2020/2021-06-25）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

代码管理

API标题API概述
文件文件
CreateFile创建文件创建代码库文件。
DeleteFile删除文件删除代码库指定文件。
UpdateFile修改文件修改代码库某个文件。
GetFileBlobs查询文件内容查询代码库某个文件的具体内容。
ListRepositoryTree查询文件树查询代码库的文件树。
提交提交
GetFileLastCommit查询文件最近一次提交信息查询指定文件的最近一次Git提交。
GetRepositoryCommit查询代码库提交信息查询代码库的单个提交信息。
ListRepositoryCommits查询代码库提交列表查询代码库的提交历史信息，支持滚动分页。
ListRepositoryCommitDiff查询代码库单个提交的提交内容根据代码库ID（repositoryId）和SHA值（sha），可选上下文行数参数（contextLine），获取到当前代码库中单个提交的提交内容。
CreateCommitWithMultipleFiles多文件变更提交创建一个提交，并能够变更多个文件。一般在日常开发中，一个提交通常会有多个文件变动，当前API就是应用于该情况。
成员成员
AddRepositoryMember增加代码库成员增加代码库成员，以阿里云账号ID（aliyunPk）作为标识，支持以阿里云账号ID批量添加成员（aliyunPks以逗号作为分隔符号）。
AddGroupMember添加组成员添加代码组的成员。
DeleteRepositoryMember删除代码库成员根据阿里云账号ID来移除某个指定的代码库成员。
DeleteGroupMember删除组成员根据阿里云账号ID来删除指定代码组下的某个成员。
UpdateRepositoryMember更改代码库成员的权限根据代码库ID（repositoryId）、用户ID（userId）以及更新内容，更改当前代码库下对应成员的权限或角色。 注意：后续会将用户ID统一为阿里云账号ID（aliyunPk），请注意关注。
UpdateGroupMember修改组成员修改组成员，主要是成员的权限修改。
ListRepositoryMemberWithInherited查询代码库成员列表查询代码库成员列表，无分页。
GetProjectMember查询代码库成员根据阿里云账号ID（aliyunPk）查询代码库成员信息。
ListGroupMember查询组成员列表查询代码组下的成员列表，无分页，无排序。
仓库仓库
CreateRepository创建/导入代码库创建或者导入代码库。
DeleteRepository删除代码库删除代码库。（为了保证规范性，必须填写删除理由）。
UpdateRepository更新代码库更新代码库基本信息、常用设置。
TriggerRepositoryMirrorSync触发仓库同步从其他平台导入到Codeup的仓库，触发Codeup仓库从远程同步。
TransferRepository转移代码库转移代码库至指定的代码组，其中groupId和repositoryId均可使用全路径。
ListRepositories查询代码库列表查询代码库列表，支持分页、排序功能，支持关键字搜索，支持归档条件过滤。
GetRepository查询代码库查询代码库，支持按代码库ID和代码库路径(Path)查询。
分支分支
CreateBranch创建分支创建代码库分支。
CreateProtectdBranch创建保护分支创建代码库保护分支。
DeleteBranch删除分支删除代码库分支。
DeleteProtectedBranch删除保护分支删除代码库保护分支。
UpdateProtectedBranches更改保护分支设置更改保护分支设置。 支持对于保护分支规则的详细设置，包括分支、推送规则、合并规则、要求合并前通过代码评审以及要求合并前通过自动化状态检查。
GetBranchInfo查询分支信息查询代码库分支的信息。
ListRepositoryBranches查询代码库分支列表查询代码库分支列表。
ListProtectedBranches查询保护分支列表查询代码库保护分支列表。
合并请求合并请求
GetMergeRequest查询合并请求查询单个合并请求详情。
ListMergeRequests查询合并请求列表查询合并请求列表，支持分页、排序和筛选。 该API能同时查询旧版和新版的合并请求，若没有使用过旧版合并请求，或者已经没有旧版合并请求数据，那么直接忽略返回信息中跟旧版合并请求相关的字段。
CreateMergeRequest创建合并请求创建合并请求。
UpdateMergeRequest更新合并请求该API仅支持修改合并请求的标题和描述信息。
UpdateMergeRequestPersonnel更新合并请求的干系人更新合并请求的干系人，包含评审人、订阅人。
MergeMergeRequest合并合并请求合并当前合并请求。
ReviewMergeRequest评审合并请求评审合并请求，发表评审意见。
CloseMergeRequest关闭合并请求关闭指定的合并请求。
ReopenMergeRequest重新开启合并请求对关闭的合并请求重新打开，其中已合并的合并请求无法执行重新代开操作。
ListMergeRequestPatchSets查询合并请求版本列表查询合并请求下的所有版本信息，包括合并源的版本和合并目标的版本。
GetMergeRequestChangeTree查询合并请求Diff统计信息查询合并请求的Diff统计信息，包括总变更文件树、总新增行、总删减行以及每个文件的新增行与删减行。
ListMergeRequestFilesReads查询合并请求变更文件已读情况查询合并请求变更文件的已读情况，主要获取变更文件的已读人列表。
ListMergeRequestComments查询合并请求评论列表查询合并请求中的评论列表，不分页。其中，评论仅支持三级结构。
CreateComment创建合并请求评论创建合并请求评论，可创建整体评论和行内评论。创建的评论层级一般不要超过3层。
比较比较
GetCompareDetailCompare接口比较两个commit（branch和tag本质也是commit），返回两个commit之间的commits列表以及diff内容（可从diff内容中获取到文件变更树）。
提交状态提交状态
CreateCommitStatus添加提交状态记录给指定的Commit添加一条提交状态记录。
ListCommitStatuses查询提交状态列表查询提交状态列表，支持分页。
检查运行检查运行
CreateCheckRun添加检查运行记录添加检查运行记录，仅创建。
UpdateCheckRun更新检查运行更新check run记录信息，须当前身份与check run的写入人身份一致，才能进行更新。
GetCheckRun查询检查运行查询单个check run记录。
ListCheckRuns查询检查运行列表查询check run列表，支持分页功能。
标签标签
CreateTag创建标签Tag创建代码库标签（Tag）。
DeleteTag删除标签Tag删除代码库标签（Tag）。
GetRepositoryTag查询单个标签信息查询代码库的单个标签信息。
ListRepositoryTags查询标签列表查询代码库的标签（Tag）列表。
类标类标
CreateProjectLabel创建类标创建代码库类标。
UpdateProjectLabel更新类标更新代码库类标信息。
DeleteProjectLabel删除类标删除代码库类标。
ListProjectLabels查询类标列表查询代码库类标列表，支持分页、字段排序以及关键字搜索。
ListMergeRequestLabels查询合并请求类标列表查询指定合并请求下关联的类标列表。
LinkMergeRequestLabel关联合并请求将类标（Label）关联到合并请求中。
WebhookWebhook
AddWebhook创建代码库Webhook创建代码库Webhook。
DeleteRepositoryWebhook删除代码库Webhook删除代码库下的Webhook。
ListRepositoryWebhook查询代码仓库的webhook列表批量查询在代码仓库上配置的webhook记录，支持分页功能。
代码组代码组
CreateRepositoryGroup创建代码组创建代码组。
DeleteRepositoryGroup删除代码组删除某个指定的代码库。
UpdateGroup更新代码组信息更新单个代码组信息，以pathWithNamespace作为唯一标识。
GetGroupDetail查询代码组信息查询指定的某个代码组信息。
GetGroupByPath查询代码组信息（Path）根据代码组全路径查询代码组信息。
ListRepositoryGroups查询代码组列表查询代码组列表，支持分页、按创建时间和更新时间排序以及关键字搜索。
ListGroupRepositories查询代码组下的库列表根据代码组ID查询其组下的代码库列表。
推送评审推送评审
UpdatePushReviewOnOff推送评审模式开关打开或关闭指定代码库的推送评审设置（需要有管理员权限）。
推送规则推送规则
CreatePushRule创建推送规则创建推送规则。
UpdatePushRule更新推送规则更新指定的推送规则，更新方式为覆盖式更新，若是新增规则项，需要确保原有的也存在，否则会被新内容覆盖。
DeletePushRule删除推送规则删除指定的推送规则。
GetPushRule查询推送规则查询指定的推送规则。
ListPushRules查询推送规则列表查询指定代码库下的推送规则列表，无分页。
部署密钥部署密钥
CreateDeployKey创建部署密钥在代码库中创建新的部署密钥。
EnableDeployKey启用部署密钥启用代码库中已有的部署密钥。
SSH密钥SSH密钥
CreateUserKey创建用户SSH密钥创建当前用户的SSH-Key密钥。
DeleteUserKey删除指定的SSH密钥为当前用户删除指定的SSH密钥。
ListUserKeys查询SSH密钥列表查询当前用户的SSH密钥列表。
代码搜索代码搜索
ListSearchSourceCode搜索代码片段数据根据筛选条件搜索相应的代码片段。
ListSearchRepository搜索代码仓库数据根据查询条件搜索代码仓库数据。
ListSearchCommit搜索代码提交数据根据筛选条件搜索提交的相关数据。
GetSearchCodePreview查询预览代码片段根据文档ID和关键字获取到预览代码片段。
企业信息企业信息
GetCodeupOrganization查询Codeup仓库所属企业信息根据企业标识（云效企业ID或者企业路径）获取Codeup侧的企业信息。
ListOrganizations查询用户的企业列表查询当前用户的企业列表。
用户用户
GetUserInfo查询当前用户信息该接口用于获取Codeup侧的用户信息。
审计审计
ListUserResources获取用户有权限的资源获取指定用户名下的有权限的代码库和代码组信息，以及角色信息，支持分页，以用户维度进行分页。请注意，仅限企业管理员以上权限的用户可调用。
鉴权鉴权
CreateOAuthToken创建OAuthToken创建OAuthToken（此接口内测中，暂不支持使用）。

流水线

API标题API概述
服务连接服务连接
CreateServiceConnection创建服务连接创建服务连接
CreateServiceAuth创建服务授权创建服务授权
CreateServiceCredential创建服务证书创建用户名密码类型的证书
ListServiceCredentials获取服务证书列表获取服务证书列表
ListServiceAuths获取服务授权列表获取服务授权列表
ListServiceConnections获取服务连接列表可以获取服务连接列表。
主机部署主机部署
StopVMDeployOrder终止机器部署可以终止机器部署。
SkipVMDeployMachine跳过机器部署可以跳过机器部署。
RetryVMDeployMachine重试机器部署可以重试机器部署。
ResumeVMDeployOrder继续部署单运行可以继续部署单运行。
GetVMDeployOrder获取部署单详情可以获取部署单详情。
LogVMDeployMachine查询机器部署日志可以查询机器部署日志。
流水线分组流水线分组
CreatePipelineGroup创建流水线分组创建流水线分组。
DeletePipelineGroup删除流水线分组删除流水线分组。
JoinPipelineGroup将流水线加入流水线分组将流水线加入流水线分组。
UpdatePipelineGroup更新流水线分组更新流水线分组。
GetPipelineGroup获取流水线分组获取流水线分组。
ListPipelineGroupPipelines获取流水线分组下流水线列表获取流水线分组下流水线列表。
ListPipelineGroups获取流水线分组列表获取流水线分组列表。
标签标签
CreateFlowTag创建标签创建标签。
CreateFlowTagGroup创建标签分类创建标签分类。
DeleteFlowTagGroup删除标签分类删除标签分类。
DeleteFlowTag删除标签删除标签。
UpdateFlowTag更新标签更新标签。
UpdateFlowTagGroup更新标签分类更新标签分类。
GetFlowTagGroup获取标签分类获取标签分类。
ListFlowTagGroups获取流水线分类列表获取流水线分类列表。
其它其它
CreateSshKey创建企业公钥可以创建企业公钥。
ResetSshKey重置企业公钥可以重置企业公钥。
成员成员
CreateResourceMember插入资源成员可以插入资源成员。
DeleteResourceMember删除资源成员可以删除资源成员。
UpdateResourceMember更新资源成员可以更新资源成员。
ListResourceMembers获取资源成员列表可以获取资源成员列表。
主机组主机组
CreateHostGroup创建主机组可以创建主机组。
DeleteHostGroup删除主机组可以删除主机组。
UpdateHostGroup更新主机组可以更新主机组。
GetHostGroup获取主机组可以获取主机组。
ListHostGroups获取主机组列表可以获取主机组列表。
变量组变量组
CreateVariableGroup创建变量组可以创建变量组。
DeleteVariableGroup删除变量组可以删除变量组。
UpdateVariableGroup更新变量组可以更新变量组。
GetVariableGroup获取变量组可以获取变量组。
ListVariableGroups获取变量组列表可以获取变量组列表。
流水线流水线
CreatePipeline创建流水线创建流水线API，支持创建YAML化流水线。
DeletePipeline删除流水线可以删除流水线。
DeletePipelineRelations删除流水线关联
UpdatePipeline更新流水线只支持更新YAML化流水线。
StartPipelineRun运行流水线可以运行流水线。
StopPipelineJobRun终止流水线任务运行可以终止流水线任务运行。
StopPipelineRun终止流水线运行可以终止流水线运行。
UpdatePipelineBaseInfo更新流水线基本信息更新流水线基本信息。
RetryPipelineJobRun重试流水线任务运行可以重试流水线任务运行。
SkipPipelineJobRun跳过流水线任务运行可以跳过流水线任务运行。
PassPipelineValidate通过人工卡点可以通过人工卡点。
RefusePipelineValidate拒绝人工卡点可以拒绝人工卡点。
AddPipelineRelations添加流水线关联
GetPipeline获取流水线信息可以获取流水线信息。
GetPipelineRun获取流水线运行实例可以获取流水线运行实例。
ListPipelineRuns获取流水线运行实例列表可以获取流水线运行实例列表。
ListPipelines获取流水线列表获取流水线列表。
GetPipelineArtifactUrl获取流水线构建产物下载地址获取流水线构建产物下载地址。
GetPipelineEmasArtifactUrl获取流水线emas构建产物临时下载地址获取流水线emas构建产物临时下载地址。
GetPipelineScanReportUrl获取流水线扫描报告临时下载地址获取流水线扫描报告临时下载地址。
ListPipelineJobHistorys获取流水线任务的执行历史获取流水线任务的执行历史。
ListPipelineJobs按任务分类获取流水线执行的任务按任务分类获取流水线执行的任务。
LogPipelineJobRun查询任务运行日志可以查询任务运行日志。
ListPipelineRelations获取流水线关联列表

项目管理（Projex）

API标题API概述
工作项工作项
WorkitemAttachmentCreate关联文件为工作项的附件将文件作为工作项的附件，这是工作项上传附件的第三步，前两步可以查看 GetWorkitemAttachmentCreatemeta(获取工作项上传附件的信息) 接口的描述。
ListWorkitemAttachments获取工作项附件列表获取工作项附件列表。
CreateWorkitemV2创建工作项(需求/缺陷/任务)创建工作项，可以用于创建项目下的工作项，包含（需求、缺陷、任务、风险、主题等）。
CreateWorkitemRecord登记实际工时登记实际工时。
CreateWorkitem创建工作项创建工作项。
CreateWorkitemComment创建工作项评论创建工作项评论。
DeleteWorkitemComment删除当前工作项当前评论删除工作项下单个评论。
DeleteWorkitemAllComment删除当前工作项所有评论删除当前工作项所有评论。
UpdateWorkitemComment更新工作项评论更新工作项评论。
UpdateWorkItem更新工作项信息更新工作项信息。
GetWorkitemAttachmentCreatemeta获取工作项上传附件的信息获取工作项附件上传的信息接口，这是工作项上传附件中的第一步。整个过程需要完成三步， 第一步，调用该接口获取工作项的上传信息。 第二步，根据该接口的返回信息将文件上传到oss中。 第三步，将文件作为工作项的附件，对应的接口为 WorkitemAttachmentCreate(关联文件为工作项的附件) 第二步上传文件时可以参考oss的文档：https://help.aliyun.com/document_detail/31926.html， 注意请求为POST方法，数据是表单提交的方式。
GetWorkitemTimeTypeList获取工时类型列表获取工时类型列表。
GetWorkitemRelations获得工作项关联项获得工作项关联项。
GetWorkitemCommentList获得工作项的评论列表获得工作项的评论列表。
CreateWorkitemEstimate创建工作项预计工时接口创建预计工时接口，登记一个工作项预计花费工时信息。
GetCustomFieldOption获取字段自定义选项获取字段自定义选项。
GetWorkItemActivity查询工作项动态查询工作项动态信息。
GetWorkItemInfo获取工作项基本信息获取工作项的基本信息。
GetWorkItemWorkFlowInfo获取工作项工作流信息获取工作项工作流信息。
ListProjectWorkitemTypes获取工作项类型获取项目中的工作项类型。
ListWorkItemAllFields获取工作项字段列表获取工作项字段列表。
ListWorkItemWorkFlowStatus获取工作项工作流状态列表获取工作项工作流状态列表。
ListWorkitems获取工作项列表获取工作项列表。
ListWorkitemTime获取工作项工时明细列表获取工作项工时明细列表。
ListWorkitemEstimate获取工作项预计工时列表获取工作项预计工时登记列表
UpdateWorkitemField更新工作项字段更新工作项字段，可以支持批量更新多个字段。
DeleteWorkitem删除工作项删除工作项。
GetWorkitemFile获取工作项文件信息获取工作项的文件信息，例如工作项的描述中的图片信息。
项目项目
CreateProject创建项目可以创建项目。
CreateSprint创建迭代可以创建项目的迭代。
DeleteProject删除项目可以删除项目。
UpdateProjectMember添加更新项目成员添加项目成员。
UpdateProjectField更新项目属性与字段更新项目自身属性与自定义字段，以及项目状态
GetProjectInfo获取项目详情根据projectId获取项目基本信息。
ListProjectMembers获取项目成员获取项目成员。
GetSprintInfo获取迭代详情获取迭代详情。
ListProjects获取项目列表获取项目列表，支持条件搜索。
ListProjectTemplates获取项目模板列表获取项目模板列表。
ListSprints获取迭代列表获取迭代列表。

测试管理

API标题API概述
测试用例库测试用例库
CreateTestCase创建测试用例用例库中创建测试用例
UpdateTestCase更新用例库测试用例属性更新用例库测试用例属性，包括标题，目录，自定义字段信息等，但是不能用来更新测试用例的测试内容相关信息
ListTestCaseFields获取测试用例字段列表
GetTestcaseList获取用例库测试用例列表获取测试用例库中的测试用例列表，支持条件过滤
测试计划测试计划
UpdateTestResult更新测试计划中测试用例结果更新测试计划中的用例的执行状态和执行人
GetTestResultList获取测试计划中测试用例列表获取测试计划中测试用例列表，支持使用条件过滤

企业和成员

API标题API概述
ListOrganizationMembers查询企业成员信息列表根据指定条件获取企业成员信息。
GetOrganizationMember查询企业成员信息根据指定条件获取企业成员信息。
ListJoinedOrganizations查询加入的企业列表查询当前账号加入的企业列表。

应用交付

API标题API概述
应用应用
GetApplication查询应用详情查询应用详情。
UpdateApplication更新应用更新应用的拥有者。
ListApplications查询应用列表查询应用列表信息。
CreateAppMembers创建应用成员创建应用成员。
UpdateAppMember更新应用成员更新应用成员。
DeleteAppMember删除应用成员删除应用成员。
ListApplicationMembers查询应用成员列表查询应用成员列表。

即将下线

API标题API概述
ReleaseWorkspace释放工作空间当用户工作空间不再需要持续保持，可释放工作空间（一旦删除，空间内的数据将不可恢复）。
CreateWorkspace创建工作空间可以创建工作空间。
ListWorkspaces查询工作空间列表查询工作空间列表。
GetWorkspace查询工作空间详情查询工作空间基本信息。
FrozenWorkspace冻结工作空间当用户运行中的工作空间数量到达限制配额，可主动冻结工作空间（冻结前的代码数据已自动备份）。
ListUserDrawRecordByPk查询抽奖结果此API用于云效通义灵码运营相关活动使用
文档推荐
  • 本页导读 （0）
文档反馈