文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 访问Git仓库API/ 创建项目hook
更新时间：2024-10-11 GMT+08:00
查看PDF
分享

创建项目hook

功能介绍

创建项目hook。

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{project_id}/git/repos/{namespace}/{project}/hooks

参数说明见表1。

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID。获取方法，请参考获取项目ID。

namespace

是

String

命名空间ID或者URL编码名称。获取方法，请参考获取仓库namespaces。

project

是

String

仓库项目ID或者URL编码名称，如果含有“/”，需要将“/”替换为“:”。获取方法，请参考获取命名空间下所有项目。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。

X-Repo-Auth

是

String

授权名称，通过获取仓库授权列表获取对应的授权名称。
表3 请求Body参数

参数

是否必选

参数类型

描述

secret

是

String

用于验证接收到的payloads的字符串。

url

是

String

hook触发时回调的url。

响应消息

表4 响应参数

参数

参数类型

描述

id

String

hook ID。

type

String

hook类型。

callback_url

String

回调url。

请求示例

创建项目hook，验证接收到的payloads的字符串的secrete参数，hook触发时回调的url设置为https://example.com/webhook。

{
  "secret": "**********",
  "url": "https://example.com/webhook"
}

响应示例

{
  "id": "1573",
  "type": "github",
  "callback_url": "https://example.com/webhook"
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

错误码

错误码格式为：SVCSTG.REPO.[Error_ID]，例如：SVCSTG.REPO.0401。错误码说明请参考ServiceStage错误码。

父主题： 访问Git仓库API

相关文档