华为云用户手册

使用AppCode调用API接口失败了怎么办？ 请参见APIG-为建议认证添加AppCode文档。 使用AppCode认证调试API商品接口的注意点: 先确认购买的API商品已经开启简易认证，如果不清楚是否开启，可咨询商家。 在云商店购买的API商品时，系统会为您在“API网关控制台-调用API-应用管理”自动创建应用 MARKETPLACE_APP。您需要在该应用下手动添加AppCode，无需手动绑定API，系统已默认为您绑定。 当前，您也可以手动创建新的应用，在新应用下添加AppCode，并绑定API。 请注意，由用户自主创建的应用需要手动绑定API，才能正常使用该应用下的AppCode。 如果您在“API网关控制台-调用API-已购买API”没有找到您购买的API商品，不要着急，请先确认您选择的区域是否正确，如果不确定你购买的API商品所属的区域，请联系商家咨询。 如果以上操作都已经尝试，在header添加“X-Apig-AppCode：XXX”调用接口仍然失败的话，请确保您使用了https协议。

为什么订单有效期时间和实际交付的不一致 涉及服务监管的包周期商品，商家若未在实施服务完成时填写服务实际开通时间，则该订单将以客户线上点击确认验收的时间为订单有效期开始时间；商家若在实施服务完成时填写了服务实际开通时间，则订单闭环后将以商家填写的服务实际开通时间作为订单有效期开始时间。 举例：用户购买涉及服务监管商品A，于1月1日购买1个月并于同日开通完成，投入使用。2月1日用户在系统点击确认验收。 场景一：商家实施服务完成时未填写服务实际开通时间 用户实际的使用周期为1月1日到2月1日，云商店订单系统显示有效期则为2月1日至3月1日。 场景二：商家实施服务完成时填写了服务实际开通时间，填写的时间为1月1日 用户实际的使用周期为1月1日到2月1日，云商店订单系统显示有效期则为1月1日至2月1日。 如商家填写了服务实际开通时间，请用户在确认验收节点检查商家填写的服务实际开通时间是否与实际开通一致。 如商家未填写服务实际开通时间，用户可驳回商家的确认订单请求。如用户已确认订单，当有相关争议时，以实际使用日期为准。 父主题： 交付与售后

云商店提供哪些软件和服务 云商店销售的商品是由“华为云服务”和“合作伙伴”通过合作在华为云云商店平台发布的镜像类商品、人工服务类商品、SaaS类商品、API类商品、License类商品、硬件类商品、AI资产类商品、数据资产、应用资产类商品等，包括但不限于： 操作系统、数据库与缓存、应用运行环境、管理与监控、开发语言环境等基础软件商品。 建站系统、电子商务、建站模板、APP定制、小程序建站等网站建设商品。 人力资源、商业智能、协同办公、销售管理、财务管理、存储与备份等企业应用商品。 数据迁移、环境配置、故障排查、咨询与培训、专线接入、代维服务等专业服务商品。 监控工具、源代码控制、问题和缺陷跟踪、 日志分析 、测试工具等 开发者工具 商品。 主机安全、应用安全、数据安全、网络安全、安全管理、安全服务等安全市场商品。 泛金融、智能制造、医疗、教育、电商、游戏、物流云、售电云、交通、政府类、智能环保等解决方案商品。 智慧城市、车联网、智能家居、模组开发等物联网商品。 视频与通信、企业服务、人工智能、生活服务等API商品。 用户可以在此找到适合自己业务的软件和服务。 父主题： 关于云商店

华为云云商店是什么 华为云云商店是一个在线商店。华为与商家合作，提供从应用、运行环境、带宽以及云主机资源的一站式应用商品，用户可以在云商店快速购买到合适的应用商品（包括运行的全套环境），然后立即开始使用应用软件和服务来发布商品和运行自己的业务。 华为云云商店在云服务的生态系统中，整合了上游的应用服务，与合作伙伴一起为用户提供更优质和便捷的应用解决方案，从而促使行业生态链健康成长。 对应用商品有需求的用户在云商店通过一键开通的简单操作，就能获得一套云主机资源和已经部署好的应用软件。系统会自动启动预配置的软件，您只需要聚焦自己的业务，无需在资源采购、软件部署等方面浪费时间、精力和成本，您只需按您的需要支付相应的费用，您可以选择按小时、按月或按年付费，非常节约开支。 对应用服务有需求的客户，可以在云商店搜索所需服务，联系商家咨询服务具体内容，不需要单独购买软件应用，只需下单后由商家直接提供专业服务。 父主题： 关于云商店

