在Jenkins的Active Choice插件中使用全局凭据进行API调用

54次阅读

问题描述

想要在Jenkins的Active Choice插件的Groovy脚本中使用全局凭据进行API调用。他想要通过API调用获取一个列表，并将其作为参数的选择项显示在Active Choice插件中。但是，为了实现这一点，他需要使用带有凭据的认证头。他想知道如何处理凭据，是否可以在脚本中访问在Jenkins凭据中设置的内容（类似于在流水线环境中调用credentials(id)）。

解决方案

在进行以下操作之前，请确保您已经了解了Active Choice插件的基本使用和Jenkins的凭据系统。

在Jenkins的Active Choice插件中，确实可以使用全局凭据进行API调用。以下是实现此目标的步骤：

使用凭据ID获取凭据

在Jenkins中，您可以在全局凭据存储中设置凭据。这些凭据可以是用户名密码、API令牌等。要在Active Choice插件中使用这些凭据，您可以使用以下步骤：

首先，确保您已经在Jenkins中设置了所需的凭据。您可以在Jenkins管理界面的“凭据”部分找到并添加凭据。
在Active Choice插件的Groovy脚本中，您可以使用withCredentials步骤来访问凭据。这个步骤将凭据暴露给您的脚本，以便您可以在API调用中使用它们。

以下是一个示例脚本，演示了如何使用凭据进行API调用：

import jenkins.model.*
import com.cloudbees.plugins.credentials.*
import com.cloudbees.plugins.credentials.common.*
import com.cloudbees.plugins.credentials.domains.*
import org.jenkinsci.plugins.plaincredentials.StringCredentials

def credsId = 'your_credentials_id'
def apiUrl = 'https://api.example.com/data'

def creds = Jenkins.instance.getExtensionList('com.cloudbees.plugins.credentials.SystemCredentialsProvider')[0].getCredentials(Domain.global()).findResult { 
    if (it.id == credsId && it instanceof StringCredentials) {
        return it
    }
}

if (creds) {
    def authHeader = 'Bearer ' + creds.secret
    def response = httpRequest(
        url: apiUrl,
        customHeaders: [[name: 'Authorization', value: authHeader]],
        ignoreSslErrors: true
    )

    if (response.status == 200) {
        def data = new groovy.json.JsonSlurper().parseText(response.content)
        def choices = data.collect { it.name }
        return choices
    } else {
        return ['Error fetching data']
    }
} else {
    return ['Credentials not found']
}

在上面的示例中，我们首先通过credsId获取指定ID的凭据。然后，我们将凭据的密钥添加到API请求的认证头中，从而进行身份验证。如果API调用成功，我们将解析响应并从中提取数据。最后，我们将数据中的名称作为选择项返回给Active Choice插件。

请注意，您需要将示例中的your_credentials_id替换为您在Jenkins中设置的凭据的实际ID，https://api.example.com/data替换为您的API端点的实际URL。