华为云用户手册

请求方法：POST 接口URL：生产地址+固定子路径，其中固定子路径为/produceAPI/v2/allOrgSync； 接口示例：生产地址为https://example.isv.com，则接口URL为https://example.isv.com/produceAPI/v2/allOrgSync BODY请求参数 参数 必选 参数类型 描述 instanceId M String(64) 说明： 卖家申请应用凭证的时候传空，买家必传。 tenantId M String(64) 租户ID orgInfoList M OrgInfo[] 组织内部门层级信息，包含部门代码、部门名称、上级部门 请参考Orglnfo类型定义 testFlag M Integer(2) 0-生产正式数据1-调测数据 timeStamp M String 默认时区东8区，时间格式：20220420114117642 Orglnfo类型定义 参数 必选 参数类型 描述 orgCode M String(64) 部门代码 orgName M String(128) 部门名称 parentCode O String(64) 上级部门，顶级部门的上级部门为空 响应参数 参数 必选 参数类型 描述 resultCode M String(6) 响应码, 具体请参见调用结果码说明。 resultMsg O String(255) 响应信息 示例： 请求示例： POST https://example.isv.com/produceAPI/v2/allOrgSync Content-Type: application/json x-sign: 11C4CD6279191DE931DEF5C51531DFFA9D37969F4E356B8A3A6D8DE4FB357A48 x-timestamp: 1680508066618 x-nonce:50D83FDECAED6CCD8EF597F2A577950527928BA287D04E6036E92B2806FD17DA {"instanceId": "hua******t123456","tenantId": "68cbc8******b880d92f36422fa0e","orgInfoList": "[{orgCode:\"00000001\", orgName:\"产品部\"， parentCode:\"265789314\" },{orgCode:\"00000002\", orgName:\"测试部\"， parentCode:\"265789314\" }]","flag": 1,"testFlag": 0,"timeStamp": "20220413093539534"} 响应示例： HTTP/1.1 200 OK Content-Type: application/json { " resultCode": "000000", " resultMsg": "Success" }

资源和成本规划 表1 配置清单 产品名称 系统注册用户数 华为云配置详情 可用区 数量 价格 盖雅劳动力管理解决方案 最大支持5K人同时在线 弹性云服务器 E CS 1 【规格】通用计算增强型 | c6.large.2 | 2vCPUs | 4GB 【系统盘】高IO | 80GB 【数据盘】高IO | 80GB 【镜像】Windows | Windows Server 2019 数据中心版 64位英文 上海一 ，可用区一 2 5,124 弹性云服务器 ECS 2 【规格】通用计算增强型 | c6.large.2 | 2vCPUs | 4GB 【系统盘】高IO | 80GB 【数据盘】高IO | 80GB 【镜像】Windows | Windows Server 2019 数据中心版 64位英文 上海一 ，可用区一 1 2,562.10 RDS SQL Server | 2016标准版 | 主备 【规格】通用增强型 | 2核8GB(独享型) 【存储空间】超高IO | 200GB 上海一 ，可用区一 1 13,350.00 RDS MySQL | 5.7 | 主备 【规格】通用型 | 2核8GB 【存储空间】SSD云盘 | 200GB 上海一 ，可用区一 1 8,400.00 分布式缓存服务Redis 【规格】4.0 | 主备 | X86 | D RAM | 8 GB 上海一 ，可用区一 1 5,488.00 / / 共享型负载均衡 上海一 ，可用区一 1 1,500.00 / 弹性公网IP 【规格】独享 | 按带宽计费 | 10Mbit/s | 1个 上海一 ，可用区一 1 5,150.00 最大支持1W人同时在线 弹性云服务器 ECS 1 【规格】通用计算增强型 | c6.xlarge.2 | 4vCPUs | 8GB 【系统盘】高IO | 80GB 【数据盘】高IO | 80GB 【镜像】Windows | Windows Server 2019 数据中心版 64位英文 上海一 ，可用区一 2 9,128.80 弹性云服务器 ECS 2 【规格】通用计算增强型 | c6.xlarge.2 | 4vCPUs | 8GB 【系统盘】高IO | 80GB 【数据盘】高IO | 80GB 【镜像】Windows | Windows Server 2019 数据中心版 64位英文 上海一 ，可用区一 1 4,564.40 RDS SQL Server | 2016标准版 | 主备 【规格】通用增强型 | 2核8GB(独享型) 【存储空间】超高IO | 200GB 上海一 ，可用区一 1 13,350.00 RDS MySQL | 5.7 | 主备 【规格】通用型 | 4核8GB 【存储空间】SSD云盘 | 200GB 上海一 ，可用区一 1 11,250.00 分布式缓存服务Redis 【规格】4.0 | 主备 X86 | DRAM | 8 GB 上海一 ，可用区一 1 5,488.00 / / 共享型负载均衡 上海一 ，可用区一 1 1,500.00 / 弹性公网IP 【规格】独享 | 按带宽计费 | 20Mbit/s | 1个 上海一 ，可用区一 1 13,150.00 最大支持2W人同时在线 弹性云服务器 ECS 1 【规格】通用计算增强型 | c6.2.xlarge.2 | 8vCPUs | 16GB 【系统盘】高IO | 80GB 【数据盘】高IO | 80GB 【镜像】Windows | Windows Server 2019 数据中心版 64位英文 上海一 ，可用区一 2 17,136.00 弹性云服务器 ECS 2 【规格】通用计算增强型 | c6.2.xlarge.2 | 8vCPUs | 16GB 【系统盘】高IO | 80GB 【数据盘】高IO | 80GB 【镜像】Windows | Windows Server 2019 数据中心版 64位英文 上海一 ，可用区一 1 8,568.00 RDS SQL Server | 2016标准版 | 主备 【规格】通用增强型 | 4核16GB(独享型) 【存储空间】超高IO | 200GB 上海一 ，可用区一 1 25,100.00 RDS MySQL | 5.7 | 主备 【规格】通用型 | 4核8GB 【存储空间】SSD云盘 | 200GB 上海一 ，可用区一 1 11,250.00 分布式缓存服务Redis 【规格】4.0 | 主备 | X86 | DRAM | 16 GB 上海一 ，可用区一 1 11,024.00 / / 共享型负载均衡 上海一 ，可用区一 1 1,500.00 / / 弹性公网IP 【规格】独享 | 按带宽计费 | 20Mbit/s | 1个 上海一 ，可用区一 1 13,150.00

