华为云用户手册

与 云监控服务 的关系 云监控 服务（Cloud Eye）为用户提供一个针对弹性云服务器、带宽等资源的立体化监控平台。使您全面了解云上的资源使用情况、业务的运行状况，并及时收到异常报警做出反应，保证业务顺畅运行。详情请参见《云监控服务用户指南》 表2 云监控服务支持的DBSS监控指标 指标名称 指标含义 取值范围 单位 进制 测量对象 监控周期 SQL注入告警个数 该指标用于统计测量对象的SQL注入告警个数 ≥0 count Count 不涉及 弹性云服务器 4分钟 XSS跨站脚本漏洞告警个数 该指标用于统计测量对象的XSS跨站脚本漏洞告警个数 ≥0 count Count 不涉及 弹性云服务器 4分钟 Webshell上传告警个数 该指标用于统计测量对象的Webshell上传告警个数 ≥0 count Count 不涉及 弹性云服务器 4分钟 盗链告警个数 该指标用于统计测量对象的盗链告警个数 ≥0 count Count 不涉及 弹性云服务器 4分钟 IP黑名单告警个数 该指标用于统计测量对象的IP黑名单告警个数 ≥0 count Count 不涉及 弹性云服务器 4分钟 IP白名单告警个数 该指标用于统计测量对象的IP白名单告警个数 ≥0 count Count 不涉及 弹性云服务器 4分钟