售后支持 通用商品的售后支持 通用商品的交付和售后支持由商家对客户直接提供。客户购买通用商品后，如需售后支持，请在该商品详情页查找商家联系方式，联系商家提供技术支撑。如商家提供的联系方式无法接通或无回复，可通过联系华为云4000-955-988或950808按1转3或发邮件至partner@huaweicloud.com，由云商店运营经理协助联系。 联营商品的售后支持 联营商品由华为云销售团队或华为云经销商伙伴提供售前咨询相关服务。客户购买联营商品后，如需售后支持，请在该商品详情页查找商家联系方式，联系商家提供技术支撑。如商家提供的联系方式无法接通或无回复，可通过联系华为云4000-955-988或950808按1转3或发邮件至partner@huaweicloud.com，由云商店运营经理协助联系 华为商品的售后支持 华为商品由华为云销售团队或华为云经销商伙伴提供售前咨询相关服务。客户购买华为商品后，由华为云按照订单中约定的范围，为客户提供售后支持服务。 父主题： 售后服务

操作步骤 登录华为云云商店主页。 选择商品。 在页面顶端搜索栏搜索您需要的商品。 选择云商店商品分类，进入分类页面通过筛选条件选择您需要的商品。 进入推荐应用或推荐商品模块选择您需要的商品。 点击具体商品名称，进入商品详情页面。 查看商品信息、设置服务选型后，点击“立即购买”。 镜像类应用 若购买页面无可用的虚拟私有云，请点击“创建虚拟私有云”，按照界面提示创建虚拟私有云后再进行购买。 镜像类应用包含镜像费用和云服务器费用。 请记住在订单确认页面设置的云主机登录账号和密码。 开通了企业项目功能的企业账号在购买云商店镜像类商品时，可下拉并选择对应的企业项目。如未开通企业项目功能，则不显示该参数。 SaaS类应用 若购买页面显示“授权将当前账号下的联系方式（xxx）用于创建应用管理账号，便于商品的开通与使用”，则必须选择才能购买。“xxx”为当前账号的手机号码、邮箱或 IAM 用户名。 若需购买按需套餐包，则必须先开通按需服务。 核对订单详情，勾选“协议及授权”，点击“去支付”。 如该商品有优惠折扣，支付页面会显示【折扣】栏，下拉选择对应的折扣后再进行支付。 通用商品、联营商品、华为商品在订单页面需勾选的用户协议不同。 图1 通用商品订单页面 图2 联营商品订单页面 图3 华为商品订单页面 确认付款并支付订单，付款成功即完成商品购买流程。 用户可以在云商店快速购买人工服务、硬件、SaaS或License类商品。支付成功后，需要进入“服务监管”页面提交需求，并及时跟踪订单服务的进度。 服务监管操作指导，请参见人工服务类商品服务监管、SaaS类商品服务监管、License类商品服务监管、硬件类商品服务监管。

约束与限制 数据库安全服务不支持跨区域（Region）使用。待审计的数据库必须和购买的数据库安全审计实例在同一区域。 购买数据库安全审计实例配置VPC参数，必须与Agent安装节点（应用端或数据库端）所在的VPC保持一致。否则，将导致Agent与审计实例之间的网络不通，无法使用数据库安全审计。创建共享VPC请参见共享VPC。 数据库安全审计的Agent安装节点，请参见：如何选择数据库安全审计的Agent安装节点？。

前提条件 请参见DBSS权限管理确认实例账号具有相关权限。 请确认购买实例的账号具有“DBSS System Administrator”、“VPC Administrator”、“E CS Administrator”和“DBSS Administrator”角色。 VPC Administrator：对虚拟私有云的所有执行权限。项目级角色，在同项目中勾选。 DBSS Administrator：对账号中心、费用中心、资源中心中的所有菜单项执行任意操作。项目级角色，在同项目中勾选。 ECS Administrator：对弹性云服务器的所有执行权限。项目级角色，在同项目中勾选。

报表类型 数据库安全审计为用户提供了8种报表模板，各报表名称如表1所示。用户可根据实际业务情况生成报表、设置报表的执行任务。 表1 报表说明 报表模板名称 报表类型 说明 数据库安全综合报表 综合报表 提供数据库整体审计状况，主要从风险分布、会话分布和登录状况等几个维度进行审计分析，为数据库管理提供整体审计状况依据。 数据库安全合规报表 合规报表 根据《中国国家信息安全保护检验标准》和国家等级保护的检测要求对数据库进行数据统计。帮助数据库管理人员、审计人员及时发现各种异常行为和违规操作，并为快速定位分析、整体信息管理提供决策依据。 SOX-萨班斯报表 合规报表 参考《萨班斯法案》针对用户全面把控数据库内部活动的要求，对数据库进行数据统计。帮助数据库管理人员、 审计人员及时发现各种异常行为和违规操作，并为快速定位分析、整体信息管理提供决策依据。 数据库服务器分析报表 数据库专项报表 分别为数据库活动用户统计、访问数据库来源IP数量统计、数据库登录及请求统计分析和使用数据库操作时间判断数据库服务器性能。 客户端IP分析报表 客户端专项报表 统计源IP中客户端应用程序、数据库用户数量和SQL语句数量。 DML命令报表 数据库操作专项报表 通过DML命令分析用户与特权操作。 DDL命令报表 数据库操作专项报表 通过DDL命令分析用户与特权操作。 DCL命令报表 数据库操作专项报表 通过DCL命令分析用户与特权操作。

