更新时间:2025-08-13 GMT+08:00
分享

第三方接口调用v2

“第三方接口调用v2”插件支持配置Web API调用第三方API。

约束与限制

  • 此插件需要证书校验,不支持自定义证书校验和无证书校验。
  • 接口返回码如果不是2XX,则默认为运行失败。

编排流水线任务时,添加“第三方接口调用v2”插件,参数配置如表1

表1 “第三方接口调用v2”插件参数说明

参数项

说明

名称

插件名称。

  • 仅支持中文、大小写英文字母、数字、“-”、“_”、“,”、“;”、“:”、“.”、“/”、“(”、“)”、“(”、“)”和空格。
  • 至少输入一个字符。

请求方式

可选择GET、POST、PATCH、PUT或DELETE。

请求路径

能被公网调用的接口,需要证书校验。

请求头

请求头,添加键值对。

请求参数

请求参数,添加键值对。

请求体

如果请求方式是POST、PATCH或PUT,则输入json格式的body体。

输出

根对象名是response,可输出多个output。

  • 如果要拿到具体的请求返回码,并且输出的key是code,示例如下。

  • 如果返回的请求头中有date字段,并且需要拿到date时间的值,则输出处添加示例如下。

  • 如果要输出整个body,示例如下

  • 如果返回的json体如下,并且要取field对应的value值,示例如下。
    {	
        "result": {		
           "field": "value",		
           "field1": "value1"	
        }
    }

编排流水线任务时,添加“第三方接口调用v2”插件,yaml语法配置如下。

  • 第三方接口调用v2
    uses: official_third_part_invoke
        with:
          API_METHOD: GET
          API_URL: htps://demo
          API_HEADER: '[{"key":"Content-Type","value":"application/json"}]'
          API_PARAM: '[{"key":"name","value":"value"}]'
          API_BODY: "{}"
          API_OUTPUT: '[{"key":"code","value":"response.status"}]'

相关文档