与 云审计 服务的关系 云审计服务（Cloud Trace Service， CTS ）记录数据库安全服务相关的操作事件，方便用户日后的查询、审计和回溯，具体请参见《云审计服务用户指南》。 表1 云审计服务支持的数据库安全服务操作列表 操作名称 资源类型 事件名称 创建实例 dbss createInstance 删除实例 dbss deleteInstance 开启实例 dbss startInstance 关闭实例 dbss stopInstance 重启实例 dbss rebootInstance 实例状态变化 dbss cloudServiceInstanceStatus 创建包周期实例 dbss cloudServiceInstanceCreate 实例元数据变化 dbss updateMetaData 更新实例 dbss upgradeInstance CBC调用云服务接口更新实例状态 dbss cloudServiceInstanceStatus CBC通知云服务订单发生变化 dbss updateMetaData 包周期购买实例 dbss cloudServiceInstanceCreate 添加标签 dbss createTag 删除标签 dbss deleteTag

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态 message String 请求错误信息 result ReviewEntity object 评审详情 表4 ReviewEntity 参数 参数类型 描述 id String 评审单id number String 评审单编号 state String 评审单工作状态，取值为"正在工作","作废" title String 评审单标题 category String 评审单类别，CR:变更评审，BR:基线评审,GR:通用评审 created_by UserEntity object 评审单创建人 modified_by UserEntity object 评审单最后修改人 assigned_cc Array of UserEntity objects 评审单抄送人 created_time String 评审单创建时间戳 modified_time String 评审单最后修改时间戳 plan_end_date String 计划完成日期时间戳，不可早于计划开始日期 plan_start_date String 计划开始日期时间戳，不可晚于计划完成日期 close_time String 评审单完成时间 need_approval String 评审单是否需要审批人审批，可选值为yes,no status StatusEntity object 评审单状态 description String 评审单描述，列表接口不返回描述信息 closed_time String 评审单完成时间 approver String 审批人id reviewer String 评审人id，逗号分隔 cos Array of COEntity objects 评审对象列表 ccbs Array of CcbEntity objects 审批信息列表 old_status StatusEntity object 评审单状态（更新时使用） cc Array of UserEntity objects 抄送人列表 表5 COEntity 参数 参数类型 描述 after_change String 变更对象修改后内容 review_complete_time String 变更对象评审完成时间 review_phase_result String 变更对象评审阶段结果 Approved：通过 Rejected：拒绝(CR) TurnBacked：驳回(BR/GR) review_time String 变更对象评审时间 before_change String 变更对象工作项修改前内容 category String 变更对象工作项类型，此处固定为CO ccb_info CcbEntity object 变更对象实际审批人信息 ccbs Array of UserEntity objects 变更对象审批人列表，兼容旧版评审。现版本审批人只有一人 change_type String 变更类型，基线评审的修改类型属于Modify Modify：修改 Move：迁移 Delete：删除 co2review String 变更对象关联的评审单Id created_by String 变更对象的创建人ID created_date String 变更对象创建时间 description String 变更对象描述信息 id String 变更对象Id issue_id String 变更对象关联的工作项Id issue_number String 变更对象关联的工作项编号 issue_category String 变更对象关联的工作项类型 modified_by String 变更对象最后修改人Id modified_date String 变更对象最后修改时间 opinions Array of UserEntity objects 变更对象评审专家Id列表（创建变更评审时使用） opinion_comments Array of ReviewOpinionEntity objects 变更对象评审意见 review_comments Array of ReviewCommentEntity objects 变更对象评审意见（评审更新时使用） approval_comments Array of ReviewCommentEntity objects 变更对象决策意见（决策更新时使用） reviewer Array of strings 变更对象评审专家Id列表 approver Array of strings 变更对象审批人ID数组 status String 变更对象状态 表6 CcbEntity 参数 参数类型 描述 approval_time String 审批时间 category String 工作项类型，审批对象固定为CCB ccb2review String 审批对象关联的评审单Id co_id String 关联的变更对象Id id String 审批对象Id owner UserEntity object 审批人 approval_comments String 审批意见 表7 ReviewOpinionEntity 参数 参数类型 描述 category String 评审意见对象类型，固定为Opinion co_id String 评审意见对象关联的变更对象Id created_by UserEntity object 评审意见创建人，即评审人 created_date String 评审意见创建时间 curr_owner UserEntity object 当前评审人 id String 评审意见对象Id modified_date String 评审意见最后修改时间 review_comments String 评审意见 表8 ReviewCommentEntity 参数 参数类型 描述 id String 评审意见对象Id user_id String 评审用户Id other_user_id String 其他用户Id result String 评审结果 comment String 评审意见 表9 UserEntity 参数 参数类型 描述 id String 用户Id name String 用户名称 nick_name String 用户昵称 表10 StatusEntity 参数 参数类型 描述 id String 状态id belonging String 工作项的状态属性，START、IN_PROGRESS、END display_value String 状态名 code String 状态唯一标识 created_by String 状态创建人 created_time String 状态创建时间 modified_by String 状态修改人 modified_time String 状态最近修改时间 category_code Array of strings 状态被哪些工作项使用 状态码：400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v1/ipdprojectservice/projects/{project_id}/review/{id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释：项目的32位uuid，项目唯一标识，可以通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制：正则表达式，^[A-Za-z0-9]{32}$ 默认取值：不涉及 id 是 String 评审单Id 表2 Query参数 参数 是否必选 参数类型 描述 category 是 String 评审单类型,可选值为CR,BR,GR

文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十七次正式发布。本次变更说明如下：补充接口的请求示例和响应示例。 2025-04-25 第二十六次正式发布。本次变更说明如下：增加了IPD项目相关接口。 2024-11-30 第二十五次正式发布。本次变更说明如下：增加了SDK代码示例。 2024-03-08 第二十四次正式发布。本次变更说明如下： 增加了添加指定工作项工时。 增加了查询项目下的工时类型。 增加了获取指定工作项停留时间。 增加了高级查询我的待办工作项。 增加了查询项目模板。 2023-06-08 第二十三次正式发布。本次变更说明如下： issueUser对象中增了两个字段：user_id和user_num_id。 2022-12-06 第二十二次正式发布。本次变更说明如下： 增加了下载工作项附件。 增加了删除附件。 增加了查询当前工作项已经关联的代码提交记录 / 分支创建记录。 2022-11-04 第二十一次正式发布。本次变更说明如下： 增加响应示例和请求示例。 2022-10-28 第二十次正式发布。本次变更说明如下： 增加了下载图片。 增加了上传工作项附件。 增加了Scrum项目的领域。 2022-09-16 第十九次正式发布。本次变更说明如下： 修改了API概览。 修改了终端节点。 NewCustomField中增加了字段“field_name”。 2022-08-23 第十八次正式发布。本次变更说明如下： 修改了API概览。 增加了Scrum项目的模块。 2022-06-30 第十七次正式发布。本次变更说明如下： 增加了查询项目的工作项。 增加了查询项目下所有工作项的历史记录。 增加了查询Scrum项目的工作项流转配置。 增加了查询当前工作项已经关联的工作项。 增加了查询当前工作项已经关联的关联Wiki。 增加了查询当前工作项已经关联的代码提交记录 / 分支创建记录。 增加了查询关联用例。 增加了查询Scrum工作项自定义字段。 增加了查询看板项目下工作项的状态历史记录。 增加了查询看板项目下的工作项。 增加了查询看板项目的工作项流转配置。 修改了创建工作项。 2022-06-06 第十六次正式发布。本次变更说明如下： 增加了查看迭代历史记录。 增加了更新子用户昵称。 修改了高级查询工作项。 修改了获取指定项目的迭代列表。 2022-02-28 第十五次正式发布。本次变更说明如下： 修改了高级查询工作项。 修改查询缺陷密度。 2021-11-26 第十四次正式发布。本次变更说明如下： 增加了细粒度权限用户创建工作项。 修改了错误码。 2021-11-10 第十三次正式发布。本次变更说明如下： 修改了API字段信息。 迭代详情和迭代列表添加了返回字段status。 获取工作项的历史记录添加了id和name。 2021-09-28 第十二次正式发布。本次变更说明如下： 修改了错误码。 2021-06-11 第十一次正式发布。本次变更说明如下： 修改了错误码。 2021-05-12 第十次正式发布。本次变更说明如下： 修改了错误码。 2021-05-08 第九次正式发布。本次变更说明如下： 修改了接口字段信息。 2021-04-22 第八次正式发布。本次变更说明如下： 删除约束与限制。 2021-03-26 第七次正式发布。本次变更说明如下： 修改API概览。 2021-03-10 第六次正式发布。本次变更说明如下： 修改应用示例。 2021-02-05 第五次正式发布。本次变更说明如下： 增加应用示例。 2020-08-31 第四次正式发布。本次变更说明如下： 修改“4.1 API”。 2020-08-18 第三次正式发布。本次变更说明如下： 修改基本概念。 修改构造请求。 修改认证鉴权。 2020-08-06 第二次正式发布。本次变更说明如下： 修改终端节点。 2020-07-01 第一次正式发布。 2020-03-30

请求示例 评审同意 https://{endpoint}/v1/ipdprojectservice/projects/b248a70bc6434e6bad54c8e73a222dca/review/1073568012549795840 { "category" : "CR", "old_status" : { "code" : "ToBeReviewed" }, "status" : { "code" : "ToBeReviewed" }, "cos" : [ { "id" : "1073568002185670656", "review_comments" : [ { "result" : "Approved", "comment" : "评审同意" } ] } ] } 评审拒绝 https://{endpoint}/v1/ipdprojectservice/projects/b248a70bc6434e6bad54c8e73a222dca/review/1073568012549795840 { "category" : "CR", "old_status" : { "code" : "ToBeReviewed" }, "status" : { "code" : "ToBeReviewed" }, "cos" : [ { "id" : "1073568002185670656", "review_comments" : [ { "result" : "Rejected", "comment" : "评审拒绝" } ] } ] } 评审转他人 https://{endpoint}/v1/ipdprojectservice/projects/b248a70bc6434e6bad54c8e73a222dca/review/1073568012549795840 { "category" : "CR", "old_status" : { "code" : "ToBeReviewed" }, "status" : { "code" : "ToBeReviewed" }, "cos" : [ { "id" : "1073568002185670656", "review_comments" : [ { "other_user_id" : "09d25f5d3f80d2881fd7c008ecf1622b" } ] } ] } 决策同意 https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/review/1029697355810648065 { "category" : "CR", "old_status" : { "code" : "ToBeApproved" }, "status" : { "code" : "ToBeApproved" }, "cos" : [ { "id" : "1073343385248509953", "approval_comments" : [ { "result" : "Approved", "comment" : "决策同意" } ] } ] } 决策拒绝 https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/review/1029697355810648065 { "category" : "CR", "old_status" : { "code" : "ToBeApproved" }, "status" : { "code" : "ToBeApproved" }, "cos" : [ { "id" : "1073344323946328065", "approval_comments" : [ { "result" : "Rejected", "comment" : "决策拒绝" } ] } ] } 决策转他人 https://{endpoint}/v1/ipdprojectservice/projects/b54914d464d1498a97d683ef198ec448/review/1029697355810648065 { "category" : "CR", "old_status" : { "code" : "ToBeApproved" }, "status" : { "code" : "ToBeApproved" }, "cos" : [ { "id" : "1073344323946328065", "approval_comments" : [ { "other_user_id" : "09d25f5d3f80d2881fd7c008ecf1622b" } ] } ] }

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 status String 请求状态 message String 请求错误信息 result ReviewEntity object 评审详情 表7 ReviewEntity 参数 参数类型 描述 id String 评审单id number String 评审单编号 state String 评审单工作状态，取值为"正在工作","作废" title String 评审单标题 category String 评审单类别，CR:变更评审，BR:基线评审,GR:通用评审 created_by UserEntity object 评审单创建人 modified_by UserEntity object 评审单最后修改人 assigned_cc Array of UserEntity objects 评审单抄送人 created_time String 评审单创建时间戳 modified_time String 评审单最后修改时间戳 plan_end_date String 计划完成日期时间戳，不可早于计划开始日期 plan_start_date String 计划开始日期时间戳，不可晚于计划完成日期 close_time String 评审单完成时间 need_approval String 评审单是否需要审批人审批，可选值为yes,no status StatusEntity object 评审单状态 description String 评审单描述，列表接口不返回描述信息 closed_time String 评审单完成时间 approver String 审批人id reviewer String 评审人id，逗号分隔 cos Array of COEntity objects 评审对象列表 ccbs Array of CcbEntity objects 审批信息列表 old_status StatusEntity object 评审单状态（更新时使用） cc Array of UserEntity objects 抄送人列表 表8 COEntity 参数 参数类型 描述 after_change String 变更对象修改后内容 review_complete_time String 变更对象评审完成时间 review_phase_result String 变更对象评审阶段结果 Approved：通过 Rejected：拒绝(CR) TurnBacked：驳回(BR/GR) review_time String 变更对象评审时间 before_change String 变更对象工作项修改前内容 category String 变更对象工作项类型，此处固定为CO ccb_info CcbEntity object 变更对象实际审批人信息 ccbs Array of UserEntity objects 变更对象审批人列表，兼容旧版评审。现版本审批人只有一人 change_type String 变更类型，基线评审的修改类型属于Modify Modify：修改 Move：迁移 Delete：删除 co2review String 变更对象关联的评审单Id created_by String 变更对象的创建人ID created_date String 变更对象创建时间 description String 变更对象描述信息 id String 变更对象Id issue_id String 变更对象关联的工作项Id issue_number String 变更对象关联的工作项编号 issue_category String 变更对象关联的工作项类型 modified_by String 变更对象最后修改人Id modified_date String 变更对象最后修改时间 opinions Array of UserEntity objects 变更对象评审专家Id列表（创建变更评审时使用） opinion_comments Array of ReviewOpinionEntity objects 变更对象评审意见 review_comments Array of ReviewCommentEntity objects 变更对象评审意见（评审更新时使用） approval_comments Array of ReviewCommentEntity objects 变更对象决策意见（决策更新时使用） reviewer Array of strings 变更对象评审专家Id列表 approver Array of strings 变更对象审批人ID数组 status String 变更对象状态 表9 CcbEntity 参数 参数类型 描述 approval_time String 审批时间 category String 工作项类型，审批对象固定为CCB ccb2review String 审批对象关联的评审单Id co_id String 关联的变更对象Id id String 审批对象Id owner UserEntity object 审批人 approval_comments String 审批意见 表10 ReviewOpinionEntity 参数 参数类型 描述 category String 评审意见对象类型，固定为Opinion co_id String 评审意见对象关联的变更对象Id created_by UserEntity object 评审意见创建人，即评审人 created_date String 评审意见创建时间 curr_owner UserEntity object 当前评审人 id String 评审意见对象Id modified_date String 评审意见最后修改时间 review_comments String 评审意见 表11 ReviewCommentEntity 参数 参数类型 描述 id String 评审意见对象Id user_id String 评审用户Id other_user_id String 其他用户Id result String 评审结果 comment String 评审意见 表12 UserEntity 参数 参数类型 描述 id String 用户Id name String 用户名称 nick_name String 用户昵称 表13 StatusEntity 参数 参数类型 描述 id String 状态id belonging String 工作项的状态属性，START、IN_PROGRESS、END display_value String 状态名 code String 状态唯一标识 created_by String 状态创建人 created_time String 状态创建时间 modified_by String 状态修改人 modified_time String 状态最近修改时间 category_code Array of strings 状态被哪些工作项使用 状态码：400 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI PUT /v1/ipdprojectservice/projects/{project_id}/review/{id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释：项目的32位uuid，项目唯一标识，可以通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制：正则表达式，^[A-Za-z0-9]{32}$ 默认取值：不涉及 id 是 String 评审单Id

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 评审单类别，只支持CR old_status 是 ReviewStatusEntity object 评审单更新前状态，取评审单详情接口返回的status的code字段 status 是 ReviewStatusEntity object 评审单更新后状态，取评审单详情接口返回的status的code字段 cos 是 Array of COUpdateEntity objects 评审对象列表 表3 ReviewStatusEntity 参数 是否必选 参数类型 描述 code 是 String 状态唯一标识，可选值为ToBeReviewed，ToBeApproved ToBeReviewed：待评审 ToBeApproved：待决策 表4 COUpdateEntity 参数 是否必选 参数类型 描述 id 是 String 变更对象Id review_comments 否 Array of ReviewCommentUpdateEntity objects 变更对象评审更新实体数组，评审时必填 approval_comments 否 Array of ReviewCommentUpdateEntity objects 变更对象决策更新实体数组，决策时必填 表5 ReviewCommentUpdateEntity 参数 是否必选 参数类型 描述 result 否 String 评审结果，评审时必填 Approved：评审/决策通过 Rejected：评审/决策拒绝 comment 否 String 评审意见，评审时必填 other_user_id 否 String 其他用户Id，转他人时必填

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 status String 请求状态 message String 请求错误信息 result ReviewEntity object 评审详情 表7 ReviewEntity 参数 参数类型 描述 id String 评审单id number String 评审单编号 state String 评审单工作状态，取值为"正在工作","作废" title String 评审单标题 category String 评审单类别，CR:变更评审，BR:基线评审,GR:通用评审 created_by UserEntity object 评审单创建人 modified_by UserEntity object 评审单最后修改人 assigned_cc Array of UserEntity objects 评审单抄送人 created_time String 评审单创建时间戳 modified_time String 评审单最后修改时间戳 plan_end_date String 计划完成日期时间戳，不可早于计划开始日期 plan_start_date String 计划开始日期时间戳，不可晚于计划完成日期 close_time String 评审单完成时间 need_approval String 评审单是否需要审批人审批，可选值为yes,no status StatusEntity object 评审单状态 description String 评审单描述，列表接口不返回描述信息 closed_time String 评审单完成时间 approver String 审批人id reviewer String 评审人id，逗号分隔 cos Array of COEntity objects 评审对象列表 ccbs Array of CcbEntity objects 审批信息列表 old_status StatusEntity object 评审单状态（更新时使用） cc Array of UserEntity objects 抄送人列表 表8 COEntity 参数 参数类型 描述 after_change String 变更对象修改后内容 review_complete_time String 变更对象评审完成时间 review_phase_result String 变更对象评审阶段结果 Approved：通过 Rejected：拒绝(CR) TurnBacked：驳回(BR/GR) review_time String 变更对象评审时间 before_change String 变更对象工作项修改前内容 category String 变更对象工作项类型，此处固定为CO ccb_info CcbEntity object 变更对象实际审批人信息 ccbs Array of UserEntity objects 变更对象审批人列表，兼容旧版评审。现版本审批人只有一人 change_type String 变更类型，基线评审的修改类型属于Modify Modify：修改 Move：迁移 Delete：删除 co2review String 变更对象关联的评审单Id created_by String 变更对象的创建人ID created_date String 变更对象创建时间 description String 变更对象描述信息 id String 变更对象Id issue_id String 变更对象关联的工作项Id issue_number String 变更对象关联的工作项编号 issue_category String 变更对象关联的工作项类型 modified_by String 变更对象最后修改人Id modified_date String 变更对象最后修改时间 opinions Array of UserEntity objects 变更对象评审专家Id列表（创建变更评审时使用） opinion_comments Array of ReviewOpinionEntity objects 变更对象评审意见 review_comments Array of ReviewCommentEntity objects 变更对象评审意见（评审更新时使用） approval_comments Array of ReviewCommentEntity objects 变更对象决策意见（决策更新时使用） reviewer Array of strings 变更对象评审专家Id列表 approver Array of strings 变更对象审批人ID数组 status String 变更对象状态 表9 CcbEntity 参数 参数类型 描述 approval_time String 审批时间 category String 工作项类型，审批对象固定为CCB ccb2review String 审批对象关联的评审单Id co_id String 关联的变更对象Id id String 审批对象Id owner UserEntity object 审批人 approval_comments String 审批意见 表10 ReviewOpinionEntity 参数 参数类型 描述 category String 评审意见对象类型，固定为Opinion co_id String 评审意见对象关联的变更对象Id created_by UserEntity object 评审意见创建人，即评审人 created_date String 评审意见创建时间 curr_owner UserEntity object 当前评审人 id String 评审意见对象Id modified_date String 评审意见最后修改时间 review_comments String 评审意见 表11 ReviewCommentEntity 参数 参数类型 描述 id String 评审意见对象Id user_id String 评审用户Id other_user_id String 其他用户Id result String 评审结果 comment String 评审意见 表12 UserEntity 参数 参数类型 描述 id String 用户Id name String 用户名称 nick_name String 用户昵称 表13 StatusEntity 参数 参数类型 描述 id String 状态id belonging String 工作项的状态属性，START、IN_PROGRESS、END display_value String 状态名 code String 状态唯一标识 created_by String 状态创建人 created_time String 状态创建时间 modified_by String 状态修改人 modified_time String 状态最近修改时间 category_code Array of strings 状态被哪些工作项使用 状态码：400 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI POST /v1/ipdprojectservice/projects/{project_id}/review 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释：项目的32位uuid，项目唯一标识，可以通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制：正则表达式，^[A-Za-z0-9]{32}$ 默认取值：不涉及

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 评审单类别，只支持CR title 是 String 评审单标题 description 否 String 评审单描述，列表接口不返回描述信息 need_approval 是 Boolean 评审单是否需要审批人审批，可选值:true status 是 ReviewStatusEntity object 评审单状态，可选值:ToBeReviewed cc 否 Array of ReviewCreateUserEntity objects 抄送人列表 cos 是 Array of COCreateEntity objects 评审对象列表 plan_end_date 否 String 计划完成日期时间戳，不可早于计划开始日期 plan_start_date 否 String 计划开始日期时间戳，不可晚于计划完成日期 表3 ReviewStatusEntity 参数 是否必选 参数类型 描述 code 是 String 状态唯一标识，可选值为ToBeReviewed，ToBeApproved ToBeReviewed：待评审 ToBeApproved：待决策 表4 ReviewCreateUserEntity 参数 是否必选 参数类型 描述 id 是 String 用户Id 表5 COCreateEntity 参数 是否必选 参数类型 描述 issue_id 是 String 变更对象关联的工作项Id issue_number 是 String 变更对象关联的工作项编号 issue_category 是 String 变更对象工作项类型，值范围:RR/SF/IR/Bug change_type 是 String 变更类型： Modify：修改 Delete：删除 before_change 是 String 变更对象修改前内容 after_change 是 String 变更对象修改后内容，格式为json，必须包含execute节点，且execute为平铺的key:value格式 reviewer 是 Array of strings 变更对象评审专家Id列表 approver 是 Array of strings 变更对象审批人ID数组 description 否 String 变更对象描述信息

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 PM.02150010 目标用户非项目空间成员 目标用户非项目空间成员 将需要的用户先添加到项目空间 400 PM.02150301 删除失败 删除失败 将是这个角色的用户先修改成其他的角色，再删除 400 PM.02150302 所设置权限不可变更 所设置权限不可变更 所设置权限不可变更 400 PM.02150303 角色不存在 角色不存在 核实请求参数 400 PM.02150304 角色名不可用，请设置新名称 角色名不可用，请设置新名称 请设置新名称 400 PM.02150305 角色名冲突 角色名冲突 请设置新名称 400 PM.02150404 项目空间不存在 项目空间不存在 项目空间不存在 400 PM.02151001 项目集不存在 项目集不存在 项目集不存在 400 PM.02152001 参数错误 参数错误 参数错误 400 PM.02152002 未定义错误 未定义错误 未定义错误 400 PM.02152003 传入参数名非法 传入参数名非法 传入参数名非法 400 PM.02152004 项目集未归档 项目集未归档 项目集未归档 400 PM.02152005 项目不存在或项目已被删除 项目不存在或项目已被删除 项目不存在或项目已被删除 400 PM.02152006 该项目集还没有被关注 该项目集还没有被关注 该项目集还没有被关注 400 PM.02152007 已关注该项目集 已关注该项目集 已关注该项目集 400 PM.02152008 修改创建项目集权限的参数含有非法用户 修改创建项目集权限的参数含有非法用户 修改创建项目集权限的参数含有非法用户 400 PM.02152009 项目集已归档 项目集已归档 项目集已归档 400 PM.02152010 项目类型不被允许 项目类型不被允许 项目类型不被允许 400 PM.02152011 项目已被关联 项目已被关联 项目已被关联 400 PM.02153001 访问频率过高，请稍后再试 访问频率过高，请稍后再试 访问频率过高，请稍后再试 400 PM.02175006 CN: 参数错误: {0}; EN: Invalid Parameter: {0} 参数错误 使用正确的请求参数重试 400 PM.02175101 CN: 子节点数量超过限制：{0}; Number of sub items exceeds [{0}] 子节点数量不能超过限制 删除其他子节点后再创建，或者在其他父节点下创建 400 PM.02175103 CN: 无法修改未被接纳或已拒绝的IR; EN: Only accepted initial requirement can be edited 当前IR无法被修改（只有当提出项目空间与归属项目空间相同，或者在归属项目空间被接纳的IR才能被修改。修改IR或者在父IR下创建子项时可能发生此错误） 确认修改的IR的状态后重试 400 PM.02175104 CN: 所选IR无法操作; EN: Some of the initial requirements can not be edited 部分IR无法修改（通常是因为部分请求的IR不存在） 确认所有修改的IR都存在后重试 400 PM.02175105 CN: 无效的父IR; EN: Invalid parent. 无效的父IR（此错误发生于批量创建子IR时，父IR不一致，或者父IR的归属项目空间与子IR的提出项目空间不一致，或者指定的父IR类型不正确） 使用正确的请求参数重试 400 PM.02175106 CN: 子IR必须提给其他项目空间; EN: Can not create sub ir to current program. 子IR的提出项目空间与归属项目空间不能相同 将子IR提给其他项目空间 400 PM.02175111 CN: 当前IR下有子IR，不能删除; EN: Child IR exist, can not delete. 不能删除具有子IR的父IR 删除所有子IR后再删除父IR 400 PM.02175113 CN: 父IR不存在; EN: Parent IR not exists. 父IR不存在 在正确的父IR下创建子IR 400 PM.02175114 CN: 父IR不归属于当前项目空间，请到父IR的归属项目空间进行操作; EN: Parent IR not designated in current program, please perform in the destination program of this IR. 父IR不归属于当前项目空间 到父IR的归属项目空间中重试 400 PM.02175115 CN: 不能删除IR：不具有所有子工作项所在项目的编辑权限; EN: Missing edit permission of sub items. 不能删除IR，因为不具有所有子工作项所在项目的编辑权限 申请子工作项所在项目的编辑权限后重试 400 PM.02175200 CN: 缺少必填字段 [{0}]; EN: Missing required field [{0}] 缺少必填字段 添加必填字段后重试 400 PM.02175201 CN: 字段 [{0}] 的值不正确{1}; EN: Field [{0}] has invalid value{1} IR字段的值不正确（无具体原因时，通常是格式错误，比如时间/日期字段使用了非时间戳字符串） 使用正确的值进行请求 400 PM.02175202 CN: 预计开始日期不能晚于预计结束日期; EN: Plan start date can not be later than plan due date. 预计开始日期不能晚于预计结束日期 使用正确的预计开始日期/预计结束日期参数 400 PM.10001002 不合法的token 不合法的token 不合法的token 400 PM.10002006 当前租户下名称已被使用 当前租户下名称已被使用 当前租户下名称已被使用 400 PM.10002010 描述不超过500个字符 描述不超过500个字符 描述不超过500个字符 400 PM.10002011 名称不规范 名称不规范 名称不规范 400 PM.10003002 当前用户权限不足 当前用户权限不足 当前用户权限不足 400 PM.10003003 邀请已过期 邀请已过期 邀请已过期 400 PM.10003004 审核信息不存在 审核信息不存在 审核信息不存在 400 PM.10003005 标签在使用中 标签在使用中 标签在使用中 400 PM.10003006 添加成员最多不超过100个 添加成员最多不超过100个 添加成员最多不超过100个 400 PM.10003007 最多可以添加100个项目 最多可以添加100个项目 最多可以添加100个项目 400 PM.10003008 角色不被允许 角色不被允许 角色不被允许 400 PM.10003009 创建者移交项目空间后可以退出项目 创建者移交项目空间后可以退出项目 创建者移交项目空间后可以退出项目 400 PM.10003010 成员已不存在 成员已不存在 成员已不存在 400 PM.10003011 租户下项目空间总数不能超过100个 租户下项目空间总数不能超过100个 租户下项目空间总数不能超过100个 400 PM.10003014 邀请不存在 邀请不存在 邀请不存在 400 PM.10003015 只能添加同租户下用户 只能添加同租户下用户 只能添加同租户下用户 400 PM.10003016 添加成员失败 添加成员失败 添加成员失败 401 PM.02150401 用户操作权限不足 用户操作权限不足 用户操作权限不足 403 PM.10003012 用户是项目空间成员，不需要申请 用户是项目空间成员，不需要申请 用户是项目空间成员，不需要申请 404 PM.02175005 CN: 当前请求资源不存在; EN: Requested resource not exist 查询的资源不存在 确认请求的资源是否存在（可能输入了错误的id，或资源已被删除） 405 PM.10003013 已存在加入项目空间的申请，等待管理员审批 已存在加入项目空间的申请，等待管理员审批 已存在加入项目空间的申请，等待管理员审批

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token获取请求认证接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxx为project的名称，如cn-north-1，您可以从终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token获取请求认证。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

请求URI 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 请求URI由四部分构成：{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 参数 说明 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从终端节点中获取。 例如 IAM 服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径，从具体API的URI模块获取。例如，获取用户Token接口的resource-path为/v3/auth/tokens。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个？，形式为参数名=参数取值。例如，limit=10表示查询不超过10条数据。 例如，您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token获取请求认证的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权。 X-Project-ID：子项目ID，可选，在多项目场景中使用。 X-Domain-ID：账号ID。 对于获取用户Token获取请求认证接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token获取请求认证的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

基本概念 账号 用户注册账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用它们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region。 通用Region指面向公共租户提供通用云服务的Region。 专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 用户在需求管理中创建的项目，根据模板创建项目，根据您选择的项目模板，还包含有预置的工作项、代码或资源等。通过管理项目IAM用户（即“团队成员”）所需的权限。将IAM用户作为团队成员添加到项目，给每个团队成员分配角色并赋予项目及其资源的操作权限。 项目模板 使用模板创建项目，模板项目是指默认预置模板类型的项目，即基于Scrum和看板形式，由需求管理预置好一些工作项和流程。选择项目模板后，会自动生成对应样例模板，供用户参考和使用，用户也可以新建自己的开发任务。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 父主题： 使用前必读

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 status String 状态 message String 失败信息 result Array of ProjectInfoVO objects 项目列表 表3 ProjectInfoVO 参数 参数类型 描述 id String 项目id name String 项目名称 project_type String 项目类型区分ipd/scrum/xboard domain_id String 项目所属域id model_id String IPD项目模型Id，取值为10001|10002|10003，分别表示系统设备类、自运营软件类、云服务类

响应示例 状态码： 200 成功响应 { "status" : "success", "message" : null, "result" : [ { "id" : "e44fbbd512b6470886b0f95663d4789a", "name" : "IPD-自运营软件/云服务类-0403-0", "project_type" : "ipd", "domain_id" : "982241044173205505", "model_id" : "10003" } ] }

URI DELETE /v1/planservice/projects/{project_id}/plans/batch-delete 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释：项目的32位uuid，项目唯一标识，可以通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID 约束限制：正则表达式，^[A-Za-z0-9]{32}$ 默认取值：不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String 参数解释：用户token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制：不涉及 取值范围：最小长度10，最大长度：32768 默认取值：不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 BatchDeletePlansRequestBody 是 Object 删除计划的请求体

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 result BatchResultVO object 批量删除返回结果 表5 BatchResultVO 参数 参数类型 描述 success_num Number 成功数量 fail_num Number 失败数量 success Array of BatchOperateInfo objects 成功的结果 failed Array of BatchOperateInfo objects 失败的结果 表6 BatchOperateInfo 参数 参数类型 描述 id String 发布/迭代计划的id modified_by String 更新者 状态码：400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

功能介绍 用户可以一键启动Landing Zone治理检测，扫描云上多账号环境是否符合Landing Zone治理最佳实践，获取风险评估结果并下载详细检测报告，检测范围支持以下八个领域： 组织与账号：采用合理的组织架构，基于账号实现职责分离，无游离的企业账号。 身份权限：精细化的权限分配与统一的身份管理，消减过度授权风险。 网络规划：公共网络资源集中管理，保障网络安全和高可用。 安全合规：相关数据介质正确加密，主机与数据落地安全保护。 合规审计：完整收集并设置日志的长期留存，保障审计的有效性。 数据边界：正确设置权限边界，预防非预期的访问操作。 财务治理：精细化的财务管理，无浪费或异常成本。 运维监控：基于最佳实践收集基础云服务指标，实时监控并及时通知。

操作步骤 以RGC管理员身份登录华为云，进入华为云RGC控制台。 进入Landing Zone设置页，选择“版本”页签。 选择需要更新的版本。 图1 选择版本 单击“更新版本”。 图2 更新Landing Zone 完成Landing Zone更新后，您将无法撤销更新或降级到先前的版本。 更新区域设置。可以选择除主区域之外还需要治理的区域。设置后，您可以在治理范围中添加区域。移除某个区域并不妨碍您在该区域部署资源，但这些资源将不在RGC的治理范围之内。 图3 更新区域设置 更新核心组织单元和账号。 更新管理账号： 开通IAM身份中心：RGC将在IAM身份中心创建RGC管理员，该IAM身份中心用户拥有管理员权限。若IAM身份中心已连接外部身份源，则RGC默认创建的IAM身份中心用户无法登录。 不开通IAM身份中心：如果不希望RGC在IAM身份中心创建RGC管理员身份的用户以及其他用户组、权限集等资源，则选择不开通IAM身份中心。 更新告警邮箱： 输入审计账号的告警邮箱，该邮箱用于接收RGC预置告警通知，请谨慎选择。告警邮箱地址不得与现有华为云账号使用的邮箱地址相同。长度范围为0至64个字符。 图4 更新核心组织单元和账号 单击“下一步”。 更新日志配置。 选择是否启用CTS： 如果您未在搭建Landing Zone页面启用CTS，则RGC将不会管理您的CTS操作审计日志。RGC强烈建议您启用CTS。预置强制控制策略将会检测已纳管的账号是否已启用CTS。 更新OBS日志配置： 创建OBS桶：需要配置日志在OBS桶中的保留时长。日志将会自动存放至系统创建的两个默认OBS桶中，不支持自定义OBS桶名。 日志汇聚桶数据保留时长：默认设置为1年。最长设置为15年。 该桶用于存储组织内所有账号的CTS记录的操作审计日志和已纳管账号的Config记录的资源快照，并且存放于名为“rgcservice-managed-audit-logs-{管理账号ID}”的桶中，{}中表示变量，根据实际情况进行显示。 OBS桶访问日志保留时长：默认设置为10年。最长设置为15年。 该桶将会存放访问上述日志汇聚桶而产生的日志，并且存放于名为“rgcservice-managed-access-logs-{管理账号ID}”的桶中，{}中表示变量，根据实际情况进行显示。 使用现有OBS桶：需要输入日志账号下的OBS桶名称，如使用其他OBS桶则将会导致Landing Zone搭建失败。为了您的数据安全，建议使用桶策略为私有的OBS桶。 图5 更新日志配置 单击“下一步”。 确认更新的设置信息无误，单击“确定”。RGC将会开始对Landing Zone进行更新。 更新成功后，RGC界面将会出现更新成功的提示。 如果更新失败，RGC不会退回到之前的Landing Zone版本，Landing Zone可能将会处于不确定的状态。如果出现该问题，请提交工单。

操作步骤 以RGC管理账号的身份登录华为云，进入华为云RGC控制台。 进入组织管理页，单击需要注册OU所在行“操作”列的“重新注册”。 图1 重新注册OU 确认子账号和OU上控制策略的信息。确认无误后，勾选“我了解重新注册组织单元的相关风险，并且我同意RGC服务将必要的角色和权限应用于我的组织单元和账号。”。 图2 确认OU信息 单击“重新注册”，重新注册OU需要等待一段时间。可以在组织结构中查看OU的重新注册结果。重新注册成功后，OU将会受到Landing Zone的监管。

支持审计的关键操作列表 表1 云审计服务支持的RGC操作列表 操作名称 资源类型 事件名称 搭建Landing Zone前检查 LandingZone checkLaunch 删除Landing Zone LandingZone deleteLandingZone 搭建Landing Zone LandingZone setupLandingZone 关闭控制策略 Control DisableGovernancePolicy 开启控制策略 Control EnableGovernancePolicy 创建账号 Account createAccount 纳管账号 Account enrollAccount 取消纳管账号 Account unEnrollAccount 更新被管理账号 Account updateManagedAccount 创建组织单元 OrganizationUnit createManagedOrganizationalUnit 删除组织单元 OrganizationUnit deleteManagedOrganizationalUnits 重新注册组织单元 OrganizationUnit reRegisterOrganizationalUnit 注册组织单元 OrganizationUnit registerOrganizationalUnit 取消注册组织单元 OrganizationUnit deregisterOrganizationalUnit 创建一个模板 Template createTemplate 删除一个模板 Template deleteTemplate 最佳实践检测 BestPractice bestPracticeDetect 最佳实践详情 BestPractice bestPracticeDetails

漂移概述 搭建Landing Zone时，账号、所有OU和资源都将符合控制策略管控下的管理规则。当您和组织成员使用Landing Zone时，由于可以同时从RGC和组织服务对组织和SCP进行操作，操作入口的不唯一就可能导致纳管资源的合规状态发生改变。当RGC纳管的资源不满足治理策略时，就会发生以下两类漂移现象： SCP： RGC为各个OU配置的SCP与在组织服务中内容不一致，或者SCP在组织服务中不存在。 组织结构 RGC监管的OU和账号与组织服务里的OU或账号存在不一致。 当存在不一致时，意味着当前Landing zone环境发生了不合规情况，可能会造成意外甚至严重的后果。 当前RGC已支持定期进行账号、OU和SCP的漂移检测，并使用告警提醒您存在漂移现象。检测漂移后，您可以通过更新、修复等操作消除漂移。 当核心OU或核心账号存在漂移时，RGC的创建账号功能将无法使用。

漂移检测概述 RGC会自动检测是否存在漂移现象。检测漂移将需要RG CS erviceExecutionAgency服务委托持续访问您的管理账号，RGC将会使用只读权限的API调用组织服务。调用API的操作将会记录在CTS事件中。 漂移现象的消息将汇总至 消息通知 服务（Simple Message Notification， SMN ）中。管理账号可以订阅SMN消息通知，以便在出现漂移现象时，接收漂移信息并及时修复漂移。在RGC中可以检测到的治理漂移类型如下： 组织架构漂移的类型 SCP被更新 SCP被删除 SCP关联至OU SCP关联至账号 SCP从OU解绑 SCP从账号解绑 账号漂移的类型 账号被移动到其他OU 账号被关闭 账号被移出组织 如果同一组资源多次出现相同类型的漂移，RGC将仅针对第一个出现漂移的资源发送SMN通知。 如果RGC检测到发生漂移的资源已得到修复，则仅当相同的资源再次出现漂移时，才会再次发送SMN通知。 例如： 如果您多次修改同一个SCP的策略内容，则仅在首次修改时会收到消息通知。 如果您通过修改SCP后修复了漂移，然后再次对其进行修改再次产生漂移，则您将会收到两条消息通知。

需要立即修复的漂移类型 当出现漂移现象时，您可以通过更新/修复等操作消除漂移，以确保Landing Zone处于合规的状态。漂移检测是系统自动进行的，但您需要在RGC控制台进行操作才可以修复漂移。 大多数类型的漂移可以由管理员解决，但有些类型的漂移则必须立即解决，包括删除RGC Landing zone所需的OU等。以下列举的是如何避免产生立即解决的漂移示例： 不要删除核心OU：不应在组织服务中删除RGC在搭建Landing Zone期间默认名为 “Security” 的核心OU。如果将其删除，则会出现漂移现象。您将会在RGC控制台看到一条错误消息，提示您立即更新/修复Landing Zone。在更新/修复完成之前，您将无法在RGC中执行任何其他操作。 不要删除核心账号：如果您从核心OU中删除核心账号，例如从核心OU中删除日志存档账号，则Landing Zone将处于漂移状态。您必须先更新/修复Landing Zone，然后才能继续使用RGC控制台。