ListPipelines--持续交付-火山引擎

导航

ListPipelines

最近更新时间：2024.09.27 14:46:38首次发布时间：2024.07.02 21:03:13

查询流水线列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListPipelines&Version=2023-05-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListPipelines	接口名称。当前 API 的名称为 `ListPipelines`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
WorkspaceId	String	是	18be9d623fba45a1aca409f5e19c****	工作区 ID。
Filter	Object of PipelineFilter	否	-	待查询流水线的过滤条件。
PageSize	Long	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10
PageNumber	Long	否	1	分页查询时的起始页码，从 1 开始，默认为 1。

PipelineFilter

参数	类型	是否必选	示例值	描述
Name	String	否	foo	按流水线名称过滤，模糊查询。
Ids	Array of String	否	["9d3f01e4f7ee4293a7cfc0c2d4d6****"]	按流水线 ID 过滤，精确查询。

请求示例

POST https://open.volcengineapi.com/?Action=ListPipelines&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
  "WorkspaceId": "3f5f09a059124d6898a8543e678f****",
  "PageNumber": 1,
  "PageSize": 10,
  "Filter": {
      "Name": "test",
      "Ids": [
          "9d3f01e4f7ee4293a7cfc0c2d4d6****"
      ]
  }
}

返回参数

参数	类型	示例值	描述
TotalCount	Long	10	流水线总数。
Items	Array of Pipeline	-	流水线列表。
PageSize	Long	10	分页大小。
PageNumber	Long	1	当前页码。

Pipeline

参数	类型	示例值	描述
Id	String	67d0485e1efb44128f0d990cdad6****	流水线 ID。
Name	String	pipelineName	流水线名称。
WorkspaceId	String	9d3f01e4f7ee4293a7cfc0c2d4d6****	流水线所属工作区 ID。
Description	String	这是一段描述	流水线描述信息。
Spec	String		流水线编排 YAML 描述信息。
Resources	Array of PipelineResource	-	水线资源相关配置，目前指代码源。
Parameters	Array of PipelineParameter	-	流水线变量配置。
Caches	Array of PipelineCache	-	流水线缓存配置。
Notification	Object of PipelineNotification	-	流水线消息通知配置。
Creator	Object of IAMUser	-	流水线创建人。
CreateTime	String	2023-05-10T21:33:20Z	流水线创建时间。
UpdateTime	String	2023-05-10T21:33:20Z	流水线更新时间。

PipelineResource

参数	类型	示例值	描述
Id	String	669631b1495540a49915ede9893d****	代码源 ID。
Configuration	Object of PipelineResourceConfiguration	-	代码源配置信息。

PipelineResourceConfiguration

参数	类型	示例值	描述
Git	Object of GitResourceConfiguration	-	Git 代码源配置。

GitResourceConfiguration

参数	类型	示例值	描述
DefaultBranch	String	master	默认分支。

PipelineParameter

参数	类型	示例值	描述
Key	String	key1	变量的键。
Value	String	val1	变量的值。
Secret	Boolean	true/false	变量是否开启隐私设置。 true：开启隐私设置。变量的默认值展示为***。 false：关闭隐私设置。变量的默认值明文展示。
Dynamic	Boolean	true/false	变量是否开启动态设置。 true：变量为动态变量。支持在运行流水线时修改当前变量的运行值。 false：变量为非动态变量。运行流水线时使用默认值。
OptionValues	Array of String	["abc","bcd"]	当配置可选值时，代表变量是个单选值。
Description	String	this is a param description	变量备注。

PipelineCache

参数	类型	示例值	描述
Key	String	m2	缓存目录名称。
Path	String	$(CP_WORKSPACE)/.m2	缓存路径。
Description	String	this is a param description	缓存目录备注。

PipelineNotification

参数	类型	示例值	描述
Events	Array of String	["EventPipelineStarted"]	触发消息通知的事件列表。 EventPipelineStarted：开始运行 EventPipelineSucceeded：运行成功 EventPipelineFailed：运行失败 EventPipelineCanceled：运行取消
EnableSiteLetter	Boolean	true/false	是否开启站内信通知。 true：开启站内信通知 false：不开启站内信通知
Sms	Object of NotificationTarget	-	短信消息通知配置。
Email	Object of NotificationTarget	-	邮件消息通知配置。
Webhook	Object of WebhookNotification	-	Webhook 消息通知配置。
CustomContent	String	自定义消息	自定义的消息通知内容。

NotificationTarget

参数

类型

示例值

描述

Enable

Boolean

true/false

是否开启通知。

true：开启通知
false：不开启通知

Targets

Array of String

["TriggerBy","CreateBy"]

通知目标。

Triggerer：流水线运行人
Creator：流水线创建人

WebhookNotification

参数	类型	示例值	描述
Enable	Boolean	true/false	是否开启通知。 true：开启通知 false：不开启通知
Type	String	Lark	Webhook 类型。 Lark：飞书 Webhook Common：通用 Webhook
Url	String	https://open.feishu.cn/open-apis/bot/v2/hook/2e5c3202-aa81-4b14-****	WebhookURL。
Token	String	foo	调用 Token。

IAMUser

参数	类型	示例值	描述
AccountId	Long	210048****	火山引擎账号（主账号）ID。
UserId	Long	28****	子用户（IAM 用户）ID。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "202404031138595E5D8BD124299EB9****",
        "Action": "ListPipelines",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing",
    },
    "Result": {
        "Items": [
            {
                "Id": "67d0485e1efb44128f0d990cdad6****",
                "Name": "test-v2-pipeline_1683717039073",
                "WorkspaceId": "9d3f01e4f7ee4293a7cfc0c2d4d6****",
                "Description": "",
                "Spec": "version: 1.0.0\nstages:\n  - stage: stage-1\n    displayName: 阶段-1\n    tasks:\n      - dependsOn: []\n        task: task1\n        displayName: 任务-1\n        steps:\n          - step: exec-cmd\n            displayName: 命令执行\n            inputs:\n              shell: BASH\n              cmd: |-\n                sleep 200\n\n                echo 'aa'\n            component: execCmd@1.0.0/shell\n        plugins: []\n        outputs: []\n        timeout:\n          time: '2'\n          unit: h\n        workspace:\n          resources:\n            - ref: test111\n              directory: $(CP_WORKSPACE)\n          caches:\n            - cacheKey: m2\n              directory: $(CP_WORKSPACE)/m2\n              cachePolicy: pull-push\n            - cacheKey: gradle\n              directory: $(CP_WORKSPACE)/gradle\n              cachePolicy: pull-push\n            - cacheKey: npm\n              directory: $(CP_WORKSPACE)/npm\n              cachePolicy: pull-push\nagentPool: public/sit-v2-public\n",
                "Resources": [
                    {
                        "Id": "669631b1495540a49915ede9893d****",
                        "Configuration": {
                            "Git": {
                                "DefaultBranch": "demo"
                            }
                        }
                    }
                ],
                "CreateTime": "2023-05-10T19:10:39Z",
                "UpdateTime": "2023-05-10T21:33:20Z",
                "Creator": {
                    "AccountId": 140000****,
                    "UserId": 0
                },
                "Draft": false
            }
        ],
        "PageSize": 10,
        "PageNumber": 1,
        "TotalCount": 1
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。