获取仓库通知设置
功能介绍
获取仓库通知设置
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/notification-subscriptions/subscription
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
参数解释: 通知类型。 取值范围:
枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数解释: 通知事件。 |
参数 |
参数类型 |
描述 |
---|---|---|
url |
String |
参数解释: webhook的url。 |
mention_users |
String |
参数解释: userid列表,提醒群中的指定成员(@某个成员),最长1000,每个最长100,“;”分隔符。 |
mention_phone |
String |
参数解释: 手机号列表,提醒手机号对应的群成员(@某个成员),最长1000,每个最长30,“;”分隔符。 |
has_token |
Boolean |
参数解释: 是否设置了token。 |
参数 |
参数类型 |
描述 |
---|---|---|
resource_type |
String |
参数解释: 资源类型。
枚举值:
|
action |
String |
参数解释: 事件名。
枚举值:
|
enabled |
Boolean |
参数解释: 启用事件通知 |
role_ids |
Array of strings |
参数解释: 通知的角色ID列表 |
role_names |
Array of strings |
参数解释: 通知的角色名称列表。
枚举值:
|
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
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.codehub.v4.region.CodeHubRegion; import com.huaweicloud.sdk.codehub.v4.*; import com.huaweicloud.sdk.codehub.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); CodeHubClient client = CodeHubClient.newBuilder() .withCredential(auth) .withRegion(CodeHubRegion.valueOf("<YOUR REGION>")) .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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodehub.v4.region.codehub_region import CodeHubRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodehub.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 = CodeHubClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \ .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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codehub.NewCodeHubClient( codehub.CodeHubClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) 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的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Get a repo notification subscription |
401 |
Unauthorized |
403 |
Bad Request |
404 |
Not Found |
错误码
请参见错误码。