基本资料维护 人事资料维护可以查询和管理所有员工的人事资料以及进行人事基本资料信息的编辑。 查询人事基本资料 单击页面【人事管理】→【基本资料维护】，进入基本资料维护页面。 输入查询条件（不输入条件默认为查询全部），如工号、姓名、组织等，单击部门后面的放大镜图标，可查找部门。 单击查询图标，查询结果显示在列表中，如图所示： 图1 基本资料维护页面 后面所有的人事查询页面都跟此类似，不再赘述。 您可以在后台-页面配置-查询条件字段设置页面，根据自己的习惯配置需要使用的查询字段。 员工各种在职状态含义如下： 离职：指的是员工跟公司解除劳动合同关系离开公司，包括开除、除名、辞退、辞职、自动离职等类型，由用户自定义。 调出：指集团内试用、晋级试用或正式员工调出原来公司，仍没有调入新公司的员工。 试用：指一般新入职的员工以及正式员工转为试用的员工。一般试用期为3～6个月，依个人表现以及公司对其考核处理而定。 晋级试用：只针对正式员工而言。系统为了实现岗位轮调管理，特意设置了晋级试用，指正式员工如遇晋升、调职等人事异动而采取的试用期管理制度。 正式：公司的正式员工。正式员工可以转试用和晋级试用。 退休：指达到公司规定的年龄和退休条件，退出生产或工作岗位的员工。 未接收：指待入职的员工，此时人事资料还没有生效，可以随时删除。 编辑人事资料：选中列表中要编辑详细人事信息的员工记录行，单击“详细”下面的图标，编辑该人事基本资料。灰色字段因为涉及到业务变更，程序已默认是只读字段，不能编辑。如图所示： 图2 人事资料详细信息编辑页面 单击人事基本资料详细页面中不同标签可以切换到不同的页面进行人事资料的输入。 您可以在后台-页面配置-详细页面字段设置页面，根据您自己的需要配置在此页面要显示的详细字段。 合同与协议页面：维护员工与公司签订的合同、协议。劳动合同只能签订一份，协议不限。 劳动力账号页面：维护员工所属的成本中心，用于记录考勤数据的成本归属。 家庭信息页面：记录员工的家庭信息。家庭关系在人事后台公用代码中维护 教育信息页面：记录员工的教育信息。新增时‘是否最高学历’若勾选，会更新到人事表中的学历字段。教育信息页面的最高学历处也会显示。 行政管理页面：该页面的字段需要在人事后台-自定义栏位维护-行政管理页面设置。 工作经历页面：记录员工的工作经历信息。 自定义栏位维护页面：该页面的字段需要在人事后台-自定义栏位维护-自定义数据页面设置。 员工文件资料页面：可以存放员工的文件资料，包括Word，Excel，图片，PPT，文本等等格式的文件。 奖惩管理页面：记录员工的奖惩信息。若选择转薪资，将会体现在员工的薪资中（个人薪资信息维护-扩展数据页面）。 考勤规则人员关联页面：此块主要设置员工的考勤规则。不设置，员工根据系统默认的考勤规则对加班和调休进行控制；若指定，则根据指定的规则进行考勤限制。 累计配置文件人员关联页面：暂未开发。 手机信息页面：记录员工手机登录APP时的手机卡号和SIM卡号。 员工个性化设置-头像的上传：这里还可以上传员工的照片，单击“单击此处上传照片”导航条，弹出如下对话框，如下图，按照对话框中规定上传照片的大小和格式等要求上传图片，单击“浏览”按钮，选择图片，确定后单击“保存”按钮，保存上传的图片，单击“关闭”按钮，回到人事基本资料编辑页面。上传的图片即显示在该页面上， 图3 上传员工照片 新增人事资料：单击“新增”按钮，进入人事基本资料中的新增页面。您可以在后台-页面配置-新增字段设置页面，根据您自己的需要配置在此页面要维护的新增字段。这些字段也是人事新增资料导入模版的部分字段。 图4 人事基本资料新增 输入在职信息：输入员工在职信息基本资料，如部门、职位、工号、入职日等基本信息。红色星号的为必填项。 入职日默认为当天日期，试满日根据系统设置的参数自动带出，这两个日期均可以在此界面上修改；工号可在人事后台-参数配置-编码规则中设置自动生成规则。 新入职员工在职状态有试用和正式两种。试用指一般要经过试用期考核被公司正式录用才是正式员工。这里的正式指不经过试用期直接成为公司的正式员工。 试用期员工需要填写试满日，在进行试用期考核时可以修改其试满日。 编制、员工类别、证件类型、工种、学历、员工性质、户籍性质等信息需要在后台人事公用代码中维护。 DL/IDL：DL指线上员工，IDL指非线上员工。 卡号在保存时会进行唯一性验证，不能重复。离职后卡号的复用通过出勤后台-参数设置-离职卡号重新使用进行设置。 身份证的证件号码会进行正确性验证。也不能重复。 保存、生效人事基本资料：输入完毕，单击【生效】，即可立即生效。 生效时必须输入员工的入职日、部门和工号。 入职日一旦生效成功后，只可以在设置一人事管理一入离职日修正管理中修改。 员工的人事基本信息资料一旦生效后，部门、职位、在职状态、等信息只能到企业内异动管理里进行异动。

