请求数据结构--持续交付-火山引擎

文档中心

导航

请求数据结构

最近更新时间：2024.07.02 21:12:39首次发布时间：2024.07.02 21:03:12

IAMUser

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

ResourceConfiguration

参数	类型	是否必选	示例值	描述
Git	Object GitConfiguration	否		代码源配置信息。

GitConfiguration

参数	类型	是否必选	示例值	描述
Url	String	是	https://gitee.com/****	代码仓库 URL。
UserToken	String	否	0f6832949f31ef77****	用户 Token。
UserName	String	否	user	用户名。
Password	String	否	pwd****	密码。
CloneDepth	Integer	否	0	代码克隆深度，默认值或最小值都为 0。
AccessKey	String	否	qAfR************	第三方云的 AccessKey。
SecretKey	String	否	Qtlc************	第三方云的 SecretKey。

TriggerParameter

参数	类型	是否必选	示例值	描述
Key	String	是	key	动态变量 Key。
Value	String	是	value	动态变量 Value。

TriggerResource

参数	类型	是否必选	示例值	描述
ResourceId	String	是	60cb460122422352a334****	代码源 ID。
Reference	String	是	master	流水线运行使用的代码 Reference，支持填写 Commit ID/Tag/Branch。

TriggerConfiguration

参数名	类型	是否必须	示例值	描述
Schedule	Object ScheduleConfiguration	否		定时触发器的配置。
Webhook	Object WebhookConfiguration	否		Webhook 类型触发器的配置。

ScheduleConfiguration

参数名	类型	是否必须	示例值	描述
ScheduleConfig	String	是	44 17 * * 1	使用 Crontab 表达式配置定时触发的时间，配置方法请参见官方文档。 Crontab 表达式默认使用 UTC + 8 时区。

WebhookConfiguration

参数名	类型	是否必须	示例值	描述
Git	Object GitWebhookConfiguration	否		代码源触发器的 Webhook 配置。
CR	Object CRWebhookConfiguration	否		镜像源触发器的 Webhook 配置。
URL	String	是	https://cp.volces.com/v2/webhook/scm/eQKcyKfa702maKXrR_VoJi****	Webhook 的 URL，可以通过 CreatePipelineWebhookURL 接口生成。

GitWebhookConfiguration

参数名	类型	是否必须	示例值	描述
ResourceId	String	是	c3e06107e5edcb4fb5329d9b****	关联的代码源 ID。
Filters	Array of WebhookEventFilter	否		代码源触发器支持的触发事件和过滤条件。如果不配置，则默认所有事件都将触发流水线运行。

WebhookEventFilter

参数名	类型	是否必须	示例值	描述
EventType	String	是	Push	触发事件的类型： Push：代码 Push CreateTag：TAG 创建 PRMerged：合并请求完成后
Config	Object WebhookEventConfig	否		触发事件的配置，用于二次过滤符合条件的触发事件。

参数名

类型

是否必须

示例值

描述

EventType

String

是

Push

触发事件的类型：

Push：代码 Push
CreateTag：TAG 创建
PRMerged：合并请求完成后

Config

Object WebhookEventConfig

否

触发事件的配置，用于二次过滤符合条件的触发事件。

WebhookEventConfig

参数名	类型	是否必须	示例值	描述
References	Array of String	否	["main" ]	过滤的分支或者 TAG。 Push 和 PRMerged 事件支持填写过滤的分支。 CreateTag 事件支持填写过滤的 TAG。

参数名

类型

是否必须

示例值

描述

References

Array of String

否

["main" ]

过滤的分支或者 TAG。

Push 和 PRMerged 事件支持填写过滤的分支。
CreateTag 事件支持填写过滤的 TAG。

CRWebhookConfiguration

参数名	类型	是否必须	示例值	描述
Filter	Object CRWebhookEventFilter	否		镜像源触发器支持的触发动作和触发条件。如果不配置，则默认所有事件都将触发流水线运行。

CRWebhookEventFilter

参数名	类型	是否必须	示例值	描述
CREventType	String	否	CRPush	触发动作： CRPush：镜像推送
Condition	String	否	"volcregion":"xxx"	触发条件，用于二次过滤符合条件的触发事件。支持使用正则表达式。

参数名

类型

是否必须

示例值

描述

CREventType

String

否

CRPush

触发动作：

CRPush：镜像推送

Condition

String

否

"volcregion":"xxx"

触发条件，用于二次过滤符合条件的触发事件。支持使用正则表达式。