云服务器内容精选

  • 响应示例 状态码: 200 OK { "result": { "id": 89, "url": "http://www.example.com/project002", "push_events": false, "tag_push_events": true, "merge_requests_events": false, "note_events": false, "token": "************", "name": "Webhook_new", "description": null, "token_type": "X-Repo-Token", "status": 0, "manual_build": false, "service": null, "push_events_branch_regex_filter": ".*", "created_at": "2024-09-10T11:49:04.000+08:00" }, "status": "success" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 参数解释: 接口调用时,响应错误。 取值范围: 无。 result Webhook object 参数解释: 接口调用的响应结果。 取值范围: 无。 status String 参数解释: 调用此接口的响应状态。 取值范围: success,表示接口调用成功。 failed,表示接口调用失败。 表5 Error 参数 参数类型 描述 code String 参数解释: 调用此接口失败时返回的错误码。 取值范围: CH.000404,表示查询项目Webhook失败,您需要检查Webhook ID是否正确。 message String 参数解释: 调用此接口失败时返回的提示信息。
  • 请求示例 PUT https://{endpoint}/v1/projects/{project_uuid}/user-hooks/{hook_id} { "url":"http://www.example.com/project002", "name":"Webhook_new", "token_type":"X-Repo-Token", "token":"213", "push_events":false, "merge_requests_events":false, "tag_push_events":true, "note_events":false }
  • URI PUT /v1/projects/{project_uuid}/user-hooks/{hook_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_uuid 是 String 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由数字和字母组成,且长度为32个字符。 默认取值: 不涉及。 hook_id 是 String 参数解释: Webhook ID 约束限制: 不涉及。 取值范围: 只能由数字组成,且范围为0-2147483647。 默认取值: 不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 url 是 String 参数解释: Webhook Url 取值范围: 不涉及。 push_events 否 Boolean 参数解释: 是否触发推送事件 取值范围: true:该事件触发 false:该事件不触发 tag_push_events 否 Boolean 参数解释: 是否触发Tag推送事件 取值范围: true:该事件触发 false:该事件不触发 merge_requests_events 否 Boolean 参数解释: 是否触发合并请求事件 取值范围: true:该事件触发 false:该事件不触发 note_events 否 Boolean 参数解释: 是否触发评论事件 取值范围: true:该事件触发 false:该事件不触发 token 否 String 参数解释: Token(已加密) 取值范围: 不涉及。 name 是 String 参数解释: Webhook 名称 取值范围: 必须为UTF-8字符 description 否 String 参数解释: Webhook 描述 取值范围: 必须为UTF-8字符 token_type 否 String 参数解释: Token 类型 取值范围: X-Repo-Token X-Gitlab-Token X-Auth-Token push_events_branch_regex_filter 否 String 参数解释: 分支过滤正则规则,勾选推送事件需配置 取值范围: 必须为正则表达式
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepoListHook object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 RepoListHook 参数 参数类型 描述 hooks Array of RepoHook objects hook列表 表7 RepoHook 参数 参数类型 描述 build_events Boolean 是否触发build_events事件 created_at String 仓库统计创建的时间 enable_ssl_verification Boolean 是否使用ssl验证 id Integer hook id issues_events Boolean 是否触发issues_events事件 merge_requests_events Boolean 是否触发merge_requests_events事件 note_events Boolean 是否触发note_events事件 pipeline_events Boolean 是否触发pipeline_events事件 project_id Integer 仓库id push_events Boolean 是否触发push_events事件 repository_update_events Boolean 是否触发repository_update_events事件 tag_push_events Boolean 是否触发tag_push_events事件 wiki_page_events Boolean 是否触发wiki_page_events事件
  • URI GET /v1/repositories/{group_name}/{repository_name}/hooks 表1 路径参数 参数 是否必选 参数类型 描述 group_name 是 String 组名(克隆地址中 域名 后面项目名前的一段 示例:git@repo.alpha.devcloud.inhuawei.com:Demo00228/testword.git 组名:Demo00228 ) repository_name 是 String 仓库名 表2 Query参数 参数 是否必选 参数类型 描述 hook_id 否 String hook id
  • 响应示例 状态码: 200 OK { "result" : { "hooks" : [ { "id" : 2111600786, "project_id" : 2111615967, "created_at" : "2021-11-09 16:35:15", "enable_ssl_verification" : false, "push_events" : true, "tag_push_events" : false, "repository_update_events" : false, "merge_requests_events" : false, "issues_events" : false, "note_events" : false, "pipeline_events" : false, "wiki_page_events" : false } ] }, "status" : "success"}