个人排班 单击【出勤管理】-【快速查询】-【排班】， 进入员工排班页面。 图6 员工排班页面 根据行事历设置，假日日期会用红色底色标识，节日日期用玫红色底色标识。 设置班别：单击【设置班别】，进入选择班别页面，页面上只显示该登录账号有权限的班别。勾选需要使用的班别，单击【保存】，已选班别就会在页面上显示。 图7 设置班别 轮班：轮班实现的是对指定的轮班开始时间，按照选择的轮班规则，进行循环次数排班。勾选日期，单击【轮班】，进入【轮班排班】页面。 图8 轮班排班 复制排班：单击【复制排班】，进入复制排班页面。选择来源日期区间，目的日期区间，完成后，单击【保存】，即完成。 目的日期区间的天数需要等于来源日期区间的天数。 图9 复制排班 修改时间：勾选已经排班的日期，单击【修改时间】，进入页面，编辑好要修改的时间，单击保存。 图10 修改时间 自由班：无固定时间段，排班时手工录入开始时间和结束时间并计算工时

薪资发放处理 单击【薪资管理】→【薪资发放处理】，进入薪资发放处理页面。您可以输入查询条件查询该条件下的薪资发放，如图所示： 图1 薪资发放处理页面 单击“新增”按钮，进入薪资发放设置页面。输入薪资发放名称，选择薪资发放类型、计薪模式和发放年月，分别输入出勤参考范围和计薪参考范围以及详细说明信息。输入完毕，单击“新增”按钮即可，如图所示： 图2 薪资发放设置页面 确认薪资发放设置 薪资发放设置计薪人员之后，还必须得到确认，确认之后的薪资发放才可以进行薪资计算。 从薪资发放列表中选择要确认的薪资发放，单击“确定”按钮，当系统提示：“确定设置完成了吗?”时，单击“确定”按钮，则提示‘确认成功，薪资发放已经进入计算状态！’，薪资发放转为“计算态”了。 关于薪资发放设置的其他操作 修改薪资发放设置：在薪资发放列表中选择要修改的薪资发放名称，您可以修改薪资发放的名称，计薪模式，类型，出勤参考范围，计薪参考范围，描述行性文字信息以及计薪人员设定，然后单击“保存”即可 薪资发放只有处于初始态时才可以修改。 删除薪资发放设置：在薪资发放列表中选择要删除的薪资发放名称，单击“删除”按钮，系统提示“真的要删除所选项吗？”，确定后即删除当前薪资发放信息。

