触发器接口
更新时间：2022-08-23
使用前提
- 已成功创建企业版实例。
获取触发器策略列表
接口描述
获取触发器策略列表。
请求结构
GET /v1/instances/{instanceId}/triggers/policies?policyName={policyName}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | 实例ID |
| policyName | String | 否 | Query参数 | 触发器策略名称，支持模糊查询 |
| pageNo | Integer | 否 | Query参数 | 当前页，默认为1 |
| pageSize | Integer | 否 | Query参数 | 每页记录数，默认为10 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| total | Integer | 触发器策略总数 |
| pageNo | Integer | 当前页 |
| pageSize | Integer | 每页记录数 |
| policies | List<TriggerPolicy> | 触发器策略对象列表 |
请求示例
GET /v1/instances/ccr-test/triggers/policies?policyName=trigger-test&pageNo=1&pageSize=10 HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 05 Aug 2022 07:23:56 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 9de1d766-a5de-46c0-a40c-29e916410d22
{
"total": 1,
"pageNo": 1,
"pageSize": 10,
"policies": [
{
"creationTime": "2022-08-05T07:20:32.098378Z",
"description": "trigger-test",
"enabled": true,
"eventTypes": [
"UPLOAD_CHART",
"DOWNLOAD_CHART",
"DELETE_CHART"
],
"filters": [
{
"type": "project_name",
"value": "ns-test"
},
{
"type": "repository_name",
"value": "ubuntu"
},
{
"type": "tag_name",
"value": "18.02"
}
],
"id": 2,
"name": "trigger-test",
"targets": [
{
"address": "http://baidu.com",
"headers": {
"Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
}
}
],
"updateTime": "2022-08-05T07:20:32.098378Z"
}
]
}查询触发器策略详情
接口描述
查询触发器策略详情。
请求结构
GET /v1/instances/{instanceId}/triggers/policies/{policyId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 触发器策略ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| creationTime | String | 触发器创建时间 |
| description | String | 触发器策略备注 |
| enabled | Boolean | 启动状态 |
| eventTypes | List<String> | 触发事件列表，返回值定义： UPLOAD_CHART（Helm Chart推送） DOWNLOAD_CHART（Helm Chart拉取） DELETE_CHART（Helm Chart删除） PUSH_ARTIFACT（制品推送） PULL_ARTIFACT（制品拉取） DELETE_ARTIFACT（制品删除） |
| filters | List<TriggerFilter> | 触发规则 |
| id | Integer | 触发器ID |
| name | String | 触发器名称 |
| targets | List<TriggerTarget> | 访问配置 |
| updateTime | String | 触发器更新时间 |
请求示例
GET /v1/instances/ccr-test/triggers/policies/1 HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 05 Aug 2022 13:04:25 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 847e178c-474a-4083-9b45-02b2bc34c925
{
"creationTime": "2022-08-05T07:19:05.797801Z",
"description": "触发器测试",
"enabled": true,
"eventTypes": [
"PUSH_ARTIFACT",
"PULL_ARTIFACT",
"DELETE_ARTIFACT"
],
"filters": [
{
"type": "project_name",
"value": "ns-test"
},
{
"type": "repository_name",
"value": "ubuntu"
},
{
"type": "tag_name",
"value": "18.052"
}
],
"id": 1,
"name": "trigger-test1",
"targets": [
{
"address": "http://baidu.com",
"headers": {
"Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
}
}
],
"updateTime": "2022-08-05T07:19:05.797801Z"
}创建触发器策略
接口描述
创建触发器策略。
请求结构
POST /v1/instances/{instanceId}/triggers/policies HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"description": {description},
"eventTypes": {eventTypes},
"filters": {filters},
"name": {name},
"targets": {targets}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| description | String | 否 | Body参数 | 触发器策略备注 |
| eventTypes | List<String> | 是 | Body参数 | 触发事件列表，有效值为： UPLOAD_CHART（Helm Chart推送）、 DOWNLOAD_CHART（Helm Chart拉取）、 DELETE_CHART（Helm Chart删除）、 PUSH_ARTIFACT（制品推送）、 PULL_ARTIFACT（制品拉取）、 DELETE_ARTIFACT（制品删除） |
| filters | List<TriggerFilter> | 否 | Body参数 | 触发规则 |
| name | String | 是 | Body参数 | 触发器名称 |
| targets | List<TriggerTarget> | 否 | Body参数 | 访问配置 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
POST /v1/instances/ccr-test/triggers/policies HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"description": "触发器测试",
"eventTypes": [
"PUSH_ARTIFACT"
],
"filters": [
{
"type": "project_name",
"value": "ns-test"
}
],
"name": "trigger-test",
"targets": [
{
"address": "http://baidu.com",
"headers": {
"Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
}
}
]
}响应示例
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Date: Mon, 08 Aug 2022 06:48:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: a89e0780-2b4c-44d2-84e8-ce55883a5cb7修改触发器策略
接口描述
修改触发器策略。
请求结构
PUT /v1/instances/{instanceId}/triggers/policies/{policyId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"description": {description},
"eventTypes": {eventTypes},
"filters": {filters},
"name": {name},
"targets": {targets}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 触发器策略ID |
| description | String | 否 | Body参数 | 触发器策略备注 |
| eventTypes | List<String> | 是 | Body参数 | 触发事件列表，有效值为： UPLOAD_CHART（Helm Chart推送）、 DOWNLOAD_CHART（Helm Chart拉取）、 DELETE_CHART（Helm Chart删除）、 PUSH_ARTIFACT（制品推送）、 PULL_ARTIFACT（制品拉取）、 DELETE_ARTIFACT（制品删除） |
| filters | List<TriggerFilter> | 否 | Body参数 | 触发规则 |
| name | String | 是 | Body参数 | 触发器名称 |
| targets | List<TriggerTarget> | 否 | Body参数 | 访问配置 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
PUT /v1/instances/ccr-test/triggers/policies/3 HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"description": "触发器测试-修改",
"eventTypes": [
"PUSH_ARTIFACT",
"DELETE_CHART"
],
"filters": [
{
"type": "project_name",
"value": "ns-test"
}
],
"name": "trigger-test",
"targets": [
{
"address": "http://baidu.com",
"headers": {
"Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
}
}
]
}响应示例
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Date: Mon, 08 Aug 2022 06:48:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: a89e0780-2b4c-44d2-84e8-ce55883a5cb7批量删除触发器策略
接口描述
批量删除触发器策略。
请求结构
DELETE /v1/instances/{instanceId}/triggers/policies HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"items": {items}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| items | List<Integer> | 是 | Body参数 | 触发器策略ID数组 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
DELETE /v1/instances/ccr-test/triggers/policies HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"items": [
1,
2
]
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 08 Aug 2022 07:28:25 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 8f21c375-ce7e-4ed7-b9a9-9499e9e1262d删除触发器策略
接口描述
删除触发器策略。
请求结构
DELETE /v1/instances/{instanceId}/triggers/policies/{policyId} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 触发器策略ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
DELETE /v1/instances/ccr-test/triggers/policies/1 HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T08:26:41Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 08 Aug 2022 07:37:59 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: d422ac7a-298a-42c5-ab51-00d6beb78396测试触发器策略目标地址
接口描述
测试触发器策略目标地址。
请求结构
POST /v1/instances/{instanceId}/triggers/policies/targets HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string
{
"address": {address},
"headers": {headers}
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| address | String | 是 | Body参数 | 目标URL |
| headers | Object | 否 | Body参数 | header key仅支持“Authorization” |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
POST /v1/instances/ccr-test/triggers/policies/targets HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6
{
"address": "http://baidu.com",
"headers": {
"Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
}
}响应示例
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Date: Mon, 08 Aug 2022 06:48:43 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: a89e0780-2b4c-44d2-84e8-ce55883a5cb7启动或关闭触发器策略
接口描述
启动或关闭触发器策略。
请求结构
PUT /v1/instances/{instanceId}/triggers/policies/{policyId}/enable?enabled={enabled} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 触发器策略ID |
| enabled | String | 是 | Query参数 | 是否开启 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
PUT /v1/instances/ccr-test/triggers/policies/1/enable?enabled=false HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 08 Aug 2022 08:07:21 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: 518d789f-013d-4bf1-ade5-4e7fd1f33dd4获取触发器任务列表
接口描述
获取触发器任务列表。
请求结构
GET /v1/instances/{instanceId}/triggers/policies/{policyId}/jobs?pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 触发器策略ID |
| pageNo | Integer | 否 | Query参数 | 当前页 |
| pageSize | Integer | 否 | Query参数 | 每页记录数 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| total | Integer | 触发器任务总数 |
| pageNo | Integer | 当前页 |
| pageSize | Integer | 每页记录数 |
| jobs | List<TriggerJob> | 触发器任务列表 |
请求示例
GET /v1/instances/ccr-test/triggers/policies/1/jobs?pageNo=1&pageSize=10 HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 08 Aug 2022 08:32:05 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: dc60c252-5bc5-4d98-96c4-14473048dc9f
{
"total": 2,
"pageNo": 1,
"pageSize": 10,
"jobs": [
{
"creationTime": "2022-08-12T03:01:12.458882Z",
"eventType": "PUSH_ARTIFACT",
"id": 4,
"notifyType": "trigger",
"status": "finished",
"operator": "xiaoming",
"image": "ns1/pause:3.4",
"images": [
"ns1/pause:3.4"
],
"updateTime": "2022-08-12T03:01:13.005546Z"
},
{
"creationTime": "2022-08-08T09:29:32.032588Z",
"eventType": "PULL_ARTIFACT",
"id": 1,
"notifyType": "trigger",
"status": "finished",
"image": "ns1/ubuntu:18.04-tools",
"images": [
"ns1/ubuntu:18.04-tools"
],
"updateTime": "2022-08-08T09:29:32.231975Z"
}
]
}重新执行触发器任务
接口描述
重新执行触发器任务。
请求结构
PUT /v1/instances/{instanceId}/triggers/policies/{policyId}/jobs/{jobId}/retry HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | Path参数 | CCR实例ID |
| policyId | String | 是 | Path参数 | 触发器策略ID |
| jobId | String | 是 | Path参数 | 触发器任务ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
如果请求成功无响应参数。如果请求失败则返回标准错误结构。
请求示例
PUT /v1/instances/ccr-test/triggers/policies/1/jobs/2/retry HTTP/1.1
Host: ccr.bd.baidubce.com
Authorization: bce-auth-v1/123456/2022-08-01T13:07:36Z/1800/host/0a859ce949951fe15a4eb6874a9765f9e8a6f7147f206cf47e270c34c862b8c6响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 08 Aug 2022 08:32:05 GMT
X-Bce-Gateway-Region: BJ
X-Bce-Request-Id: dc60c252-5bc5-4d98-96c4-14473048dc9f