【Jenkins】调用API构建并钉钉通知

文章目录

Jenkins API介绍

Jenkins 提供了远程访问 API。目前它有三种格式:

  1. XML

  2. JSON

  3. Python

远程访问 API 形式为".../api/"

例如, Jenkins 安装位于https://ci.jenkins.io,则访问https://ci.jenkins.io/api/将仅显示可用的顶级 API 功能 -- 主要是Jenkins 实例的已配置作业的列表 。

Jenkins API 可用于执行以下操作:

  1. 从 Jenkins 检索信息以进行编程使用。

  2. 触发新的构建

  3. 创建/复制作业

提交作业

不带参数的作业

只需要执行 HTTP POST JENKINS_URL/job/JOBNAME/build。

带参数的作业

例如 - 包含"字符串参数":

bash 复制代码
curl JENKINS_URL/job/JOB_NAME/buildWithParameters \
  --user USER:TOKEN \
  --data id=123 --data verbosity=high

另一个包含"文件参数"的例子 - :

bash 复制代码
curl JENKINS_URL/job/JOB_NAME/buildWithParameters \
  --user USER:PASSWORD \
  --form FILE_LOCATION_AS_SET_IN_JENKINS=@PATH_TO_FILE

在此示例中,符号"@"很重要。另外,文件的路径是绝对路径。为了使此命令起作用,您需要将 Jenkins 作业配置为采用文件参数,并将Jenkins 作业配置中的文件位置--form字段与选项中的键相匹配。

API 令牌

早期版本的 Jenkins 要求指定真实密码,目前版本不建议这样做,因为存在泄露密码的风险,建议使用API 令牌

API 令牌可在个人配置页面中找到。在每个页面的右上角单击您的姓名,然后单击"配置"以查看您的 API 令牌。

Shell调用代码

实现调用API构建,且成功后钉钉通知

bash 复制代码
webhook=https://xxx.dingding.com
project=test-app
app_env=test
jenkins_url=http://xxxx.com/job/${project}/buildWithParameters?type=${app_env}
http_status_code=`curl -o /dev/null -s -w %{http_code} -X POST ${jenkins_url} --user xxxx:xxxxx`
if [[ $http_status_code -eq 000 ]] || [[ $http_status_code -ge 304 ]];then
            echo "http_status_code is"  $http_status_code
            exit 1
    else
            echo "service status ok\n"$http_content
            curl "${webhook}" -H 'Content-Type: application/json' -d "
    {
        \"msgtype\": \"markdown\",
        \"markdown\": {
                \"title\":\"Jenkins通知\",
                \"text\": \"#### 项目:${project}\n> 环境:${app_env}\n\n> 开始执行构建\n \n\"
     },
    }
相关推荐
Hello.Reader30 分钟前
在 Ubuntu 环境为 Elasticsearch 引入 `icu_tokenizer
ubuntu·elasticsearch·jenkins
秦始皇爱找茬10 小时前
docker部署Jenkins工具
docker·容器·jenkins
洞窝技术17 小时前
增量代码自动Review工具:洞窝在AI上的探索和实践
jenkins·ai编程·测试
风行無痕2 天前
Ubuntu使用war包部署Jenkins并通过systemcl管理
java·servlet·jenkins
rider1892 天前
【3】CICD持续集成-k8s集群中安装Jenkins-agent(主从架构)
ci/cd·kubernetes·jenkins
云攀登者-望正茂2 天前
Jenkins plugin 的用法和示例
kubernetes·jenkins
007php0072 天前
使用 Docker 安装 Elastic Stack 并重置本地密码
大数据·运维·后端·mysql·docker·eureka·jenkins
suimeng63 天前
Jenkins的地位和作用
自动化测试·jenkins
梁萌3 天前
10-DevOps-Jenkins参数化构建实现多版本发布
运维·gitlab·jenkins·devops·tag
雨月琉琉3 天前
备份jenkins
运维·servlet·jenkins