行政组织架构维护 组织维护：单击【组织管理】→【行政组织架构维护】，进入组织架构维护页面，首先选中要维护的组织。 新增子组织：先在左边树状列表中选择要增加子组织的组织节点，单击“新增”按钮，之后再编辑子组织信息，如图所示： 图1 新增子组织 先维护组织信息，然后维护其主管及助理信息，再维护组织其他属性信息。维护完毕单击“保存”按钮或“生效”按钮即可。单击生效只会生效选中的组织；生效包含子组织会把选中组织下包含的子组织一起生效。 查找组织：单击左边上方“查找”图标，弹出新的对话框，输入查询条件（支持模糊查询），查询某组织，如图所示： 图2 查找组织 选中某个组织，单击“确定”按钮即可显示选中组织以及子组织的组织、主管和助理以及属性信息。 归档组织 归档是将当前的组织架构进行备份，归档的组织架构信息在后台“行政组织架构历史版本查看”页面可查询到（此页面的架构不能被修改）。 选中左边树状结构中某个组织，单击“归档”图标，系统弹出新的对话框，输入归档名称、归档日期以及描述性文字，单击“确定”按钮即可，如图所示： 图3 归档部门 复制组织 复制组织功能：给系统内已有组织（即父组织）生成和源组织一样的组织结构（即子组织）。 操作步骤：首先选择要复制的组织单元，单击“复制”按钮，弹出如图所示的复制组织页面，选择目标组织，在代码生成规则处根据提示输入自己想要生成的代码后（维护时遵循部门代码不能重复、也不能为空的原则），单击“确定”即可。也可根据需要维护组织名称。 图4 复制组织 复制组织：待复制的组织； 目标组织：要生成组织的父组织； 代码生成规则：必填项，系统会根据规则生成复制后的组织代码，以区别于源组织； 名称生成规则：可选填，同代码生成规则。 管理信息维护 图5 管理信息维护 此页面每个组织的管理人员在权限配置中-数据权限范围-抽象维护中起到权限限制的作用；以及可设置工作流表单的流向。 管理信息新增 图6 管理信息新增

方案优势 性能优越：方案依托于华为云RDS,DCS等高阶服务构建，对比客户自建数据库、缓存性能和安全性明显提升，同时节省客户运维成本20%以上，提升用户体验。 排班考勤：通过智能排班精确控制劳动力成本降低20%以上；通过精益工时、考勤管理快速提升劳动力效率，切实提高客户满意度，切实提高员工敬业度，预先规避合规风险。 行业经验：国内劳动力管理Top厂商，行业标杆案例丰富，具有行业最大的实施交付团队，原厂实施，确保快速上线，具有丰富的制造、零售等行业大客户交付经验。

应用场景 全球光伏产业领军者的劳动力管理数字化转型 客户的痛点： 客户主要特点：企业人员规模大、区域多且分散；人员种类多，大类包括正常工、外包工、派遣工等，细分则有生产、维修、仓储、销售、后勤等；产品生产种类、数量变化频繁。 困难和挑战：集中管控难，一线劳动力不可视，流程和制度的标准化比较差；考勤类别多且复杂，数据收集繁琐，各种工时、休假、加班和津贴等统计和计算难度很大；人员班次种类多，班次变化快。 影响：集团和管理层难以采取针对性办法，实现人工成本的控制和劳动效率的提升，不可视还有可能存在法规风险；薪资准确性存疑，考勤工作量大，员工满意度不高；加班失控，人员使用不均衡岗位技能匹配差存在质量安全等隐患。 通过本方案实现的业务效果： 通过盖雅工场劳动力管理解决方案，客实现了劳动力管理的信息化、数字化、智能化。 劳动力管理信息化 建立集团统一平台，打通数据壁垒：实现全部人员基于云平台的统一管理，打通人力资源系统、流程管理系统、业务管理系统等数据壁垒，建立全球化的专业规范系统管控，方便管理者实时监管； 规范制度建设，提升跨国用工管理水平：考勤规则统一部署，制度从「挂载墙上」转为「放到心上」 ，进一步提升集团在亚太地区的劳动力管理水平； 劳动力管理数字化 考勤实时处理，员工自助提升体验：考勤数据实时处理并及时提醒异常出勤，各个工厂员工可实时查询和自助处理个人考勤数据，提升员工敬业度和幸福度； 降本增效，驱动集团实现长远目标：提高考勤数据的真实性和准确性，降低人事支出成本，同时极大缩短HR月底结算薪资的时间，由5个工作日缩短至5小时，提升工作效率，驱动集团实现长远业务目标。 劳动力管理智能化 排班数据准确透明，为管理提供依据：系统自动加班比对，实时生成加班数据及准确的工时结果，加班、调休、欠班等数据系统把控，帮助工时成本降低9%，集团管理者可作参考，用以及时平衡产能； 数据报告助力科学决策，推动集团全球扩张：大量劳动力数据报告支持，让集团高层决策更科学、更清晰，助力阿特斯全球战略和多元化市场布局。

加班单管理 通过快速查询和加班导入生成的加班单，可以在此页面直接查询到加班单，单子的生效状态可以通过出勤管理后台-参数配置-出勤参数设定的“加班单录入即生效”参数控制。 加班单未生效的，打卡时间会在考勤卡上，但是不会在总数和排班生成加班的结果。当生效之后，加班结果就会出现了。未生效的请假单，出差单会在总数和排班以及考勤卡处显示。 单击【出勤管理】-【加班单管理】，进入加班单维护页面。如图所示： 图4 加班单管理 选择查询条件，单击查询。显示符合条件的数据。 删除：选择需要删除的加班单，单击【删除】。只能删除未生效的加班单。 生效：选择需要生效的加班单，单击【生效】。 删除生效：选择已经生效的加班单，单击【删除生效】。 Grid导出：导出查询出的列表。

