文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Repository/ 获取仓库通知设置启用状态
更新时间：2025-08-20 GMT+08:00
查看PDF
分享

获取仓库通知设置启用状态

功能介绍

获取仓库通知设置启用状态

调试

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

URI

GET /v4/repositories/{repository_id}/notification-subscriptions/status

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

仓库的ID，通过查询用户所有仓库接口查询项目列表获取。

约束限制：

不涉及。

取值范围：

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

internal_message

RepoNotificationSubscriptionStateDto object

参数解释：

站内信通知。

email

RepoNotificationSubscriptionStateDto object

参数解释：

邮件通知。

qyweixin

RepoNotificationSubscriptionStateDto object

参数解释：

企业微信通知。

feishu

RepoNotificationSubscriptionStateDto object

参数解释：

飞书通知。

dingding

RepoNotificationSubscriptionStateDto object

参数解释：

钉钉通知。
表4 RepoNotificationSubscriptionStateDto

参数

参数类型

描述

config_source

String

参数解释：

配资源。

枚举值：

  • repo

  • product

enabled

Boolean

参数解释：

开启通知。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

无

响应示例

状态码：200

通知设置开关状态列表

{
  "internal_message" : {
    "config_source" : "repo",
    "enabled" : false
  },
  "email" : {
    "config_source" : "repo",
    "enabled" : true
  },
  "qyweixin" : {
    "config_source" : "repo",
    "enabled" : false
  },
  "feishu" : {
    "config_source" : "repo",
    "enabled" : false
  },
  "dingding" : {
    "config_source" : "repo",
    "enabled" : false
  }
}

状态码：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" : "该仓库不存在,请检查后重试。"
}

状态码

状态码

描述

200

通知设置开关状态列表

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码。

父主题： Repository

相关文档