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

创建项目hook - CreateProjectHook

功能介绍

创建项目hook。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

namespace

是

String

参数解释：

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

取值范围：

不涉及

默认取值：

不涉及

project

是

String

参数解释：

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

取值范围：

不涉及

默认取值：

不涉及

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释：

消息体的类型（格式）。

约束限制：

不涉及

取值范围：

application/json;charset=utf8

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

X-Repo-Auth

是

String

参数解释：

授权名称。通过获取仓库授权列表 - ObtainGitRepositoryAuthorizationList获取对应的授权名称。

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

secret

是

String

参数解释：

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

取值范围：

不涉及

默认取值：

不涉及

url

是

String

参数解释：

hook触发时回调的url。

取值范围：

不涉及

默认取值：

不涉及

响应消息

表4 hooks

参数

参数类型

描述

id

String

参数解释：

hook ID。

取值范围：

不涉及

type

String

参数解释：

hook类型。

取值范围：

  • pre-commit：提交前。
  • post-commit：提交后。
  • pre-push：推送前。
  • post-merge：合并后。
  • pre-rebase：变基前。

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

错误的请求。

错误码

请参考ServiceStage错误码。

父主题： 访问Git仓库API

相关文档