网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

回复MR检视意见

更新时间:2024-11-08 GMT+08:00
分享

功能介绍

回复MR检视意见

调试

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

URI

POST /v2/repositories/{repository_id}/merge_requests/{merge_request_iid}/discussions/{discussion_id}/notes

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

仓库id。

约束限制:

必传。

取值范围:

最小值:1

最大值:2147483647

merge_request_iid

Integer

参数解释:

合并请求iid(仓库的第几个mr)。

约束限制:

必传。

取值范围:

最小值:1

最大值:2147483647

discussion_id

String

评论id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

body

String

参数解释:

检视意见内容。

约束限制:

必传。

取值范围:

长度限制:8000字符。

字符限制:unicode编码\u0000 - \uffff,不支持emoji表情、部分生僻字等特殊字符。

blank限制:不能为null或空字符串或全是空格。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

参数解释:

响应错误码

result

NoteDto object

参数解释:

返回新建检视意见的相关信息。

取值范围:

无。

status

String

参数解释:

响应状态。

取值范围:

  • success,表示接口调用成功。
  • failed,表示接口调用失败。
表5 Error

参数

参数类型

描述

code

String

参数解释:

调用此接口失败时返回的错误码。

取值范围:

  • CH.10000,系统繁忙,请稍后再试。

message

String

参数解释:

调用此接口失败时返回的提示信息。

取值范围:

  • “系统繁忙,请稍后再试”
表6 NoteDto

参数

参数类型

描述

id

Integer

参数解释:

评论id,主评论和回复不共用。

取值范围:

最小值:1

最大值:2147483647

type

String

参数解释:

note类型。

取值范围:

  • DiffNote:文件变更页提的需要解决的检视意见。
  • MergeRequestNote:详情页提的需要解决的检视意见。
  • null:详情页提的不需要解决的意见。

body

String

参数解释:

检视意见内容。

取值范围:

长度限制:8000字符。

字符限制:unicode编码\u0000 - \uffff,不支持emoji表情、部分生僻字等特殊字符。

blank限制:不能为null或空字符串或全是空格。

attachment

String

参数解释:

附件(废弃字段)。

取值范围:

无。

author

UserBasicDto object

参数解释:

作者详细信息。

取值范围:

无。

created_at

String

参数解释:

创建时间。

约束限制:

格式:yyyy-MM-ddTHH:mm:ss.SSS+08:00

updated_at

String

参数解释:

更新时间。

约束限制:

格式:yyyy-MM-ddTHH:mm:ss.SSS+08:00

system

Boolean

参数解释:

是否是系统生成的日志。

取值范围:

  • true:系统创建的检视意见。
  • false:用户创建的检视意见。

noteable_id

Integer

参数解释:

MR的id。

取值范围:

最小值:1

最大值:2147483647

noteable_type

String

参数解释:

意见类型。

取值范围:

  • MergeRequest:MR或CR下提的意见(MR或CR下点提交记录,选择一次提交加检视意见,仍是MergeRequest类型)
  • Commit:代码下或一次提交下提的意见

commit_id

String

参数解释:

关联的提交id:noteable_type为Commit的检视意见的特有字段,为此次提交的sha值。

取值范围:

只能为数字和字母,长度为40字符。

resolvable

Boolean

参数解释:

意见是否需要解决。

取值范围:

  • true:可解决的检视意见。
  • false或null:不可解决的检视意见。

is_reply

Boolean

参数解释:

是否是回复的评论。

取值范围:

  • true:回复的评论。
  • false:主评论。

resolved_by

UserBasicDto object

参数解释:

检视意见的解决人。

取值范围:

无。

noteable_iid

Integer

参数解释:

MR的iid,表示为该仓库第几个MR。

取值范围:

最小值:1

最大值:2147483647

discussion_id

String

参数解释:

检视意见id,主评论和回复共用。

取值范围:

只能为数字和字母,长度为40字符。

project

String

参数解释:

项目路径。

取值范围:

无。

diff_file

String

参数解释:

变更文件路径。

取值范围:

无。

diff

String

参数解释:

变更文件内容。

取值范围:

无。

