CODING API
产品
  • 代码托管
  • 持续集成
  • 项目协同
  • 测试管理
  • Orbit 应用管理
解决方案
  • DevOps
  • 代码质量
  • OKR
客户案例
支持
  • 帮助中心
  • 洞见
产品
  • 代码托管
  • 持续集成
  • 项目协同
  • 测试管理
  • Orbit 应用管理
解决方案
  • DevOps
  • 代码质量
  • OKR
客户案例
支持
  • 帮助中心
  • 洞见
  1. 持续部署
  • 团队
    • 删除 Wiki
      POST
    • 修改测试计划
      POST
  • 项目
    • 更新 Wiki
      POST
    • 删除测试计划
      POST
    • 查询制品仓库列表
      POST
    • 绑定 CD 应用到项目
      POST
    • 触发构建
      POST
    • 获取合并请求文件修改记录
      POST
    • 设置保护分支
      POST
  • 项目设置
    • 获取详情
    • 归档测试计划
    • 查询制品仓库可下载文件列表
    • 根据项目名获取关联应用列表
  • 提交
    • 通过 ZIP 包更新任务状态查询
    • 测试用例添加测试结果
    • 查询制品文件临时下载链接
    • 获取 CD 任务执行记录
    • 获取构建任务阶段
    • 关闭合并请求
    • 查询保护分支状态
    • 创建仓库版本
    • 查询提交详情
    • 新建内容是二进制的文件
  • 需求
    • 任务状态查询
    • 测试计划详情
    • 查询制品包(镜像)列表
  • 事项
    • 获取列表详情
    • 测试计划列表
    • 查询制品版本列表
    • 获取应用列表
    • 获取构建步骤日志
    • 获取合并请求操作记录
    • 查询所有保护分支
    • 查询仓库的版本列表
    • 根据分支获取标签列表
    • 新建文件并提交
    • 创建提交注释
    • 获取文件详情
    • 登记工时
    • 修改迭代
    • 查询事项列表(旧)
    • 查询后置事项
    • 修改事项父需求
    • 事项列表(新)
    • 修改事项评论
    • 查询需求关联事项列表
    • 查询成员所在项目列表
    • 查询项目用户组
    • 编辑项目
  • 迭代
    • 修改父级顺序
    • 测试任务详情
    • 发布制品版本
    • 获取 CD 应用详情
    • 获取构建计划的构建列表
    • 创建 merge 请求
  • 工时
    • 获取上传文件的 Token
    • 测试任务列表
    • 禁止、解禁制品版本下载
  • 标签
    • 通过 ZIP 包更新 Wiki
    • 测试任务添加测试结果
    • 查询制品属性列表
    • 创建 CD 部署流程
    • 获取构建任务指定阶段的步骤
  • 版本
    • 创建测试用例
    • 测试任务状态批量更新
    • 新增制品属性
    • 修改 CD 部署流程
    • 获取构建日志
  • 分支
    • 修改测试用例
    • 测试任务单独添加某步骤的测试结果
    • 修改制品属性
    • 删除 CD 部署流程
    • 删除构建
    • 合入合并请求
  • 保护分支
    • 删除测试用例
    • 需求关联的测试用例列表
    • 删除制品属性
    • 获取 CD 应用下的所有部署流程配置
    • 停止构建
  • 保护分支规则
    • 测试用例详情
    • 测试任务关联的缺陷列表
    • 查询团队下制品版本列表
    • 根据名称获取 CD 部署流程配置
    • 创建构建计划
    • 查询保护分支规则列表
  • 合并请求
    • 测试用例列表
    • 创建测试报告
    • 根据项目名获取关联应用的发布次数
    • 触发部署流程
    • 删除构建计划
    • 查询保护分支规则
    • 创建分支
    • 修改仓库的版本信息
  • 持续集成
    • 创建测试用例分组
    • 删除测试报告
    • 根据项目名获取关联应用的发布趋势
    • 获取 CD 部署流程执行记录
    • 修改构建计划
    • 查询保护分支规则的管理员
    • 删除分支
    • 删除仓库的版本息
    • 查询仓库分支下提交列表
    • 创建代码仓库
    • 获取团队下仓库列表
    • 获取当前用户所有 SSH 公钥
    • 创建迭代
    • 创建事项
    • 查询属性设置
    • 查询子事项列表
  • 持续部署
    • 修改测试用例分组
      POST
    • 测试报告详情
      POST
    • 根据项目名获取关联应用的发布时长
      POST
    • 取消执行中的 CD 部署流程
      POST
    • 获取构建计划详情
      POST
    • 新建保护分支规则
      POST
    • 查询分支信息
      POST
    • 创建标签
      POST
    • 两次提交之间的提交历史
      POST
    • 获取代码仓库详情
      POST
    • 修改仓库默认分支
      POST
    • 删除当前用户的 SSH 公钥
      POST
    • 删除迭代
      POST
    • 删除事项
      POST
    • 查询状态设置
      POST
    • 删除前置事项
      POST
    • 查询企业所有事项类型列表
      POST
    • 事项关联的测试用例
      POST
    • 查询事项评论列表
      POST
    • 修改缺陷所属的需求
      POST
    • 获取用户个人信息
      POST
  • 代码托管
    • 通过 ZIP 包上传
    • 测试任务关联缺陷
    • 查询制品版本可下载文件列表
    • 执行 CD 任务
    • 获取构建计划环境变量
    • 获取分支的合并状态
    • 查询所有保护分支成员
    • 查询仓库的版本详情
    • 获取提交注释
    • 修改文件并提交
    • 查询项目下仓库信息列表
    • 导入用户 SSH 公钥
    • 删除工时日志
    • 批量规划迭代
    • 查询事项详情
    • 查询前置事项
  • 制品仓库
    • 删除测试用例分组
    • 测试报告列表
    • 根据应用名列表获取发布次数
    • 获取 CD 主机组列表
    • 查询单个项目下的所有构建计划
    • 新建保护分支规则的成员
    • 查询所有分支信息
    • 删除标签
    • 两次提交之间的文件差异
    • 删除代码仓库
    • 根据模板创建仓库
    • 数据结构
    • 迭代详情
    • 查询事项附件的下载地址
  • 测试管理
    • 测试用例分组列表
    • 生成附件预上传信息
    • 根据应用名列表获取发布趋势
    • 查询构建记录详情
    • 获取合并请求提交记录
    • 修改保护分支规则
    • 查询提交所在分支
    • 查询指定标签
    • 获取提交的note信息
    • 修改仓库描述
    • 查询仓库目录下文件和文件夹名字
    • 查询工时日志列表
    • 迭代列表
    • 查询筛选器列表
    • 修改事项
    • 添加前置事项
    • 查询项目引用的事项类型列表
    • 创建事项评论
    • 获取事项的状态变更历史
    • 需求关联缺陷
    • 配置项目成员权限
    • 创建项目
    • 删除项目
    • 查询项目
    • 查询项目成员列表
    • 查询项目根据项目名称
    • 增加项目成员
    • 查询团队内所有项目列表
    • 查询团队成员列表
  • 文档管理
    • 创建 Wiki
    • 创建测试计划
    • 创建制品仓库
    • 根据应用名列表获取发布时长
    • 查询构建完整日志(原始日志 Raw)
    • 查询合并请求详情
    • 添加保护分支成员
    • 查询分支或标签的信息
    • 查询仓库所有标签
    • 查询某次提交某文件的内容
    • 修改仓库名称
  1. 持续部署

