华为云用户手册

  • 修订记录 版本日期 变更说明 2024-03-25 第十九次正式发布。 新增手机内重启章节。 2023-10-27 第十八次正式发布。 新增切换云手机服务器章节。 2023-08-17 第十七次正式发布。 下线 VNC方式(控制台)章节。 下线 VNC方式(客户端)章节。 2023-07-31 第十六次正式发布。 新增后台进程管理、纹理压缩开关章节。 更新购买云手机实例章节中参数实例规格的样例。 2023-07-11 第十五次正式发布。 新增更换弹性公网IP章节。 2023-07-03 第十四次正式发布。 购买云手机实例,网络配置下线系统定义网络配置说明。 购买云手机实例,自定义网络配置新增ipv6选项的指导。 ADB方式(内网)新增ipv4/ipv6双栈的描述。 ADB方式(公网)新增ipv4/ipv6双栈的描述。 2023-06-30 第十三次正式发布。 新增权限配置示例章节。 2023-05-05 第十二次正式发布。 新增支持的事件监控章节。 更新支持的监控指标章节。 2021-09-30 第十一次正式发布。 新增虚拟设备仿真和云手机音视频。 2021-05-11 第十次正式发布。 新增自定义网络配置。 2021-02-25 第九次正式发布。 新增使用AOSP功能。 2021-02-10 第八次正式发布。 购买云手机实例,网络配置新增自定义网络配置说明。 2020-09-30 第七次正式发布。 新增审计章节。 购买云手机服务器,网络配置界面优化,刷新截图。 2020-08-10 第六次正式发布。 购买云手机服务器,高级配置中增加自定义网络功能。 ADB方式(内网),修改创建VPC对等连接的方法。 新增路由配置、监控章节。 2020-06-22 第五次正式发布。 新增更新云手机实例属性章节。 2020-04-30 第四次正式发布。 新增如下章节: 查看云手机实例详情 关闭云手机实例 修改云手机实例名称 重启服务器 退订服务器 续费服务器 2020-03-30 第三次正式发布。 新增一键式ADB连接(推荐)章节。 2020-02-18 第二次正式发布。 全文优化,包括大纲调整、操作步骤优化、补充场景性说明等。 2019-01-31 第一次正式发布。
  • 云手机视频 视频初始化 初始化视频服务,设置视频初始化参数,包括视频格式、编码模式、分辨率、码率等。 启动视频服务 启动视频服务,获取视频数据。 停止视频服务 停止视频服务,停止视频数据的获取。 销毁视频服务 销毁视频服务。 获取视频服务状态 获取视频服务状态,包括初始化、运行中、停止、无效等。 获取当前视频参数 获取视频服务当前参数配置,包括帧率、码率、码控模式、分辨率等。 动态设置视频参数 动态设置视频服务参数配置,包括帧率、码率、分辨率等。
  • 审批流程 流程发起后,发送至审批人进行审批,审批人可根据实际情况选择审批通过、驳回或转他人处理。 项目经理审核时,需要在“待评审部件”中选择评审结论,“通过”或“不通过”,然后在“审批信息”中选择“通过”“驳回”或“转他人处理”。 驳回后申请人可重新修改提交。 专家审核时,需要在“待评审部件”中选择评审结论,“通过”或“不通过”,然后在“评审结论”中选择“通过”或“转他人处理”。 PDE终审通后,流程结束。 图2 流程审批页面
  • 登录页面重置密码 已登录过云堡垒机且配置了手机号码的账号忘记了密码可参考本章节进行重置密码。 在云堡垒机系统登录页面,单击“忘记密码?”,进入“重置密码”页面。 根据“重置密码”引导,如图1。确认账号信息,输入“登录名”、“手机号码”和“短信验证码”,输入的手机号码需与用户账号绑定的手机号码一致。 图1 重置密码引导 确认重置密码身份。 根据提示信息,输入用户绑定的手机号码,并通过短信验证码验证身份。 若忘记手机号码,可单击“无法获取短信?”,填写系统信息尽量找回密码。 图2 确认用户手机号码 根据密码设置要求重置和确认密码。 密码设置要求:长度范围8~32个字符;需同时包含英文大写字母(A~Z)、英文小写字母(a~z)、数字(0~9)和特殊字符,不支持空格。 新密码设置成功后,返回登录页面输入“登录名”和“密码”,登录云堡垒机系统。
  • 堡垒机后台对接LTS处理步骤 登录堡垒机后台,执行ICAgent安装命令。 使用如下命令,修改数据库表参数。命令执行完后需要重新输入数据库账户名及密码。 mysql -h127.0.0.1 -uyunanbao -P31036 -p -D yunxiazi3.0 -e "update tb_system_property set property_value = 1 where property_id = 280;" mysql -h127.0.0.1 -uyunanbao -P31036 -p -D yunxiazi3.0 -e "update tb_system_property set property_value = 1 where property_id = 279;" mysql -h127.0.0.1 -uyunanbao -P31036 -p -D yunxiazi3.0 -e "select * from tb_system_property where property_name like '%lts%';" 完成步骤2的配置之后,执行如下命令重启tomcat服务: systemctl restart tomcat 堡垒机后台对接LTS后,在堡垒机web界面不能单击编辑LTS配置,否则该配置将会禁用,需要重新执行步骤1和步骤3重新启用LTS配置。
  • 需备份数据 版本升级前,为实现新云堡垒机系统中复用数据信息,用户需在系统升级前手动备份系统数据,系统升级完成后再导入备份数据。 针对不同的数据信息,用户需分别进行导出/导入操作,才能完成所有数据的备份。 表1 版本升级需备份数据 数据信息 导出 导入 说明 用户 √ √ 无法导出“用户密码”。升级完成后,可选择重置用户密码。 资源账户 √ √ 为防止资源账户信息丢失,建议单独备份和还原资源账户文件。 审计数据 √ × 审计数据无法重新导入到系统,需全量备份审计数据,主要包括历史会话、会话视频、系统登录日志、系统操作日志、运维报表和系统报表。 “运维报表”和“系统报表”支持文本格式导出。 “历史会话”支持导出MP4格式会话视频。 系统配置 √ √ “系统配置”信息包含全量系统配置数据。 详细系统配置说明请参见配置备份与还原。
  • 解决办法 解决办法一:将应用发布服务器安装的remoteapp组件升级至1.1.8.0及以上版本。 解决办法二:登录应用发布服务器,修改“C:\DevOpsTools\RemoteAPPProxy\Application.ini”文件,修改参数影子账户用户名最大长度max_user_length=20将值改为服务器支持的创建用户长度,例如15。 若您不想通过升级RemoteAppProxy跳板工具的临时处理方法,可登录应用发布服务器修改“C:\DevOpsTools\RemoteAPPProxy\Application.ini”文件,修改参数,关闭影子账户:use_shadow_user=0 是否使用影子账户模式的参数说明: 1:开启 0:关闭
  • 控制策略类型介绍 预防性控制策略:策略主体为SCP服务控制策略,任何在策略中显性拒绝的操作都会被拦截。预防性控制策略在指定OU上生效之后,该OU所有直系子级账号均会继承该策略。 检测性控制策略:策略主体为Config合规规则,不合规的资源配置会被检测发现并反馈给用户,用户可以在资源治理中心服务控制台查看不合规的资源列表。检测性控制策略在指定OU上生效后,该OU所有直系子级账号均会根据规则要求检测不合规配置的发生。
  • 实施类型 必选:这部分策略在开启RGC服务并设置Landing Zone后,便在核心OU和核心账号上强制自动生效,而且无法禁用。 强烈推荐:基于华为云治理最佳实践强烈推荐的合规遵从管控策略,大部分企业用户在云上治理多账号环境时大概率会涉及相关场景和服务,建议Landing Zone搭建完成之后,企业用户自主启用。 可选:企业云上治理过程中,部分企业用户可能会涉及相关控制策略,可以根据具体情况灵活选用相关策略。
  • 使用方法 建议使用手机内重启功能时进行流控。并发重启大量手机可能会导致宿主机负载突然飙升,可能会对其他正常运行的手机产生影响。 通过命令行重启 adb shell reboot 约束:只有uid为0,1000或2000的进程有权限执行reboot命令。 系统APP通过PowerManager接口重启 PowerManager powerManager = getSystemService(PowerManager.class); powerManager.reboot("your reason for reboot"); 约束:只有uid为0,1000的进程有权限调用PowerManager接口。 通过注入长按关机键重启 adb shell input keyevent --longpress KEYCODE_POWER 注入长按关机键后,屏幕会弹出重新启动选项,用户单击按钮后手机重启。 例:不同AOSP版本,按钮UI可能不同,请按实际参考。 图1 重新启动 约束:只有uid为0,1000或2000的进程有权限注入长按关机按键。
  • 注册华为账号并实名认证 如果您已有一个华为账号,请跳到下一个任务。如果您还没有华为账号,请参考以下步骤创建。 打开/,单击“注册”。 根据提示信息完成注册,详细操作请参见“如何注册华为云管理控制台的用户?”。 注册成功后,系统会自动跳转至您的个人信息界面。 参考“实名认证”完成企业账号实名认证。 当前RGC服务暂不收取费用。但您需要根据使用情况为以下服务付费:SMN、OBS等。
  • 更多操作 告警行动规则创建完成后,您还可以执行表2中的相关操作。 表2 相关操作 操作 说明 编辑告警行动规则 单击“操作”列的“编辑”。 删除告警行动规则 删除单条规则:单击对应规则“操作”列的“删除”,随后在提示页面单击“确定”即可删除。 删除单条或多条规则:勾选对应规则前的复选框,单击“批量删除”,随后在提示页面单击“确定”即可删除。 说明: 删除告警行动规则前需要先删除该行动规则绑定的告警规则或分组规则。 搜索告警行动规则 在右上角的搜索框中输入规则名称关键字,单击后显示匹配对象。
  • 运维中心工作台介绍 AppStage运维中心工作台如图1所示。 图1 运维中心工作台 AppStage运维中心工作台各模块功能如表1所示。 表1 控制台功能说明 模块标识 功能说明 1 服务列表按钮,可切换运维中心提供的BaaS服务和中间件。 2 单击“工作台”可切换至运维中心工作台。 3 可切换站点,当前仅支持“中国区2CBU生产”站点。 4 可切换自有服务,即在业务控制台创建的产品及服务。 5 可切换专项角色,专项角色可在组织内跨租户进行管理,具备跨租户的管理权限,包括主机管理员(主机运维角色)、DBA(数据库DBA角色)等,如需申请专项角色权限请参见申请权限。 6 单击“文档中心”可查看运维中心相关文档。 7 可单击“变更电子流”,进入“变更电子流”页面,可以查看已创建的电子流,或者新建电子流。 8 个人帐号信息管理,包括如下功能: 审计日志:可查看登录账号在运维中心的所有操作日志,产品管理员可查看对应产品的所有操作日志。 我的信息:可以查看个人信息和已拥有的权限,也可以进行权限申请。 租户管理:“我的租户”页面可以查看在业务控制台创建的组织(租户)、产品、服务和微服务信息。“订阅信息”页面可以查看已订阅的服务信息。 账号管理:如果华为云资源管理账号与AppStage的开租账号不同,可以使用账号管理将华为云账号录入AppStage。 说明: 查看并使用账号管理,需要将“专项角色”切换为“主机管理员”。 9 展示近期已访问的服务和已收藏书签内容,可以单击服务或书签快速访问。 收藏书签的方法:单击页面右侧悬浮菜单中的收藏按钮进行收藏,收藏后该页面可展示在已收藏书签列表。 10 展示已集成的中间件和已订阅的服务,单击服务名称可快速访问对应服务。 11 展示近期告警数据,单击“更多”可进入监控服务页面查看详情数据。 12 展示CPU使用情况,单击“更多”可进入实时监控页面查看详细数据。 13 展示运维中心主要功能介绍。 14 展示近期系统公告内容,可以单击“更多”查看所有公告内容。 15 展示近期系统新特色,可以单击“更多”查看历史特性内容。 16 展示用户统计数据,包括当前在线用户数、昨日访问量和历史总人数。
  • 功能介绍 表1 运维中心功能介绍 服务名称 服务简介 部署服务 基础设施即代码(Infrastructure as code,简称IaC)是一种基于软件开发实践形成的基础设施的自动化方法,它强调一致、可重复的供给和变更系统及其配置。当代码发生变更后,可以进行自动化测试,测试完成后可自动化的应用变更到运行系统中。使用基础设施即代码的方法,可以使用敏捷工程的优秀实践(如测试驱动开发、持续集成、持续发布)可以快速安全的变更基础设施。 部署服务按架构元素(服务)组织资源,软件单元(微服务或函数)作为最小变更单元 ,执行变更的结果围绕服务环境进行资源管理,每个组件可以独立发布版本、独立变更。 监控服务 监控服务(ServiceInsight)是一个面向自有服务和生态开发者的开发和运维SRE(Site Reliability Engineer),围绕故障生命周期,构建开箱即用的,集预防、检测、诊断、恢复、通报和改进于一体的可观测性平台。 演练服务 演练服务(WiseChaos)起始于系统改造,具备基本韧性,引入混沌工程并持续向IT化、自动化、智能化、场景化发展。对混沌工程实践进行全流程、数字化、体系化度量,具备精细化持续运营能力。通过完善工具链实现演练过程可控可视,演练场景可复用,高度自动化,最终实现无人值守演练。 弹性资源服务 弹性资源服务(Elastic Resource Service,简称ERS)提供资源池监控、访问安全控制、任务调度、业务负载弹性伸缩、集群联邦、配额管理和多种K8s扩展等能力,通过统一的对外接口提供业务管理能力,上层业务不再感知下层资源。同时提供Portal可视化管理容器,包括工作负载的管理、配置文件管理和容器WebTerminal。 弹性网络服务 弹性网络服务(Elastic Network Service,简称ENS)通过引入“隔离域”这一网络资源概念,将业务使用的底层网络资源进行封装。 主机管理服务 主机管理服务(VMS)是基于云原生的主机资源管理服务,负责各种类型的主机资源发放/回收/操作、OS管理、密码密钥管理。 父主题: 运维中心简介
  • 操作步骤 在AppStage首页右上区域单击“运营中心”快捷入口,进入运营中心工作台。 在左侧导航栏选择“指标模板库”。 从指标模板库查找所需指标模板,单击选中的模板,当前支持的指标模板如表1所示。 如果指标模板库中未找到所需模板,用户可在“指标管理”界面创建符合业务需要的指标。 表1 指标模板 指标模板名称 描述 注册用户数计算模板(注册用户总数/新增用户数) 用于计算网站或应用的注册用户数量,包括总数和新增用户数。 独立访客数(UV)计算模板(总数/日活) 用于计算网站或应用的独立访客数量,包括总数和日活。日活指当天访问网站或应用的独立访客数量。 新增访客数计算模板(日新增/周新增/月新增) 用于计算网站或应用的新增访客数量,可按日、周、月进行统计。新增访客指首次访问网站或应用的用户。 页面浏览量(PV)计算模板(总数/各页面浏览量) 用于计算网站或应用的页面浏览量,包括总数和各页面的浏览量。 用户停留时长计算模板(应用内人均停留时长/页面人均停留时长/重点页面人均停留时长) 用于计算用户在网站或应用上的停留时长,包括应用内人均停留时长、页面人均停留时长和重点页面人均停留时长。 留存率计算模板(留存率/曝光事件转化率) 用于计算用户在网站或应用上的留存率和曝光事件转化率。留存率指用户在一定时间内仍然使用网站或应用的比例,曝光事件转化率指用户在接触网站或应用后转化为注册或付费用户的比例。 在“模板详情”界面,查看指标模板信息,单击“应用”。 在“应用模板”界面,填写基础配置信息,如表2所示。 表2 基础配置 参数 说明 模板指标 预定义的指标。 数据源 数据源在“数据源”界面配置,单击“选择数据源”关联数据源。 请校验数据字段中的映射关系,如果不匹配可能会导致后续的模板应用出现异常或错误。 单击“确定”,完成指标模板应用配置。
  • 问题描述 启动SMS-Agent时,出现如下提示: Linux系统,提示“SMS.0502: Source server registration failed. Cause: Current quota is not enough, please use MgC.” Windows py2系统,提示“SMS.0502: Source server registration failed. Cause: Current quota is not enough, please use MgC.” Windows py3系统,提示“注册源端失败,错误原因:Current quota is not enough, please use MgC.”
  • 接入流程 工业软件云License联营商品接入云商店的流程如下图所示: 图1 工业软件云License联营商品接入云商店流程 流程说明如下: 申请入驻云商店,成为商家。 云商店运营人员审核公司的资质信息。 根据工业软件云平台的商品接入规范进行应用改造。 准备生产接口服务器,根据本文开发生产接口。 在卖家中心申请访问密钥。 将开发好的生产接口地址绑定访问密钥、并调测成功保存。 调测云商店查询订单、字符串/文件流上传接口。 在卖家中心发布应用资产。 工业软件云平台运营在海顿平台测试应用资产。 云商店运营审核应用资产上架。 在卖家中心申请联营认证。 云商店运营审核联营认证。 在卖家中心申请发布在线开通License联营商品。 云商店运营审核联营商品上架。 运营审核通过后商品上架成功,并在卖家中心自助管理生产接口通知消息。 父主题: 联营License类商品接入指南
  • 概念介绍 ISCDesk ISCDesk(Industrial Software Cloud Desktop),工业软件云桌面工具管理客户端,提供工具软件的一键下载、安装、打开和卸载功能。 ISV ISV(Independent Software Vendor),独立软件开发商,是具有区域和行业属性的软件类合作伙伴。此处指云商店商家,是指经过有效申请并经过华为同意,通过云商店向用户销售及提供基于云计算,大数据业务的软件,镜像以及服务的企业。
  • 响应消息 响应参数说明请参见下表: 参数 是否必选 类型 最大字符长度 说明 resultCode M String 6 调用结果码。 具体请参见调用结果码说明。 resultMsg O String 255 调用结果描述。 商家的服务器在处理接口请求时,需要做好幂等性处理。 云商店服务有可能重发请求,针对同一订单号,商家的服务器应当返回成功的响应,不应该再做实例延期处理,返回成功响应即可。 响应消息示例: { "resultCode":"000000", "resultMsg":"success." }
  • 请求方法:GET 参数 是否必选 类型 最大字符长度 说明 activity M String 20 接口请求标识,用于区分接口请求场景。 续费场景取值:refreshInstance authToken M String 50 安全校验令牌。 取值请参见authToken取值说明。 orderId M String 64 云商店订单ID。 说明: 续费操作会产生新的订单,与新购时订单ID不一致,请通过instance Id做资源识别。 instanceId M String 64 实例ID。 productId O String 64 产品标识,租户续费或转正产品实例时,如果订购周期类型发生变化,会传入变化后的产品类型对应的productId。 expireTime M String 20 过期时间。 格式:yyyyMMddHHmmss trialToFormal O String 2 是否是试用转正请求 不传参数:不是 1:是(试用转包周期) 默认不是试用转正。 timeStamp M String 20 请求发起时的时间戳,取UTC时间。 格式:yyyyMMddHHmmssSSS periodType O String 10 周期类型。 说明: 非必传,如需此参数,计费类型需选择包周期chargingMode=1,包周期购买场景请求时传该参数 年:"year" 月:"month" chargingMode=3,按次数购买场景请求时不传该参数。 periodNumber O integer 2 周期数量。 说明: 非必传,如需此参数,计费类型需选择包周期chargingMode=1,包周期购买场景请求时传该参数。 周期数量:1,2,3… orderAmount O bigdecimal 20 订单金额。 说明: 该金额为用户实际支付金额,供商家对账参考。 金额值大于等于0,最大三位小数。 单位:元 testFlag O Integer 1 是否调测数据。 1:接口调测数据 不传参数:真实买家同步数据 2018年5月12日新增接口参数:productId和trialToFormal。 2018年5月12日之后发布产品或已发布成功的产品新增规格时,请填写此新参数并通过接口调试(productId为空或者填值,trialToFormal“不传参数”或为“1”都要求调试通过)。 2018年5月12日之前已发布成功的产品,如果不涉及免费试用变更,不要求做接口调试。 请求消息示例: https://example.isv.com?activity=refreshInstance& expireTime=20180725000000&instanceId=03pf80c2bae96vc49b80b917bea776d7&orderId=HWS001014ED483AA1E8&timeStamp=20170725025113409&testFlag=1&authToken=09lsS5y+KCtxBu+ON4TXv1SrjH5KVYka9sx2MauHrQU=
  • 响应参数 表2 响应Body参数 参数 参数类型 描述 access_token String 授权服务器返回给第三方应用的访问令牌。 token_type String 访问令牌类型。固定值:Bearer。 expires_in Long 访问令牌的有效期,以秒为单位。 scope refresh_token String String 授权范围。 refresh_token String 刷新令牌,默认生成,有效期30天。 error String 错误类型。 error_description String 错误描述。 refresh_token有效期设置应比access_token长。
  • 请求参数 表1 FormUrlEncoded参数 参数 是否必选 参数类型 描述 client_id 是 String 应用标识,注册应用后,分配的ClientId。 client_secret 是 String 应用密钥,注册应用后,分配的ClientSecret。(解密后的明文) code 是 String 授权码,认证登录后回调获取的授权码。(code值仅可使用一次) grant_type 是 String 授权类型,固定值:authorization_code。 redirect_uri 否 String 回调地址,注册应用时填写的回调地址。 请求示例 POST {domain_name}/api/v1/oauth2/token Content-Type: application/x-www-form-urlencoded code=z2D...& client_id=NzZeWuiJa91dPSRdZQChMazIh13AW...& client_secret=******...& redirect_uri=https://example.com& grant_type=authorization_code
  • 接口说明 管理员被授权管理某企业后,在买家中心登录,对管理的企业执行新建、编辑、删除部门操作时,云商店调用该接口,请求商家同步该企业的组织增量变更;商家接口需要执行增量组织信息同步,保存信息,并返回通知云商店。 商家的服务器在处理接口请求时,需要做好幂等性处理。 对于同一个实例,相同的租户,相同的orgCode,要支持多次请求新增,或者删除,多次新增不应产生新的数据,且需要返回成功,如果是删除,多次删除也需要返回成功,不能因已删除返回失败,删除时不需要校验(新购商品)接口产生的实例是否存在。
  • 请求方法:POST 接口URL:生产地址+固定子路径,其中固定子路径为/produceAPI/singleOrgSync; 接口示例:生产地址为https://example.isv.com,则接口URL为https://example.isv.com/produceAPI/singleOrgSync Headers请参数 参数 必选 参数类型 描述 authToken M String(255) 签名信息,请参考auth Token取值说明。 BODY请求参数 参数 必选 参数类型 描述 instanceId M String(64) 说明: 卖家申请应用凭证的时候传空,买家必传。 tenantId M String(64) 租户ID,与租户的同步信息保持一致 orgCode M String(64) 部门代码 租户自定义,租户内唯一 orgName M Vachar(128) 部门名称 所在层级唯一,允许租户更新名称 parentCode O String(64) 上级部门的orgCode,如果是顶层部门,这个值为空,其他场景不能为空,允许租户更新当前部门归属的上层部门 flag M Integer(2) 0-删除 1-新增,2-修改 testFlag M Integer(2) 0-生产正式数据 1-调测数据 timeStamp M String 默认时区东8区,时间戳,时间格式:20220420114117642 响应参数 参数 必选 参数类型 描述 resultCode M String(6) 响应码,具体请参见调用结果码说明。 resultMsg O String(255) 响应信息 示例: POST https://example.isv.com/produceAPI/singleOrgSync Connection: keep-alive Content-Type: application/json authToken: "stbNYlu**************2Ubt271qDr6WDAVLtLRb” Host: example.isv.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "instanceId": "hua********23456", "instanceId": "hua********23456", "tenantId": "68cbc********0d92f36422fa0e", "orgCode": "10000", "orgName": "开发部", "parentCode": "", "flag": 1, "testFlag": 0, "timeStamp": "20220413093539534" , } HTTP/1.1 200 OK Body-Sign: sign_type="HMAC-SHA256", signature= "xxxxxxxxxx" Content-Type: application/json { " resultCode": "000000", " resultMsg": "Success" } HTTP Body签名: Body-Sign: sign_type="HMAC-SHA256", signature= "xxxxxxxxxxxxx" ,详情参考《HTTP Body签名》。
  • 响应参数 属性名 类型 属性说明 error String 返回信息【失败时,会记录失败原因】 error_description String 返回码 data JSONObject / user JSONObject 用户信息 id String 用户id user_name String 用户名 name String 姓名 mobile String 手机号 email String 邮箱 role String 角色 organizationName String 组织名称 accName String 登录名称 userId String 用户id organizationCode String 组织编码 loginName String 登录名称 projectName String 租户名称 tenant String 租户id 响应示例 正确示例 { "user": { "id": "20201119181527383-7B3B-0571E338A", "name": "lx4321", "user_name": "lx4321", "mobile": "139******", "email": "******" } } 错误示例 { "error": "The system is busy. Please try again later.", "error_description": "OneAccess.1009" }
  • 请求参数(post Body) 参数名 类型 描述 是否必须 示例值 sso_ticket String 一次性访问凭证 是 ***** operating_sys_version String 调用方操作系统版本 是 windows10.1.1 device_ip String 调用方设备ip 是 192.168.1.1 device_fingerprint String 调用方设备指纹 是 ***** agent String User-Agent信息 否 agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36 请求示例 POST https://bc.bccastle.com/api/v2/tenant/sso/sso-ticket/verify { "sso_ticket":"*****", "operating_sys_version":"windows10.1.1", "device_ip":"192.168.1.1", "device_fingerprint":"*****", "agent":"agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36" }
  • 响应参数 属性名 类型 属性说明 error_msg String 返回信息【失败时,会记录失败原因】 error_code String 返回码 expire Number 过期时间 sso_ticket String 返回的sso_ticket 响应示例 正确示例 { "expire":9600 "sso_ticket":"*****" } 错误示例 { "error_msg": "The system is busy. Please try again later.", "error_code": "OneAccess.1009" }
  • 请求参数(post Body) 参数名 类型 描述 是否必须 示例值 session_token String 登录成功返回的token 是 ****** operating_sys_version String 调用方操作系统版本 是 windows10.1.1 device_ip String 调用方设备ip 是 192.168.1.1 device_fingerprint String 调用方设备指纹 是 ****** agent String User-Agent信息 否 agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36 请求示例 POST https://bc.bccastle.com/api/v2/tenant/sso/session-token/sso-ticket { "session_token":"******", "operating_sys_version":"windows10.1.1", "device_ip":"192.168.1.1", "device_fingerprint":"******", "agent":"agent:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36" }
  • 响应消息 响应参数说明请参见下表: 参数 是否必选 类型 最大字符长度 说明 error_code M String 6 调用结果码。 具体请参见调用结果码说明。 error_msg O String 255 调用结果描述。 错误码: http状态码 error_code error_msg 描述 200 MKT.0000 Success. 请求成功 500 MKT.0999 System internal error. 其它服务内部错误 500 MKT.0100 Failure of input parameter 输入参数校验失败 参数范围超限,非法值或格式错误 400 MKT.0101 Invalid parameter 参数无效 输入非接口定义的参数,多参数或少必选参数 比如:传递非法数值、没有实例id等 400 MKT.0102 Invalid body sign 请求body体签名校验失败 400 MKT.0199 Request parameter error 请求参数错误 其它参数错误 比如:必填参数未传递等 401 MKT.0150 Illegal operation 通常是进行了不被授权的操作,例如instance_id对应的产品不是AK/SK对应的ISV发布的 401 MKT.0151 No authority 无API访问权限 token非ISV角色 401 MKT.0154 Illegal token 鉴权失败 token无效 500 MKT.9001 Instance ID not found. 实例ID不存在(商品续费、过期、资源释放接口可能返回) 500 MKT.9002 Invalid usage enties. 计量实体无效 500 MKT.9003 Usage records extends size limit. 计量记录数超出限制(1000条) 500 MKT.9004 Record beginTime extends Limit. 计量记录的起始时间超出有效期(当前时间21天以内) 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 响应消息示例: { "error_code":"MKT.0000", "error_msg":"success" }
  • 请求方法:GET 参数 是否必选 类型 最大字符长度 说明 activity M String 20 接口请求标识,用于区分接口请求场景。 过期场景取值:expireInstance authToken M String 50 安全校验令牌。 取值请参见authToken取值说明。 instanceId M String 64 实例ID orderId M String 64 新购商品时对应的订单ID。 timeStamp M String 20 请求发起时的时间戳,取UTC时间。 格式:yyyyMMddHHmmssSSS testFlag O Integer 1 是否调测数据。 1:接口调测数据 不传参数:真实买家同步数据 请求消息示例: https://example.isv.com?activity=expireInstance&instanceId=03pf80c2bae96vc49b80b917bea776d7 &timeStamp=20170725025113409&testFlag=1&authToken=09lsS5y+KCtxBu+ON4TXv1SrjH5KVYka9sx2MauHrQU=
共100000条