# 获取仓库通知设置 - ShowNotificationSubscription #### 功能介绍 获取仓库通知设置 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/doc?api=ShowNotificationSubscription&version=v4)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codeartsrepo/codeartsrepo_05_0036.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsrepo:repository:getRepository | Read | - | - | - | - | #### URI GET /v4/repositories/{repository_id}/notification-subscriptions/subscription 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | repository_id | 是 | Integer | **参数解释：** 仓库的ID，通过[查询用户所有仓库](https://support.huaweicloud.com/api-codeartsrepo/ListUserAllRepositories.html)接口查询项目列表获取。 **约束限制：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 通知类型。 **取值范围：** - internal_message，站内信。 - email，邮件。 - qyweixin，企业微信。 - feishu，飞书。 - dingding，钉钉。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | repository_id | Integer | **参数解释：** 仓库ID。 **取值范围：** 1\~2147483647 | | enabled | Boolean | **参数解释：** 开启通知。 | | config_source | String | **参数解释：** 配置源。 | | webhook_config | [RepoWebHookSubscriptionDto] object | **参数解释：** webhook配置。 | | waring_repo_usage_rate | Integer | **参数解释：** 仓库使用量告警阈值（百分比）。 | | subscript_events | Array of [RepoSubscriptionEventDto] objects | **参数解释：** 通知事件。 | 表5RepoWebHookSubscriptionDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | url | String | **参数解释：** webhook的url。 | | mention_users | String | **参数解释：** userid列表，提醒群中的指定成员（@某个成员），最长1000，每个最长100，";"分隔符。 | | mention_phone | String | **参数解释：** 手机号列表，提醒手机号对应的群成员（@某个成员），最长1000，每个最长30，";"分隔符。 | | has_token | Boolean | **参数解释：** 是否设置了token。 | 表6RepoSubscriptionEventDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_type | String | **参数解释：** 资源类型。 - repo，仓库。 - mr，合并请求。 - member，成员。 - note，检视意见。 | | action | String | **参数解释：** 事件名。 - create，创建。 - open，开启。 - update，更新。 - delete，删除。 - merge，合并。 - review，检视。 - approve，审核。 - create_note，新建评审意见。 - resolve_note，解决评审意见。 - mention，被提及。 | | enabled | Boolean | **参数解释：** 启用事件通知 | | role_ids | Array of strings | **参数解释：** 通知的角色ID列表 | | role_names | Array of strings | **参数解释：** 通知的角色名称列表。 - creator，创建者。 - assignee，合并人。 - reviewer，评审人。 - scorer，审核人。 - approver，检视人。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 | | error_msg | String | **参数解释：** 错误信息。 | **状态码：403** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 | | error_msg | String | **参数解释：** 错误信息。 | **状态码：404** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 | | error_msg | String | **参数解释：** 错误信息。 | #### 请求示例 无 #### 响应示例 **状态码：200** Get a repo notification subscription ``` { "repository_id" : 2111978605, "enabled" : true, "config_source" : "repo", "webhook_config" : { "url" : "https://example.com/webhook/send?key=xxxx", "mention_users" : "1;2", "mention_phone" : "17812341234;18512341234;16712345678" }, "waring_repo_usage_rate" : 60, "subscript_events" : [ { "resource_type" : "mr", "action" : "open", "enabled" : true, "role_ids" : null, "role_names" : [ ] }, { "resource_type" : "mr", "action" : "update", "enabled" : true, "role_ids" : null, "role_names" : [ ] }, { "resource_type" : "mr", "action" : "merge", "enabled" : true, "role_ids" : null, "role_names" : [ ] }, { "resource_type" : "mr", "action" : "review", "enabled" : true, "role_ids" : null, "role_names" : [ ] }, { "resource_type" : "mr", "action" : "approve", "enabled" : true, "role_ids" : null, "role_names" : [ ] }, { "resource_type" : "mr", "action" : "create_note", "enabled" : true, "role_ids" : null, "role_names" : [ ] }, { "resource_type" : "mr", "action" : "resolve_note", "enabled" : true, "role_ids" : null, "role_names" : [ ] }, { "resource_type" : "repo", "action" : "delete", "enabled" : true, "role_ids" : [ "" ], "role_names" : null }, { "resource_type" : "repo", "action" : "capacity_warning", "enabled" : true, "role_ids" : [ "" ], "role_names" : null } ] } ``` **状态码：401** Unauthorized ``` { "error_code" : "CH.00000001", "error_msg" : "未识别到用户认证信息" } ``` **状态码：403** Bad Request ``` { "error_code" : "CH.00401008", "error_msg" : "您没有操作权限，请升级权限后重试。" } ``` **状态码：404** Not Found ``` { "error_code" : "CH.00402000", "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 ShowNotificationSubscriptionSolution { 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(); ShowNotificationSubscriptionRequest request = new ShowNotificationSubscriptionRequest(); request.withRepositoryId({repository_id}); try { ShowNotificationSubscriptionResponse response = client.showNotificationSubscription(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 = ShowNotificationSubscriptionRequest() request.repository_id = {repository_id} response = client.show_notification_subscription(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.ShowNotificationSubscriptionRequest{} request.RepositoryId = int32({repository_id}) response, err := client.ShowNotificationSubscription(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=ShowNotificationSubscription&version=v4)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Get a repo notification subscription | | 401 | Unauthorized | | 403 | Bad Request | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeartsrepo/ErrorCode.html)。