获取构建计划详情

正式环境
https://{{your-team}}.coding.net
正式环境
https://{{your-team}}.coding.net
POST
/open-api
获取构建计划详情

请求参数

Query 参数

Header 参数

Body 参数application/json

示例
{
    "Response": {
      "RequestId": "1",
      "Job": {
        "Id": 23,
        "ProjectId": 450,
        "ProjectName": "test-1",
        "DepotId": 1,
        "DepotName": "test-1",
        "Name": "job-create",
        "ExecuteIn": "CVM",
        "TriggerMethodList": [
          "MR_CHANGE",
          "REF_CHANGE"
        ],
        "HookType": "DEFAULT",
        "BranchSelector": "master",
        "BranchRegex": "^refs/heads/master$",
        "JenkinsFileFromType": "STATIC",
        "JenkinsFilePath": "Jenkinsfile",
        "JenkinsFileStaticContent": "pipeline {\n    agent any\n    stages  {\n        \n        stage(\"检出\") {\n            steps {\n                checkout(\n                    [$class: 'GitSCM', branches: [[name: env.GIT_BUILD_REF]], \n                    userRemoteConfigs: [[url: env.GIT_REPO_URL, credentialsId: env.CREDENTIALS_ID]]]\n                )\n            }\n        }\n\n        stage(\"构建\") {\n            steps {\n                echo \"构建中...\"\n                sh 'docker version'\n                // 请在这里放置您项目代码的单元测试调用过程,例如:\n                // sh 'mvn package' // mvn 示例\n                // sh 'make' // make 示例\n                echo \"构建完成.\"\n              \n                // 演示怎样产生构建物\n                script{\n                    def exists = fileExists 'README.md'\n                    if (!exists) {\n                        writeFile(file: 'README.md', text: 'Helloworld')\n                    }\n                }\n                archiveArtifacts artifacts: 'README.md', fingerprint: true\n              \n                // archiveArtifacts artifacts: '**/target/*.jar', fingerprint: true // 收集构建产物\n            }\n        }\n\n        stage(\"测试\") {\n            steps {\n                echo \"单元测试中...\"\n                // 请在这里放置您项目代码的单元测试调用过程,例如:\n                // sh 'mvn test' // mvn 示例\n                // sh 'make test' // make 示例\n                echo \"单元测试完成.\"\n              \n                // 演示怎么样生成测试报告\n                writeFile(file: 'TEST-demo.junit4.AppTest.xml', text: '''\n                    <testsuite name=\"demo.junit4.AppTest\" time=\"0.053\" tests=\"3\" errors=\"0\" skipped=\"0\" failures=\"0\">\n                        <properties>\n                        </properties>\n                        <testcase name=\"testApp\" classname=\"demo.junit4.AppTest\" time=\"0.003\"/>\n                        <testcase name=\"test1\" classname=\"demo.junit4.AppTest\" time=\"0\"/>\n                        <testcase name=\"test2\" classname=\"demo.junit4.AppTest\" time=\"0\"/>\n                    </testsuite>\n                ''')\n                junit '*.xml'\n              \n                // junit 'target/surefire-reports/*.xml' // 收集单元测试报告的调用过程\n            }\n        }\n\n        stage(\"部署\") {\n            steps {\n                echo \"部署中...\"\n                // 请在这里放置收集单元测试报告的调用过程,例如:\n                // sh 'mvn tomcat7:deploy' // Maven tomcat7 插件示例:\n                // sh './deploy.sh' // 自研部署脚本\n                echo \"部署完成\"\n            }\n        }\n    }\n}\n",
        "AutoCancelSameRevision": true,
        "AutoCancelSameMergeRequest": true,
        "TriggerRemind": "ALWAYS",
        "CachePathList": [],
        "EnvList": [
          {
            "Name": "a",
            "Value": "1",
            "Sensitive": false
          },
          {
            "Name": "b",
            "Value": "2",
            "Sensitive": true
          }
        ],
        "ScheduleList": [],
        "AlwaysUserIdList": [],
        "BuildFailUserIdList": [],
        "CreatorId": 1,
        "CreatedAt": 0,
        "UpdatedAt": 0,
        "DepotWebUrl": "http://codingcorp.coding.9.134.115.58.nip.io/p/test-1/d/test-1/git",
        "DepotSshUrl": "git@e.coding.9.134.115.58.nip.io:codingcorp/test-1.git",
        "DepotHttpsUrl": "http://e.coding.9.134.115.58.nip.io/codingcorp/test-1.git",
        "DockerFilePath": "",
        "DockerBuildPath": "",
        "DockerBuildTag": "",
        "JobFromType": "CODING",
        "DepotType": "CODING",
        "GroupName": "test1"
      }
    }
  }
  

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://.coding.net/open-api?Action=DescribeCodingCIJob' \
--header 'AccessToken;' \
--header 'Action;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Response": {
      "RequestId": "1",
      "Job": {
        "Id": 23,
        "ProjectId": 450,
        "ProjectName": "test-1",
        "DepotId": 1,
        "DepotName": "test-1",
        "Name": "job-create",
        "ExecuteIn": "CVM",
        "TriggerMethodList": [
          "MR_CHANGE",
          "REF_CHANGE"
        ],
        "HookType": "DEFAULT",
        "BranchSelector": "master",
        "BranchRegex": "^refs/heads/master$",
        "JenkinsFileFromType": "STATIC",
        "JenkinsFilePath": "Jenkinsfile",
        "JenkinsFileStaticContent": "pipeline {\n    agent any\n    stages  {\n        \n        stage(\"检出\") {\n            steps {\n                checkout(\n                    [$class: '\''GitSCM'\'', branches: [[name: env.GIT_BUILD_REF]], \n                    userRemoteConfigs: [[url: env.GIT_REPO_URL, credentialsId: env.CREDENTIALS_ID]]]\n                )\n            }\n        }\n\n        stage(\"构建\") {\n            steps {\n                echo \"构建中...\"\n                sh '\''docker version'\''\n                // 请在这里放置您项目代码的单元测试调用过程,例如:\n                // sh '\''mvn package'\'' // mvn 示例\n                // sh '\''make'\'' // make 示例\n                echo \"构建完成.\"\n              \n                // 演示怎样产生构建物\n                script{\n                    def exists = fileExists '\''README.md'\''\n                    if (!exists) {\n                        writeFile(file: '\''README.md'\'', text: '\''Helloworld'\'')\n                    }\n                }\n                archiveArtifacts artifacts: '\''README.md'\'', fingerprint: true\n              \n                // archiveArtifacts artifacts: '\''**/target/*.jar'\'', fingerprint: true // 收集构建产物\n            }\n        }\n\n        stage(\"测试\") {\n            steps {\n                echo \"单元测试中...\"\n                // 请在这里放置您项目代码的单元测试调用过程,例如:\n                // sh '\''mvn test'\'' // mvn 示例\n                // sh '\''make test'\'' // make 示例\n                echo \"单元测试完成.\"\n              \n                // 演示怎么样生成测试报告\n                writeFile(file: '\''TEST-demo.junit4.AppTest.xml'\'', text: '\'''\'''\''\n                    <testsuite name=\"demo.junit4.AppTest\" time=\"0.053\" tests=\"3\" errors=\"0\" skipped=\"0\" failures=\"0\">\n                        <properties>\n                        </properties>\n                        <testcase name=\"testApp\" classname=\"demo.junit4.AppTest\" time=\"0.003\"/>\n                        <testcase name=\"test1\" classname=\"demo.junit4.AppTest\" time=\"0\"/>\n                        <testcase name=\"test2\" classname=\"demo.junit4.AppTest\" time=\"0\"/>\n                    </testsuite>\n                '\'''\'''\'')\n                junit '\''*.xml'\''\n              \n                // junit '\''target/surefire-reports/*.xml'\'' // 收集单元测试报告的调用过程\n            }\n        }\n\n        stage(\"部署\") {\n            steps {\n                echo \"部署中...\"\n                // 请在这里放置收集单元测试报告的调用过程,例如:\n                // sh '\''mvn tomcat7:deploy'\'' // Maven tomcat7 插件示例:\n                // sh '\''./deploy.sh'\'' // 自研部署脚本\n                echo \"部署完成\"\n            }\n        }\n    }\n}\n",
        "AutoCancelSameRevision": true,
        "AutoCancelSameMergeRequest": true,
        "TriggerRemind": "ALWAYS",
        "CachePathList": [],
        "EnvList": [
          {
            "Name": "a",
            "Value": "1",
            "Sensitive": false
          },
          {
            "Name": "b",
            "Value": "2",
            "Sensitive": true
          }
        ],
        "ScheduleList": [],
        "AlwaysUserIdList": [],
        "BuildFailUserIdList": [],
        "CreatorId": 1,
        "CreatedAt": 0,
        "UpdatedAt": 0,
        "DepotWebUrl": "http://codingcorp.coding.9.134.115.58.nip.io/p/test-1/d/test-1/git",
        "DepotSshUrl": "git@e.coding.9.134.115.58.nip.io:codingcorp/test-1.git",
        "DepotHttpsUrl": "http://e.coding.9.134.115.58.nip.io/codingcorp/test-1.git",
        "DockerFilePath": "",
        "DockerBuildPath": "",
        "DockerBuildTag": "",
        "JobFromType": "CODING",
        "DepotType": "CODING",
        "GroupName": "test1"
      }
    }
  }'

返回响应

🟢200成功
application/json
Body

示例
{
    "Response": {
        "Job": null,
        "RequestId": "string"
    }
}
修改于 2023-01-30 07:32:57
上一页
取消执行中的 CD 部署流程
下一页
新建保护分支规则
Built with