常见场景 请您根据数据库类型以及数据库部署场景，为待审计的数据库添加Agent。数据库常见的部署场景说明如下： ECS/BMS自建数据库的常见部署场景如图1和图2所示。 图1 一个应用端连接多个ECS/BMS自建数据库 图2 多个应用端连接同一个ECS/BMS自建数据库 RDS关系型数据库的常见部署场景如图3和图4所示。 图3 一个应用端连接多个RDS 图4 多个应用端连接同一个RDS 添加Agent方式的详细说明如表1所示。 当您的应用端和数据库（ECS/BMS自建数据库）都部署在同一个节点上时，Agent需在数据库端添加。 数据库安全审计还支持批量部署流量采集Agent，针对大规模业务场景（容器化部署应用、数据库（RDS关系型数据库）数量大），能够显著提升产品配置的效率，降低配置的复杂度，减少运维人员的日常维护压力。详细操作步骤，请参见容器化部署数据库安全审计Agent。 表1 添加Agent方式说明 使用场景 Agent安装节点 审计功能说明 注意事项 ECS/BMS自建数据库 数据库端或应用端 可以审计所有访问该数据库的应用端的所有访问记录。 在数据库端添加Agent。 当某个应用端连接多个ECS/BMS自建数据库时，所有连接该应用端的数据库都需要添加Agent。 RDS关系型数据库 应用端 （应用端部署在云上） 可以审计该应用端与其连接的所有数据库的访问记录。 在应用端添加Agent。 当某个应用端连接多个RDS关系型数据库时，所有连接该应用端的RDS关系型数据库都需要添加Agent。当其中一个RDS关系型数据库选择“创建Agent”后，其余RDS关系型数据库添加Agent时，只能选择“选择已有Agent”添加方式。详细操作请参见•“添加方式”选择“选择已有Agent”。 当多个应用端连接同一个RDS关系型数据库时，所有连接该RDS关系型数据库的应用端都需要添加Agent。 代理端（应用端部署在云下） 只能审计代理端与后端数据库之间的访问记录，无法审计应用端与后端数据库的访问记录。 在应用端添加Agent。 “安装节点IP”需要配置为代理端的IP地址。

监控指标 表1 数据库安全服务支持的监控指标 指标ID 指标名称 指标含义 取值范围 单位 进制 测量对象 监控周期（原始指标） cpu_util CPU使用率 该指标用于统计测量对象的CPU利用率。 单位：百分比 采集方式：100%减去空闲CPU占比 0～100 % 值类型：Float % 不涉及 数据库审计实例 1分钟 mem_util 内存使用率 该指标用于统计测量对象的内存利用率。 单位：百分比 采集方式：100%减去空闲内存占比 0～100 % 值类型：Float % 不涉及 数据库审计实例 1分钟 disk_util 磁盘使用率 该指标用于统计测量对象的磁盘利用率。 单位：百分比 采集方式：100%减去空闲磁盘占比 0～100 % 值类型：Float % 不涉及 数据库审计实例 1分钟 hx_process_status 防护实例进程状态 该指标用于展示防护实例的进程状态。 说明： 该防护实例已不再维护。 0/1 0：进程状态异常 1：进程状态正常 不涉及 不涉及 数据库审计实例 1分钟 hx_port_stats 防护实例端口状态 该指标用于展示防护实例的端口状态。 说明： 该防护实例已不再维护。 0/1 0：端口状态异常 1：端口状态正常 不涉及 不涉及 数据库审计实例 1分钟 hx_proxy_num 防护实例代理数量 该指标用于展示防护实例的代理数量。 说明： 该防护实例已不再维护。 ≥0 Count 不涉及 数据库审计实例 1分钟 hx_proxy_status 防护实例代理状态 该指标用于展示防护实例的代理状态。 说明： 该防护实例已不再维护。 0/1 0：代理状态异常 1：代理状态正常 不涉及 不涉及 数据库审计实例 1分钟 hx_qps 防护实例每秒查询数 该指标用于展示防护实例的每秒查询数。 说明： 该防护实例已不再维护。 ≥0 Count/s 不涉及 数据库审计实例 1分钟 hx_rps 防护实例每秒请求数 该指标用于展示防护实例的每秒请求数。 说明： 该防护实例已不再维护。 ≥0 Count/s 不涉及 数据库审计实例 1分钟 hx_active_connections_num 防护实例活跃连接数 该指标用于展示防护实例的活跃连接数。 说明： 该防护实例已不再维护。 ≥0 Count 不涉及 数据库审计实例 1分钟