异常管理 单击【出勤管理】-【异常管理】，进入异常管理页面。如图所示： 选择查询条件，单击查询。显示符合条件的数据。 图3 异常管理页面 漏打卡，未排班，这两个是默认的异常数据，直接在异常管理页面显示这两列，而且不需要写事件规则，系统会自行检查是否有这两种异常的员工数据。 未排班：所选区间有未排班的情况。 漏打卡：所选区间有排班的日期，存在上班卡或者下班卡，有未打卡的情况。 若有其他需要显示的列，可通过出勤参数设置-是否异常项，设置为“是”来控制在异常管理页面的显示。设置为显示的异常数据的项，例如迟到，早退，旷工需要写事件规则并关联到班别上，计算之后才能出现异常结果。

请假管理 通过快速查询和加班导入生成的请假单，可以在此页面直接查询到请假单，单子的生效状态可以通过出勤管理后台-参数配置-出勤参数设定的“请假单录入即生效”参数控制。 单击【出勤管理】-【请假管理】，进入请假管理页面。如图所示： 图5 请假管理 选择查询条件，单击查询。显示符合条件的数据。 删除：选择需要删除的请假单，单击【删除】。只能删除未生效状态的记录。 生效：选择需要生效的请假单，单击【生效】。 删除生效：选择已经生效的请假单，单击【删除生效】。 Grid导出：导出查询出的列表。

快速查询 单击【出勤管理】-【快速查询】，进入快速查询页面。 选择查询条件，查询出符合条件的人员。如图所示： 图1 快速查询 选择人员，进行相关操作。 操作： 单击【考勤卡】，进入考勤卡页面。也可双击记录进入考勤卡页面。 单击【添加打卡】，可以新增打卡记录。 单击【删除打卡】，可以删除打卡记录。 单击【导出】，可以导出打卡信息。 排班： 单击【排班】，可以进入员工排班表，对员工进行排班。 单击【排班数据导入】，可以导入排班数据。 审批： 单击【审批】，可以对考勤卡信息审批。 单击【删除审批】，可以对已审批的信息删除审批。 单击【签核】，可以对考勤卡信息签核。 单击【删除签核】，可以对已签核的信息删除签核。 请假： 单击【请假】，进入请假页面，新增请假单。 单击【批量请假】，进入批量请假页面，可以为多个员工新增请假单。 单击【请假数据导入】，可以导入请假数据。 加班： 单击【加班】，进入加班页面，新增加班单。 单击【批量加班】，进入批量加班页面，可以为多个员工新增加班单。 单击【加班数据导入】，可以导入加班数据。 出差： 单击【出差】，进入出差页面，新增出差单。 单击【批量出差】，进入批量出差页面，可以为多个员工新增出差单。 欠班： 单击【欠班】，进入欠班页面，新增欠班单。 单击【批量欠班】，进入批量欠班页面，可以为多个员工新增欠班单。 单击【欠班导入】，可以导入欠班数据。 导出： 单击【导出】，可以导出查询的 人员信息。 也可双击列表，进入考勤卡页面。如图所示： 图2 考勤卡 页面会默认显示本周的考勤信息。可以变更时间区间或者单击日期或日期旁边的图标进行更改。 选择工资代码列，会出现下拉框，选择需要手动维护的考勤类型，在时数列输入时数，单击保存，即维护成功。此种操作直接生成事件的结果。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-business-id 是 Long 应用id。 X-Auth-Token 是 String 从 IAM 服务获取的用户Token。 表2 请求Body参数 参数 是否必选 参数类型 描述 from 是 Long 开始时间，比如1704271204595 to 是 Long 结束时间, 比如1704275169491 type 是 String 数据类型, CPU 或者 LATENCY instance_id 是 Long 实例id api 是 String api的url,比如: GET_/user/{id} region 是 String 实例所在区域

请求示例 POST: /v1/apm2/openapi/view/profiling/flame-line-tree { "from": 1704271204595, "to": 1704275169491, "type": "LATENCY", "instance_id": -6870732446083119805, "api" : "GET_/user/{id}", "region":"cn-north-7" }

