文档

ListRepositoryWebhook - 查询代码仓库的webhook列表

更新时间:

批量查询在代码仓库上配置的webhook记录,支持分页功能。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /repository/{repositoryId}/webhooks/list

请求参数

名称类型必填描述示例值
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

0cf2c8458ac44d9481aab2dd6ec10596v3
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5fbe3118672533690be72b12
repositoryIdlong

代码库 ID

2825387
pagelong

页码 默认值为 1,从第 1 页开始。

1
pageSizelong

每页大小 默认值为 20,取值范围【1,100】

10

返回参数

名称类型描述示例值
object

返回结果对象

errorMessagestring

错误信息

“”
requestIdstring

请求 ID

HC93CE1A-8D7A-13A9-8306-7465DE2E5C0F
totallong

总记录数。

100
successboolean

调用是否成功

true
errorCodestring

错误码

SYSTEM_NOT_FOUND_ERROR
resultobject []

dataSet 列表

pushEventsboolean

是否为代码推送事件 可选值:true / false

false
projectIdlong

代码库 ID

2825387
createdAtstring

创建时间

2022-03-18 14:24:54
urlstring

webhook 链接

https://xxxx
tagPushEventsboolean

是否为标签推送事件 可选值:true / false

false
lastTestResultstring

最后执行结果 可选值:ok / error / ""(空字符串)

ok
mergeRequestsEventsboolean

是否为代码合并事件 可选值:true / false

true
descriptionstring

描述

线下测试
noteEventsboolean

是否为评论事件 可选值:true / false

false
secretTokenstring

密钥,用户自定义用于区分 hook

xxxx
idlong

webhook 唯一标识

16776
enableSslVerificationboolean

是否使用 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错误码错误信息
500SystemError.UnKnownErrorAn error occurred while processing your request.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