# 更新仓库下单个Webhook数据 - UpdateRepositoryWebhook #### 功能介绍 更新仓库下单个Webhook数据 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/doc?api=UpdateRepositoryWebhook&version=v4)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codeartsrepo/codeartsrepo_05_0036.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsrepo:repository:setRepository | Write | - | - | - | - | #### URI PUT /v4/repositories/{repository_id}/hooks/{hook_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | repository_id | 是 | Integer | **参数解释：** 仓库的ID，通过[查询用户所有仓库](https://support.huaweicloud.com/api-codeartsrepo/ListUserAllRepositories.html)接口查询项目列表获取。 **约束限制：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | | hook_id | 是 | Integer | **参数解释：** Webhook id。 **取值范围：** 1\~2147483647 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | url | 否 | String | **参数解释：** webhook地址。 **取值范围：** 字符串长度不少于0，不超过500。 | | push_events | 否 | Boolean | **参数解释：** 是否启用推送事件。 | | push_events_branch_regex_filter | 否 | String | **参数解释：** 推送事件分支过滤正则规则。 **取值范围：** 字符串长度不少于0，不超过500。 | | note_plain_text_filter | 否 | Array of strings | **参数解释：** 评论事件文本过滤规则。 **取值范围：** 字符串长度不少于0，不超过50，不能超过10个。 | | tag_push_events | 否 | Boolean | **参数解释：** 是否启用Tag推送事件。 | | merge_requests_events | 否 | Boolean | **参数解释：** 是否启用合并请求事件。 | | note_events | 否 | Boolean | **参数解释：** 是否启用评论事件。 | | token | 否 | String | **参数解释：** token值，作为返回值时会使用掩码代替实际值。 **取值范围：** 字符串长度不少于0，不超过2000。 | | token_type | 否 | String | **参数解释：** token类型，默认为X-Repo-Token。 **取值范围：** 字符串长度不少于0，不超过200。 | | name | 否 | String | **参数解释：** 名称。 **取值范围：** 字符串长度不少于0，不超过200。 | | description | 否 | String | **参数解释：** 描述。 **取值范围：** 字符串长度不少于0，不超过200。 | #### 响应参数 **状态码：201** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | **参数解释：** webhook地址。 **取值范围：** 字符串长度不少于0，不超过500。 | | push_events | Boolean | **参数解释：** 是否启用推送事件。 | | push_events_branch_regex_filter | String | **参数解释：** 推送事件分支过滤正则规则。 **取值范围：** 字符串长度不少于0，不超过500。 | | note_plain_text_filter | Array of strings | **参数解释：** 评论事件文本过滤规则。 **取值范围：** 字符串长度不少于0，不超过50，不能超过10个。 | | tag_push_events | Boolean | **参数解释：** 是否启用Tag推送事件。 | | merge_requests_events | Boolean | **参数解释：** 是否启用合并请求事件。 | | note_events | Boolean | **参数解释：** 是否启用评论事件。 | | token | String | **参数解释：** token值，作为返回值时会使用掩码代替实际值。 **取值范围：** 字符串长度不少于0，不超过2000。 | | token_type | String | **参数解释：** token类型，默认为X-Repo-Token。 **取值范围：** 字符串长度不少于0，不超过200。 | | name | String | **参数解释：** 名称。 **取值范围：** 字符串长度不少于0，不超过200。 | | description | String | **参数解释：** 描述。 **取值范围：** 字符串长度不少于0，不超过200。 | | event_cfgs | Array of [WebHookEventCfgDto] objects | **参数解释：** 预留字段，事件触发设置，可为空。 | | project_cfgs | Array of [WebHookBranchCfgDto] objects | **参数解释：** 预留字段，仓库分支规则设置，可为空。 | | branch_cfgs | Array of [WebHookBranchCfgDto] objects | **参数解释：** 预留字段，仓库分支规则设置，可为空。 **约束限制：** 预留字段，仅仓库设置有效。 | | id | Integer | **参数解释：** Webhook id。 **取值范围：** 1\~2147483647 | | created_at | String | **参数解释：** 创建时间。 **参数解释：** yyyy-MM-dd'T'HH:mm:ss.SSSXXX | | updated_at | String | **参数解释：** 更新时间。 **参数解释：** yyyy-MM-dd'T'HH:mm:ss.SSSXXX | | service | String | **参数解释：** 内部服务名称。 | 表5WebHookEventCfgDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | event_type | String | **参数解释：** 事件类型。 **取值范围：** 最小1个字节，最大255字节 | | cfgs | String | **参数解释：** 配置信息。 **取值范围：** 最小1个字节，最大255字节 | 表6WebHookBranchCfgDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | branch_type | Integer | **参数解释：** 分支类型。 **取值范围：** - 0，文本。 - 1，通配符。 - 2，正则。 **默认取值：** 0 | | branch | String | **参数解释：** 分支名配置。 **取值范围：** 最小1个字节，最大255字节 | | project_type | Integer | **参数解释：** 仓库名类型。 **取值范围：** - 0，文本。 - 1，通配符。 - 2，正则。 **默认取值：** 0 | | project | String | **参数解释：** 仓库名配置。 **取值范围：** 最小1个字节，最大255字节 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 | | error_msg | String | **参数解释：** 错误信息。 | **状态码：403** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 | | error_msg | String | **参数解释：** 错误信息。 | #### 请求示例 ``` PUT https://{endpoint}/v4/repositories/1/hooks/1 { "url" : "https://demo1.com", "push_events" : true, "push_events_branch_regex_filter" : ".*", "tag_push_events" : true, "merge_requests_events" : false, "note_events" : false, "token" : "exampletoken", "token_type" : "X-Repo-Token", "name" : "代码检查", "description" : "代码检查" } ``` #### 响应示例 **状态码：201** OK ``` { "id" : 1, "url" : "https://demo.com", "push_events" : true, "push_events_branch_regex_filter" : ".*", "tag_push_events" : true, "merge_requests_events" : false, "note_events" : false, "token" : "", "token_type" : "X-Repo-Token", "name" : "代码检查", "description" : "代码检查", "created_at" : "2024-10-15T22:30:24.000+08:00", "updated_at" : "2024-10-15T22:30:24.000+08:00" } ``` **状态码：401** Unauthorized ``` { "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" } ``` **状态码：403** Bad Request ``` { "error_code" : "CH.004403", "error_msg" : "您没有操作权限，请升级权限后重试。" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsrepo.v4.region.CodeArtsRepoRegion; import com.huaweicloud.sdk.codeartsrepo.v4.*; import com.huaweicloud.sdk.codeartsrepo.v4.model.*; public class UpdateRepositoryWebhookSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsRepoClient client = CodeArtsRepoClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsRepoRegion.valueOf("")) .build(); UpdateRepositoryWebhookRequest request = new UpdateRepositoryWebhookRequest(); request.withRepositoryId({repository_id}); request.withHookId({hook_id}); WebhookParamsDto body = new WebhookParamsDto(); body.withDescription("代码检查"); body.withName("代码检查"); body.withTokenType("X-Repo-Token"); body.withToken("exampletoken"); body.withNoteEvents(false); body.withMergeRequestsEvents(false); body.withTagPushEvents(true); body.withPushEventsBranchRegexFilter(".*"); body.withPushEvents(true); body.withUrl("https://demo1.com"); request.withBody(body); try { UpdateRepositoryWebhookResponse response = client.updateRepositoryWebhook(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` #### Python ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsrepo.v4.region.codeartsrepo_region import CodeArtsRepoRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsrepo.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsRepoClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsRepoRegion.value_of("")) \ .build() try: request = UpdateRepositoryWebhookRequest() request.repository_id = {repository_id} request.hook_id = {hook_id} request.body = WebhookParamsDto( description="代码检查", name="代码检查", token_type="X-Repo-Token", token="exampletoken", note_events=False, merge_requests_events=False, tag_push_events=True, push_events_branch_regex_filter=".*", push_events=True, url="https://demo1.com" ) response = client.update_repository_webhook(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsrepo "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartsrepo.CodeArtsRepoClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartsrepo.NewCodeArtsRepoClient(hcClient) request := &model.UpdateRepositoryWebhookRequest{} request.RepositoryId = int32({repository_id}) request.HookId = int32({hook_id}) descriptionWebhookParamsDto:= "代码检查" nameWebhookParamsDto:= "代码检查" tokenTypeWebhookParamsDto:= "X-Repo-Token" tokenWebhookParamsDto:= "exampletoken" noteEventsWebhookParamsDto:= false mergeRequestsEventsWebhookParamsDto:= false tagPushEventsWebhookParamsDto:= true pushEventsBranchRegexFilterWebhookParamsDto:= ".*" pushEventsWebhookParamsDto:= true urlWebhookParamsDto:= "https://demo1.com" request.Body = &model.WebhookParamsDto{ Description: &descriptionWebhookParamsDto, Name: &nameWebhookParamsDto, TokenType: &tokenTypeWebhookParamsDto, Token: &tokenWebhookParamsDto, NoteEvents: ¬eEventsWebhookParamsDto, MergeRequestsEvents: &mergeRequestsEventsWebhookParamsDto, TagPushEvents: &tagPushEventsWebhookParamsDto, PushEventsBranchRegexFilter: &pushEventsBranchRegexFilterWebhookParamsDto, PushEvents: &pushEventsWebhookParamsDto, Url: &urlWebhookParamsDto, } response, err := client.UpdateRepositoryWebhook(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/sdk?api=UpdateRepositoryWebhook&version=v4)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | OK | | 401 | Unauthorized | | 403 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeartsrepo/ErrorCode.html)。