响应示例 状态码： 200 { "data":[ 100, 1000, null, [ [ 700, 700, 0, 30, // 行号 [] ], [ 200, 200, 1, 40, // 行号 [] ] ] ], "methods":[ [ 2, // method id "com.huawei.foo", "SampleService", "doService", "int,long,String", true, // 是否为用户方法 false // 是否为native方法 ], [ 3, "com.huawei.bar", "SampleRemoteCall", "sampleCallRemoteProcess", "float,int", true, // 是否为用户方法 false // 是否为native方法 ] ]}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data Array of strings 火焰图的数据是个二维数组。 data[0][0]: self time，方法自己消耗的cpu毫秒时间，不包括方法内部调用其他方法的时间。 data[0][1]: total time, 方法消耗的cpu毫秒时间，包括方法内部调用其他方法的时间。 data[0][2]: 方法的index,对应methods中的数组下标。 data[0][3]: 行号 data[0][4]: 方法的子节点，就是方法中调用的其他方法。 methods Array of strings 调用栈上的方法信息是个二维数组。 method[0][0]: 方法的唯一id。 method[0][1]: 方法的package包名。 method[0][2]: 方法的class name 类名。 method[0][3]: 方法名。 method[0][4]: 方法的参数列表。 method[0][5]: 方法是否为用户的方法。 method[0][6]: 方法是否为native方法。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 x-business-id 是 Long 应用id。 表2 请求Body参数 参数 是否必选 参数类型 描述 business_id 是 Long 应用id。 region 是 String 区 域名 称。 page 是 Integer 页码。 page_size 否 Integer 每页条数。 keyword 否 String 关键字。

请求示例 搜索Region ID为cn-north-4，应用id为6的探针情况，并设定页码为1，单页大小为10。 /v1/apm2/openapi/apm-service/app-mgr/search { "business_id" : 6, "region" : "xx-xxxx-xxx", "keyword" : "", "page" : 1, "page_size" : 10 }

响应示例 状态码： 200 OK，请求响应成功。 { "app_info_list" : [ { "env_name" : "beta", "env_id" : 1, "app_name" : "application_name", "app_id" : 2, "online_count" : 2, "disable_count" : 1, "offline_count" : 1 } ], "app_total_count" : 4, "app_info_map" : { "additionalProp1" : { "env_name" : "string", "env_id" : 0, "app_name" : "string", "app_id" : 0, "online_count" : 0, "disable_count" : 0, "offline_count" : 0 }, "additionalProp2" : { "env_name" : "string", "env_id" : 0, "app_name" : "string", "app_id" : 0, "online_count" : 0, "disable_count" : 0, "offline_count" : 0 }, "additionalProp3" : { "env_name" : "string", "env_id" : 0, "app_name" : "string", "app_id" : 0, "online_count" : 0, "disable_count" : 0, "offline_count" : 0 } } }

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 apm2.00000001 Internal error. 内部错误 apm后端服务发生未知异常，请联系apm技术人员进行处理 400 apm2.00000005 Invalid parameters. 无效的参数 输入的参数有问题，请确认每一个参数是否正确 403 apm2.00000003 You have not logged in. 没有登录 先登录当前iam用户 403 apm2.00000004 No permission. 没有权限 请确认用户是否具有权限进行该操作 父主题： 附录

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-4”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 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 POST https://endpoint/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

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

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

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表1。 表1 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://endpoint/v3/auth/tokens Content-Type: application/json

响应示例 状态码： 200 OK，请求响应成功。 { "result" : "app.35f924a1.js.map", "status" : "success" } 状态码： 400 Bad Request，语义或参数有误。 { "error_code" : "apm2.00000001", "error_msg" : "internal error", "hint" : null }

LTS日志计费相关问题？ 使用LTS日志计费相关问题如下，具体单价请参考官网LTS价格详情说明。 原始日志流量及索引流量、读写流量的关系： 日志读写流量：读写流量根据传输的流量计算，传输流量为压缩后的日志大小，日志一般有5倍压缩率，原始日志流量为读写流量的5倍。 示例：原始日志为10GB，实际压缩大小为 2GB，则以2GB 计费。 在字段索引配置功能上线之前，LTS所有字段均支持索引，索引流量等于原始日志流量，字段索引功能上线之后，索引流量和用户的索引配置相关。在用户开启全文索引或者没有进行索引配置的场景下，索引流量等于原始日志流量，如果用户只配置了字段索引，则索引流量只统计开启了字段索引的字段，不再和原始日志流量保持一致。 日志索引流量：原始日志数据默认都会建立全文索引，创建索引（对日志分词处理）后，才能搜索日志，在写入时一次性收取流量费用。 示例：原始日志为10GB，需要索引的流量为10GB，产生索引流量费用3.2元。 日志存储空间：日志存储空间为压缩后的日志数据、索引数据、副本数据之和，这些空间约等于原始日志数据大小。 示例：原始日志为10GB，那么一天存储最大收费为 0.000479*24*10=0.12元（金额如果遇小数点，则保留小数点后两位，第三位四舍五入。如遇四舍五入后不足￥0.01 元，则按￥0.01 元展示）。 新建日志流的ICAgent结构化解析和云端结构化解析资源统计及计费的区别： ICAgent结构化解析支持插件组合解析，单个日志流的多个采集配置支持不同结构化解析规则，并且可以选择是否上传原始日志，不上传原始日志在资源统计和计费时则不会统计content字段，推荐使用ICAgent结构化解析。 云端结构化解析将原始日志结构化之后会保留content字段，在资源统计和计费时content字段和结构化字段都会统计在内。云端结构化解析会消耗LTS服务端算力，未来会按照日志大小收取日志加工流量费用。 父主题： 计费FAQ

监控项类型 Agent会自动发现系统采集的插件类型，并且将采集器实例化，形成监控项。监控项是实例化在一个环境上的。 由于采集器种类较多，会导致用户区分困难。系统后台会定义一些类型，每种采集器都会归到一种类型下，这样方便用户查看数据。 APM应用指标监控可以度量应用的整体健康状况。拓扑、接口调用、基础监控、异常为基本的监控项。其他的监控项，如：外部调用、通信协议、数据库、Web容器、缓存、消息队列，会由Agent根据用户服务的使用情况，自动发现予以显示。 应用指标监控仅展示接入应用涉及的监控项的指标。接入应用不涉及的监控项的指标，不做展示。 根据采集器的作用可以将监控项分为以下几种类型： 拓扑：拓扑图展示服务之间一段时间的调用关系，可以是从调用方统计的，也可以是从被调用方统计的，并且可以查看这个调用关系的趋势图。 接口调用：指外部服务调用当前应用的监控类型。 基础监控：用来监控系统性能的基础监控指标的监控类型。 异常：用来监控应用的异常信息。 外部调用：是指当前应用调用外部服务的监控类型。 数据库： 对数据库的访问进行监控。 缓存：是对Redis等缓存系统的监控，会采集指令级别的细粒度的指标数据。 web容器：对tomcat等web容器的监控，一般会采集系统总的处理线程数，busy线程数，连接数等；用于衡量系统总的容量。 消息队列：对kafka、RabbitMq等消息系统的监控，包含发送端和接收端的监控。在接收端的处理函数，可以产生调用链信息。 通信协议：对websocket等通信协议的监控。 profiler性能分析：自动获取应用程序运行过程中，CPU Time、Allocated Memory、Latency以及Live Object Memory的使用情况，通过火焰图实时展示每一个方法的调用关系和执行率，帮助优化代码性能。 Debugging诊断：Debugging诊断可协助用户分析线程状况，获取方法及对象实时参数。方便开发人员从实时的远程应用程序中获取调试信息，而无需重新启动应用程序，也不会阻止它并导致服务停机。 远程过程调用：对GRPCServer等远程过程调用的监控。

优势对比 单机实例：支持创建只读实例、错误日志、慢日志查询管理。相较于主备实例，单机实例少了一个数据库节点，可大幅节省用户成本，售价低至主备实例的一半。由于单机实例只有一个数据库节点，当该数据库节点出现故障时，恢复时间较长，因此，如果是对数据库可用性要求较高的敏感性业务，不建议使用单机实例。 主备实例：主备实例的备数据库节点仅用于故障转移和恢复场景，不对外提供服务。由于使用备数据库节点会带来额外性能开销，从性能角度来看，单机实例的性能与主备实例相同，甚至单机实例的性能可能会高于主备实例。 集群版实例：采用微软AlwaysOn高可用架构，支持1主1备5只读集群模式，拥有更高可用性、可靠性、可拓展能力。

RDS for MariaDB产品系列 RDS for MariaDB各实例类型简介以及功能对比，详见表1和表2。 表1 实例类型简介 实例类型 简介 使用说明 产品优势 适用场景 单机实例 采用单个数据库节点部署架构。与主流的主备实例相比，它只包含一个节点，但具有高性价比。 单机版出现故障后，无法保障及时恢复。 支持创建只读实例、错误日志、慢日志查询管理。相较于主备实例，单机实例少了一个数据库节点，可大幅节省用户成本。由于单机实例只有一个数据库节点，当该数据库节点出现故障时，恢复时间较长，因此，如果是对数据库可用性要求较高的敏感性业务，不建议使用单机实例。 个人学习。 微型网站。 中小企业的开发测试环境。 主备实例 采用一主一备的经典高可用架构，支持跨AZ高可用，选择主可用区和备可用区不在同一个可用区（AZ）。主实例和备实例共用一个IP地址。 备机提高了实例的可靠性，创建主机的过程中，会同步创建备机，备机创建成功后，用户不可见。 当主节点故障后，会发生主备切换，期间数据库客户端会发生短暂中断。若存在复制延时，主备切换时间会长一点，数据库客户端需要支持重新连接。 主备实例的备数据库节点仅用于故障转移和恢复场景，不对外提供服务。由于使用备数据库节点会带来额外性能开销，从性能角度来看，单机实例的性能与主备实例相同，甚至单机实例的性能可能会高于主备实例。 大中型企业的生产数据库。 覆盖互联网、物联网、零售电商、物流、游戏等行业的应用。 表2 产品基本功能对比 产品功能 单机实例 主备实例 节点数 1 2 规格配置 SSD云盘vCPU：最高64核 SSD云盘内存大小：最高512 GB 数据盘：最高4000 GB 具体以实际界面为准。 SSD云盘vCPU：最高64核 SSD云盘内存大小：最高512 GB 数据盘：最高4000 GB 具体以实际界面为准。 监控与告警 支持 支持 安全组 支持 支持 备份与恢复 支持 支持 参数设置 支持 支持 SSL 支持 支持 日志管理 支持 支持 只读实例（需另建实例） 支持 支持 SQL审计 支持 支持 智能DBA助手 支持 支持 可用区切换 不支持 支持 手动主备切换 不支持 支持 规格变更 支持 支持 磁盘扩容 支持 支持 回收站 支持 支持 父主题： 产品系列

操作步骤 登录CAE控制台。 在左侧导航栏中选择“组件列表”。 在页面上方的下拉框中，选择已创建的应用和环境，单击“新增组件”。 参考表1设置组件信息。 表1 组件基本信息 参数 类别 说明 组件名称 - 新建组件的名称。 版本号 - 组件的版本号。 格式为：A.B.C或者A.B.C.D。A、B、C、D为自然数，例如：1.0.0或者1.0.0.0。 实例规格 - 选择实例规格，例如：0.5core、1GiB；1core、1GiB；1core、2GiB；2core、4GiB等。 实例数量 - 实例数量默认为2，最少为1，最大值为99。 代码源 源码仓库 选择源码来源。本服务支持识别CodeArts、GitHub、GitCode、GitLab、Gitee和Bitbucket来源的代码。 将代码信息补充完整。 授权信息：从下拉框中选择对应的源码授权信息。如果您是首次使用该功能，在下拉框右侧单击“新建授权”，填写“授权名称”和选择“授权方式”，单击“确认”完成授权。单击“授权列表”可查看当前已创建的授权信息，选中列表前方复选框，可对已授权源码进行“重新授权”或“删除”。 用户名/组织：选择源码对应的用户名称或组织，用于当前项目的代码管理。 仓库名称：用于当前项目下各个模块代码的管理。 分支：选择对应的分支，用于开发对代码的管理。 语言/运行时：从下拉框中选择源码对应的语言格式。具体操作请参考组件说明。 自定义构建：构建命令可根据业务需要选择“使用默认命令或脚本”或“使用自定义命令”。 说明： 不同源码来源新建授权时授权方式不同，请按照实际情况进行选择。 使用默认命令或脚本：优先执行代码根目录下的build.sh，不存在则按照所选语言的通用方法构建，如Java：mvn clean package。 使用自定义命令：根据所选语言自定义构建命令；或修改build.sh文件后选择使用默认命令或脚本。 Dockerfile：组件来源是“源码仓库”时，根据业务需要设置。支持“自定义”和“系统默认”。 说明： 仅当“运行时”选择java时，可选择“系统默认”修改系统默认dockerfile中指定运行的maven构建制品文件名。 Dockerfile地址：当“Dockerfile”选择“自定义”时可设置。 “Dockerfile地址”即Dockerfile文件相对于项目的根目录（./）所在的目录，Dockerfile文件用于镜像构建。 Docker程序通过读取Dockerfile文件生成定制的镜像。 dockerfile地址只能包含字母、数字及.-_/且字符长度在1~255范围内的内容。 如果文件名为Dockerfile，允许只填写目录地址，但目录地址必须以/结尾。 制品文件名：当“Dockerfile”选择“系统默认”时可设置。 maven构建生成多个jar包时，选取指定的jar包运行，以".jar"结尾，支持模糊匹配，如:demo-1.0.jar，demo*.jar 镜像 用户可以通过“客户端上传镜像”和“页面上传镜像”两种方式上传镜像包。 在“我的镜像”、“开源镜像”或者“共享镜像”中选择已上传的镜像包部署。可通过镜像名称搜索镜像。 我的镜像：用户自定义上传的镜像包。 开源镜像： 容器镜像服务 SWR中提供的开源镜像。 共享镜像：不同账号之间共享的镜像包。 （可选）用户还可以通过单击“代码源”右侧链接，前往容器 镜像服务 SWR控制台对镜像进行更多管理操作。 说明： 选择“页面上传镜像”时，单次仅支持添加1个镜像压缩包，文件大小（含解压后）不得超过 2 GB，支持 tar、tar.gz格式，仅支持上传1.11.2及以上容器引擎客户端版本制作的镜像压缩包，制作过程详见制作镜像压缩包。 如需上传大于 2GB的文件，请使用“客户端上传镜像”。 软件包 选择软件包位置“CodeArts软件发布库”或“OBS对象存储选择”。 从“CodeArts软件发布库”选择对应软件包时，需要提前将软件包上传至软件发布库，具体操作请参考上传软件包。 从“OBS对象存储选择”中选择对应软件包时，需要先将软件包上传至OBS对象存储桶内，具体操作请参考上传对象。 语言/运行时：从下拉框中选择软件包对应的语言格式。具体操作请参考组件说明。 构建方式：根据业务需要选择“系统默认”或“自定义Dockerfile”。 使用“系统默认”：根据语言/运行时使用默认Dockerfile构建。 使用“自定义Dockerfile”：根据所选语言自定义Dockerfile内容构建。 创建组件。 单击“配置组件”，进入组件配置页面，具体操作请参考组件配置。 单击“创建组件并部署”，在弹出的对话框中单击“立即部署”，部署组件。 组件创建或部署完成后，在组件列表页可查看环境ID、应用ID、组件ID、组件名称，代码源、状态、实例个数、创建时间等信息。 图1 组件列表概览 若在组件创建后处于“未部署”状态，您可以直接在“组件列表”页面，单击列表“状态”列的“前往配置”，对组件进行配置并部署。 若在组件处于“运行中”状态，您可以在“组件列表”页面，单击列表“快捷跳转”列的，对组件进行重新配置并执行生效配置。