安装Agent 请参见步骤二添加Agent。 在Windows主机安装“Npcap”软件。 如果该Windows主机已安装“Npcap”，请执行4。 如果该Windows主机未安装“Npcap”，请执行以下步骤： 请先下载Npcap获取最新软件安装包。 图5 下载npcap 将下载好的npcap-xxxx.exe软件安装包上传至需要安装agent的虚拟机。 双击npcap软件安装包。 在弹出的对话框中，单击“I Agree”，如图6所示。 图6 同意安装“Npcap” 在弹出的对话框中，单击“Install”，不勾选安装选项，如图7所示。 图7 安装“Npcap” 在弹出的对话框中，单击“Next”。 单击“Finish”，完成安装。 请参见下载Agent获取Windows操作系统Agent安装包。 以“Administrator”用户登录到Windows主机，将下载的Agent安装包“xxx.zip”复制到该主机任意一个目录下。 图8 Agent安装包 进入Agent安装包所在目录，并解压缩安装包。 进入解压后的文件夹，双击“install.bat”执行文件。 图9 双击install.bat 安装成功，界面如图10所示，按任意键结束安装。 图10 Agent安装成功 安装完成后，在Windows任务管理器中查看“dbss_audit_agent”进程，如下图图11所示。 图11 查看dbss_audit_agent进程 如果进程不存在，说明Agent安装失败，请尝试重新安装Agent。

常见安装场景 请您根据数据库的类型以及部署场景，在数据库端或应用端安装Agent。数据库常见的部署场景说明如下： ECS/BMS自建数据库的常见部署场景如图1和图2所示。 图1 一个应用端连接多个ECS/BMS自建数据库 图2 多个应用端连接同一个ECS/BMS自建数据库 RDS关系型数据库的常见部署场景如图3和图4所示。 图3 一个应用端连接多个RDS 图4 多个应用端连接同一个RDS 安装Agent节点的详细说明如表1所示。 当您的应用端和数据库（ECS/BMS自建数据库）都部署在同一个节点上时，Agent需在数据库端安装。 表1 安装Agent场景说明 使用场景 Agent安装节点 审计功能说明 注意事项 ECS/BMS自建数据库 数据库端 可以审计所有访问该数据库的应用端的所有访问记录。 在数据库端安装Agent。 当某个应用端连接多个ECS/BMS自建数据库时，需要在所有连接该应用端的数据库端安装Agent。 RDS关系型数据库 应用端（应用端部署在云上） 可以审计该应用端与其连接的所有数据库的访问记录。 在应用端安装Agent。 当多个应用端连接同一个RDS时，所有连接该RDS的应用端都需要安装Agent。 RDS关系型数据库 代理端（应用端部署在云下） 只能审计代理端与后端数据库之间的访问记录，无法审计应用端与后端数据库的访问记录。 在代理端安装Agent。

前提条件 请参见DBSS权限管理确认实例账号具有相关权限。 请确认购买实例的账号具有“DBSS System Administrator”、“VPC Administrator”、“ECS Administrator”和“DBSS Administrator”角色。 VPC Administrator：对虚拟私有云的所有执行权限。项目级角色，在同项目中勾选。 DBSS Administrator：对账号中心、费用中心、资源中心中的所有菜单项执行任意操作。项目级角色，在同项目中勾选。 ECS Administrator：对弹性云服务器的所有执行权限。项目级角色，在同项目中勾选。

与 消息通知 服务的关系 消息通知服务（Simple Message Notification，简称 SMN ），是一个可拓展的高性能消息处理服务。 开启消息通知前，您需先配置“消息通知服务”。 开启消息通知服务后，当数据库设置的告警事件发生或生成报表时，您可以收到告警或报表生成的消息通知。 在“告警通知”界面，您可以根据运维计划开启告警消息通知或关闭告警消息通知。 在“报表管理”界面，您可以根据运维计划开启报表生成消息通知或关闭报表生成消息通知。 关于SMN的详细内容，请参见《消息通知服务用户指南》。

与 云监控服务 的关系 云监控 服务（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在同一个区域也相同，所以简洁起见将这两部分省略。