archived

Boolean

参数解释:

检视意见是否已归档,归档后不允许编辑删除回复解决该意见。

取值范围:

  • true:检视意见已归档。
  • false或null:检视意见未归档。

review_categories

String

参数解释:

检视意见分类的key。

自定义分类的review_categories、review_categories_cnreview_categories_en一致。

取值范围:

无。

review_categories_cn

String

参数解释:

检视意见分类的中文名。

自定义分类的review_categories、review_categories_cn一致。

取值范围:

无。

review_categories_en

String

参数解释:

检视意见分类的英文名。

自定义分类的review_categories、review_categories_en一致。

取值范围:

无。

review_modules

String

参数解释:

检视意见模块。

取值范围:

无。

severity

String

参数解释:

严重程度,非建议级别意见指派人和MR/Commit作者不能点解决。

取值范围:

  • suggestion:建议;
  • minor:一般;
  • major: 严重;
  • fatal:致命。

severity_cn

String

参数解释:

严重程度中文名。

取值范围:

  • 建议
  • 一般
  • 严重
  • 致命

severity_en

String

参数解释:

严重程度英文名。

取值范围:

  • Suggestion:建议
  • Minor:一般
  • Major:严重
  • Fatal:致命

file_path

String

参数解释:

文件路径(弃用)。

取值范围:

无。

line

String

参数解释:

行号(弃用)。

取值范围:

无。

assignee

UserBasicDto object

参数解释:

指派人详细信息。

取值范围:

无。

proposer

UserBasicDto object

参数解释:

检视人详细信息。

取值范围:

无。

position

PositionDto object

参数解释:

代码位置信息:意见关联何处代码 。

取值范围:

无。

resolved

Boolean

参数解释:

检视意见是否已解决。

取值范围:

  • true:检视意见已解决。
  • false或null:检视意见未解决。

is_outdated

Boolean

参数解释:

是否过时。

取值范围:

  • true:基于最新提交的检视意见。
  • false或null:不是基于最新提交的检视意见
表7 UserBasicDto

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

最小值:1

最大值:2147483647

name

String

参数解释:

名字。

取值范围:

长度为[0,255]个字符。

username

String

参数解释:

用户名。

取值范围:

长度为[0,255]个字符。

state

String

参数解释:

状态。

取值范围:

长度为[0,255]个字符。

avatar_url

String

参数解释:

获取头像的url。

取值范围:

无。

avatar_path

String

参数解释:

获取头像的路径。

取值范围:

无。

email

String

参数解释:

邮箱。

取值范围:

无。

name_cn

String

参数解释:

中文名。

约束限制:

此字段已弃用,取值同username。

取值范围:

无。

web_url

String

参数解释:

主页url。

取值范围:

无。

nick_name

String

参数解释:

昵称。

取值范围:

无。

tenant_name

String

参数解释:

租户名称。

取值范围:

无。

表8 PositionDto

参数

参数类型

描述

base_sha

String

参数解释:

源分支base提交节点。

取值范围:

只能为数字和字母,长度为40字符。

start_sha

String

参数解释:

源分支最新提交节点。

取值范围:

只能为数字和字母,长度为40字符。

head_sha

String

参数解释:

目标分支最新提交节点。

取值范围:

只能为数字和字母,长度为40字符。

old_path

String

参数解释:

修改前文件路径。

取值范围:

无。

new_path

String

参数解释:

修改后文件路径。

取值范围:

无。

position_type

String

参数解释:

变更类型。

取值范围:

无。

默认取值:

text。

old_line

Integer

参数解释:

修改前行号,小于等于0或为null,表示此行为新增行,即对比时位于右侧,绿色显示。

取值范围:

-1-2147483647或为null。

new_line

Integer

参数解释:

修改后行号。

小于等于0或为null,表示此行为删除行,即对比时位于左侧,红色显示。

取值范围:

-1-2147483647或为null。

请求示例

POST https://{endpoint}/v2/repositories/{repository_id}/merge_requests/{merge_request_iid}/discussions/{discussion_id}/notes

{
  "body" : "回复内容"
}

响应示例

状态码: 200

