批量查询在代码仓库上配置的webhook记录，支持分页功能。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /repository/{repositoryId}/webhooks/list HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| repositoryId |
integer |
是 |
代码库 ID |
2825387 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| accessToken |
string |
否 |
个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段 |
0cf2c8458ac44d9481aab2dd6ec10596v3 |
| organizationId |
string |
是 |
企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】 |
5fbe3118672533690be72b12 |
| page |
integer |
否 |
页码 默认值为 1，从第 1 页开始。 |
1 |
| pageSize |
integer |
否 |
每页大小 默认值为 20，取值范围【1,100】 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果对象 |
||
| errorMessage |
string |
错误信息 |
“” |
| requestId |
string |
请求 ID |
HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F |
| total |
integer |
总记录数。 |
100 |
| success |
boolean |
调用是否成功 |
true |
| errorCode |
string |
错误码 |
SYSTEM_NOT_FOUND_ERROR |
| result |
array<object> |
dataSet 列表 |
|
|
object |
返回详情结果 |
||
| pushEvents |
boolean |
是否为代码推送事件 可选值：true / false |
false |
| projectId |
integer |
代码库 ID |
2825387 |
| createdAt |
string |
创建时间，格式为 YYYY-MM-DD HH:mm:ss。 |
2022-03-18 14:24:54 |
| url |
string |
webhook 链接 |
https://xxxx |
| tagPushEvents |
boolean |
是否为标签推送事件 可选值：true / false |
false |
| lastTestResult |
string |
最后执行结果 可选值：ok / error / ""（空字符串） |
ok |
| mergeRequestsEvents |
boolean |
是否为代码合并事件 可选值：true / false |
true |
| description |
string |
描述 |
线下测试 |
| noteEvents |
boolean |
是否为评论事件 可选值：true / false |
false |
| secretToken |
string |
密钥，用户自定义用于区分 hook |
xxxx |
| id |
integer |
webhook 唯一标识 |
16776 |
| enableSslVerification |
boolean |
是否使用 SSL 认证 可选值：true / false |
false |
示例
正常返回示例
JSON格式
{
"errorMessage": "“”",
"requestId": "HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F",
"total": 100,
"success": true,
"errorCode": "SYSTEM_NOT_FOUND_ERROR",
"result": [
{
"pushEvents": false,
"projectId": 2825387,
"createdAt": "2022-03-18 14:24:54",
"url": "https://xxxx",
"tagPushEvents": false,
"lastTestResult": "ok",
"mergeRequestsEvents": true,
"description": "线下测试",
"noteEvents": false,
"secretToken": "xxxx",
"id": 16776,
"enableSslVerification": false
}
]
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | SystemError.UnKnownError | An error occurred while processing your request. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。