OK

{
    "result": {
        "id": 2111974340,
        "type": "DiffNote",
        "body": "回复内容",
        "author": {
            "id": 9124,
            "name": "CodeHub_beta_dev",
            "username": "c369c68f1ff84679b5a8ed904d8bff1c",
            "state": "active",
            "avatar_url": "",
            "email": "liujian@example.com",
            "name_cn": "CodeHub_beta_dev",
            "web_url": "https://test.com/c369c68f1ff84679b5a8ed904d8bff1c",
            "nick_name": "我是昵称",
            "tenant_name": "devcloud_codehub_l00314597_01"
        },
        "created_at": "2024-07-30T10:47:54.000+08:00",
        "updated_at": "2024-07-30T10:47:54.000+08:00",
        "system": false,
        "noteable_id": 38517,
        "noteable_type": "MergeRequest",
        "resolvable": true,
        "is_reply": true,
        "noteable_iid": 18,
        "discussion_id": "996f57b8fdd5e62678b16f0ea4f91688405fa72f",
        "project": "sll_test00006/mr_test",
        "diff_file": "a.txt",
        "diff": "@@ -0,0 +1,0 @@\n+1\r\n",
        "archived": false,
        "review_categories": "分类",
        "review_categories_cn": "分类",
        "review_categories_en": "分类",
        "review_modules": "模块",
        "severity": "suggestion",
        "severity_cn": "建议",
        "severity_en": "Suggestion",
        "assignee": {
            "id": 9124,
            "name": "CodeHub_beta_dev",
            "username": "c369c68f1ff84679b5a8ed904d8bff1c",
            "state": "active",
            "avatar_url": "",
            "email": "liujian@example.com",
            "name_cn": "CodeHub_beta_dev",
            "web_url": "https://test.com/c369c68f1ff84679b5a8ed904d8bff1c",
            "nick_name": "我是昵称",
            "tenant_name": "devcloud_codehub_l00314597_01"
        },
        "proposer": {
            "id": 9124,
            "name": "CodeHub_beta_dev",
            "username": "c369c68f1ff84679b5a8ed904d8bff1c",
            "state": "active",
            "avatar_url": "",
            "email": "liujian@example.com",
            "name_cn": "CodeHub_beta_dev",
            "web_url": "https://test.com/c369c68f1ff84679b5a8ed904d8bff1c",
            "nick_name": "我是昵称",
            "tenant_name": "devcloud_codehub_l00314597_01"
        },
        "position": {
            "base_sha": "a9ce1513d5185d5fe2bac52c597f204ce695c4be",
            "start_sha": "a9ce1513d5185d5fe2bac52c597f204ce695c4be",
            "head_sha": "53c75fa88dc4e7d0b68d108b7f1ee0a5c4564f44",
            "old_path": "a.txt",
            "new_path": "a.txt",
            "position_type": "text",
            "new_line": 1
        },
        "resolved": false,
        "is_outdated": false
    },
    "status": "success"
}

状态码

状态码

描述

200

OK

错误码

状态码

错误码

错误信息

描述

处理措施

400

CH.00401999

'body': The body is out of max length (8000 characters).

检视意见内容超过8000字符

降低内容长度

400

CH.00401015

字符串不可包括表情包或生僻字等无法识别的字符。

unicode编码\u0000 - \uffff,不支持emoji表情、部分生僻字等特殊字符

删除特殊字符

404

CH.00406001

当前合并请求未找到。

MR信息未找到

刷新MR页面后重试。

404

CH.00406048

通过noteId未查询到检视意见。

关联repository_id、merge_request_iid和discussion_id未查询到检视意见

检查并修改传参。

404

CH.00406049

检视意见类型错误。

关联repository_id、merge_request_iid和discussion_id未查询到检视意见

检查并修改传参。

404

CH.00406050

检视意见不属于此commit或merge request。

关联repository_id、merge_request_iid和discussion_id未查询到检视意见

检查并修改传参。

405

CH.00406019

当前不允许在合并后新增检视意见,请改变设置后再进行操作。

设置不允许对已合并mr新增意见

修改合并请求设置。

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容