华为云用户手册

请求消息 请求参数 请求方法：GET 参数 是否必选 参数类型 取值范围 描述 orderId M String 64 云商店订单ID orderLineId O String 64 云商店订单行ID 需要对mkt.myhuaweicloud.com HTTPS证书进行强校验，不能忽略证书校验，从而保证调用的是真实而非伪造的云商店服务。 请求示例 GET /api/mkp-openapi-public/global/v1/order/query?orderId= CS 2207261447AUY4H&orderLineId=CS2207261447AUY4H-000001 Host: Host Server Content-Type: application/json charset=UTF-8 X-Sdk-Date: request time Authorization: authorization

公共响应消息头参数 表1 公共响应消息头 名称 描述 示例 Date HTTP协议标准报头。表示消息发送的时间，时间的描述格式由rfc822定义。 Mon, 12 Nov 2007 15:55:01 GMT Server HTTP协议标准报头。包含了服务器用来处理请求的软件信息。 Nginx Content-Length HTTP协议标准报头。用于指明实体正文的长度，以字节方式存储的十进制数字来表示。 xxx Content-Type HTTP协议标准报头。用于指明发送给接收者的实体正文的媒体类型。 application/json 父主题： 公共参数

公共请求消息头参数 表1 公共请求消息头 名称 描述 是否必选 示例 x-sdk-date 请求的发生时间，格式为：yyyyMMdd'T'HHmmss'Z'。 取值为当前系统的GMT时间。 否 使用AK/SK认证时必选 20160629T101459Z Authorization 签名认证信息 该值来源于请求签名结果。 请参考构造请求方法。 否 使用AK/SK认证时必选 - Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时必选 mkt-euro.myhuaweicloud.com Content-type 发送的实体的MIME类型。 是 application/json 父主题： 公共参数

状态码 HTTP响应状态码如表1所示。 表1 HTTP响应状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 接口使用方法

状态行 状态行格式如下： HTTP-Version Status-Code Reason-Phrase CRLF HTTP-Version：表示服务器HTTP协议的版本号。 Status-Code：表示服务器发回的响应状态代码。 状态代码有三位数字组成，第一个数字定义了响应的类别，且有五种可能取值： 1xx：指示信息，表示请求已接收，继续处理。 2xx：成功，表示请求已被成功接收、理解、接受。 3xx：重定向，要完成请求必须进行更进一步的操作。 4xx：客户端错误，请求有语法错误或请求无法实现。 5xx：服务器端错误，服务器未能实现合法的请求。 Reason-Phrase：表示状态代码的文本描述。

请求行 请求行以一个方法符号开头，以空格分开，后面跟着请求的URI和协议的版本，格式如下： Method Request-URI HTTP-Version CRLF Method：表示请求方法（所有方法全为大写），各个方法的解释如下： GET：请求获取Request-URI所标识的资源。 POST：在Request-URI所标识的资源后附加新的数据。 PUT：请求服务器存储一个资源，并用Request-URI作为其标识。 DELETE：请求服务器删除Request-URI所标识的资源。 Request-URI：是一个统一资源标识符。 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。URI中“{}”中包含的内容为URI的参数，其中“?”之前的部分是路径参数，之后的部分是查询参数。HTTP-Version：表示请求的HTTP协议版本。 CRLF：表示回车和换行（除了作为结尾的CRLF外，不允许出现单独的CR或LF字符）。

常见问题 1、通过自动部署交付能使用折扣优惠和券吗？ 可以，自动部署时通过自动支付方式购买的云资源，自动支付时支持使用折扣优惠、代金券、储值卡和现金券，使用顺序如下： 折扣优惠（每次只能使用一项）→代金券（每次只能使用一张）→现金券或储值卡（每次可使用多张，可同时使用）→账户余额（先扣现金额度后扣信用额度）或月末结算（硬件订单除外） 若自动支付时，系统匹配到折扣优惠、代金券、储值卡和现金券都满足要求，则可按使用顺序同时使用。更多信息请参考《自动支付》。 2、License商品对接了自动部署以后，会影响现有的License下单吗? 不影响，License商品对接自动部署以后，只在订单确认页多了一些提示信息，其他的均和非自动部署商品下单一致。 3、License商品对接了自动部署以后，影响服务监管吗？ 不影响，自动部署和服务监管是解耦的。如果商品支持自动部署，客户购买完成以后，在已购服务列表会展示“启动部署”的入口，如下图所示，客户可以选择使用自动部署，也可以选择按照之前的方式，联系ISV，由ISV进行交付。 4、License商品对接自动部署，需要重新发布一个License商品吗？ 不需要，只需要为支持自动部署的规格关联资产即可，如下图所示。更多信息请参考《自动部署接入指南》。 父主题： 自动部署接入指南

生成AK、SK 注册并登录云商店，单击云商店首页右上角的“卖家中心”，进入卖家中心后台。 单击卖家中心左上角的“控制台”，进入管理控制台。 单击页面右上角的用户名，在下拉列表中单击“我的凭证”，进入“我的凭证”页面。 单击页面左侧导航中的“管理访问密钥”，进入“访问密钥”页面。 单击“新增访问密钥”，进入“新增访问密钥”页面。 输入短信验证码，单击“确定”，下载密钥，请妥善保管，丢失后将无法找回。 父主题： 获取AK/SK认证

接口调用流程 接口调用的流程为： 获取AK/SK认证 调用接口前，请获取请求认证，并将认证字段填充至下一步中的方法中，进行请示构建，实现请求的认证。 调用接口采用AK/SK认证方式。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。 通过API网关向下层服务发送请求时，必须使用AK(Access Key ID)、SK(Secret Access Key)对请求进行签名。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 构造请求方法。 填充请求参数构建请求方法。 发起请求。 解析消息响应。 父主题： 接口使用方法

使用方法 华为云API符合RESTful API设计理论。 REST从资源的角度观察整个网络，分布在各处的资源由URI（Uniform Resource Identifier）确定，客户端的应用通过URL（Unified Resource Locator）获取资源。 URL的一般格式为：https://Endpoint/uri。 URL中的参数说明如表1所示。 表1 URL中的参数说明 参数 描述 Endpoint 云商店的Endpoint为“mkt.myhuaweicloud.com”和“mkt.myhuaweicloud.com”。 uri 资源路径，也即API访问路径。从具体接口的URI模块获取，例如“v1.0/{partner_id}/billing/bill-mgr/push-usage-data”。 其中，uri中的用户标识参数说明如下： 使用“partner_id”标识，表示该接口只能使用合作伙伴（ISV）自身的AK/SK或者Token调用。 华为云接口采用HTTP传输协议，有如下约束条件： 请求/响应报文使用JSON报文UTF-8字符集编码。 媒体类型表示为Application/json。 可选参数在消息体中可以不编码。 接口请求参数和响应参数中时间格式统一为UTC时间（包括时区），格式为yyyyMMdd'T'HHmmss'Z'。 其中，HH范围是0～23，mm和ss范围是0～59。 父主题： 接口使用方法

概念介绍 ISCDesk ISCDesk（Industrial Software Cloud Desktop），工业软件 云桌面 工具管理客户端，提供工具软件的一键下载、安装、打开、更新和卸载功能。 ISV ISV（Independent Software Vendor），独立软件开发商，是具有区域和行业属性的软件类合作伙伴。此处指云商店商家，是指经过有效申请并经过华为同意，通过云商店向用户销售及提供基于云计算，大数据业务的软件，镜像以及服务的企业。

调用结果码说明 模块 结果码 结果码说明 公共 000000 成功 000001 鉴权失败 000002 请求参数不合法 000003 实例ID不存在（更新实例、更新实例状态、释放实例接口可能返回） 000004 请求处理中 000005 其它服务内部错误 创建实例 000100 无可用实例资源分配 异步申请License 000900 该实例当前生效订单可用License额度不足 000901 请在当前订单有效日期区间内申请License 000902 包周期License必须输入失效日期 000903 申请License必须输入设备指纹或硬件识别编码 父主题： 在线开通License接入指南

举例 商家收到的调用请求数据示例如下： curl -X POST -H 'Content-Type: application/json' 'https://www.isvwebsite.com/saasproduce?signature=af71c5a7ef45310b8dc05ab15f********379ebaa5eb61155c0×tamp=1666677988730&nonce=RLLUammMSInlrNWb' --data '{"activity":"newInstance","buyerInfo":{"customerId":"688055*******f1aa90f1858","customerName":"CBC_marketplace_mw*******1","userId":"1e8**********7df834e4fe","userName":"CBC_marketplace_********1","mobilePhone":"1865********","email":"********@huawei.com"},"orderInfo":[{"businessId":"8a2************88-f41090522646","orderId":"CS**********","trialFlag":"0","orderAmount":12.78,"chargingMode":"PERIOD","periodType":"month","periodNumber":5,"provisionType":1,"productInfo":[{"skuCode":"a63ee5c9-4f86-11ed-9f95-fa163e8cb3b2","productId":"OFFI7889636**********8","linearValue":20}],"createTime":"20221024194509","expireTime":"20221224194509","extendParams":[{"name":"emailDomainName","value":"test.xxxx.com"},{"name":"extendParamName","value":"extendParamValue"}]}],"testFlag":"1"}'

定义 云商店每次调用商家的接口时会根据一定规则对请求生成signature，并且将signature通过URL PA RAM S的方式添加到URL上，商家在接收到请求后需要同样的规则对请求体进行重新计算signature，并且与云商店传递的signature相比较，完全相同即为校验通过，通过URL PARAMS传递的参数有： 参数 取值 描述 signature String 加密签名，通过一定的规则对请求进行签名产生的值。 timestamp Long UNIX 时间戳（单位秒），商家需要校验这个时间戳与当前时间相差不超过60s。 nonce String 随机字符串，云商店在每次调用时会随机生成，商家可以通过对这个随机数的缓存来防御API重放攻击。

生成规则 对请求参数排序，根据参数名自然排序，例如，以字母a开头的参数名会排在以b开头的参数后面，如果首字母相同，将会对第二个字母进行排序，以此类推，直到字符串结束 获取规范请求字符串，规则： canonicalRequest = accessKey + nonce + timestamp + Lowercase(HexEncode(HMAC_SHA256 (RequestPayload))) 根据规则对规范请求字符串，密钥取signature值，规则： signature = HexEncode(HMAC_SHA256(canonicalRequest)) 注意：accessKey即为访问密钥

接口调用场景 创建实例：客户购买商品并付款成功。 云商店将调用创建实例接口通知商家根据订单号创建实例。 商家系统收到该请求信息，需调用云商店查询订单接口，获取本次订购的相关信息，执行新购对应动作。 更新实例：客户试用转正、续费、退续费。 云商店将调用更新实例接口，通知商家系统对相应资源变更过期时间，商家本地系统需执行相应动作，并将执行结果返回给云商店。 更新实例状态：用户资源实例因到期、违规等情况下会对用户的实例进行冻结，同时在用户续费后，或资源解除违规后会对用户的实例进行解锁。 云商店将调用更新实例状态接口，通知商家系统对相应资源执行冻结、解冻操作，并将执行结果返回给云商店。 用户订单到期后，有 15天的资源冻结期，冻结期内资源不可使用，但可以对此订单续费以解冻继续使用，故商家需对在线开通License商品设置15天的冻结期，并在冻结期内保留用户数据。 释放实例：用户释放购买产品的实例时（到期不续费、退订等场景）。 云商店将调用释放实例接口，通知商家系统对相应资源执行释放操作，并将执行结果返回云商店。

Sdk::CheckNewVersions 场景描述 升级信息查询函数，由工业软件调用。工业软件查询升级信息时，调用此函数，向ISCDesk查询是否存在升级版本。查询成功后会触发“EVENT_UPGRADENOTICE”事件，将升级信息告知工业软件。 升级信息样例如下： {"operate":"UpgradeNotice","params":{"available":"false"},"comeBackParams":{}} “available”字段表示是否存在可升级版本，字段值为“true”表示存在可升级版本；字段值为“false”表示不存在可升级版本。 当存在可升级版本时，ISCDesk会弹窗提示是否升级。若选择升级，则触发“EVENT_UPDATE”升级事件，将升级事件连同升级信息一同告知工业软件，工业软件可自行决定是否退出升级或继续使用。 升级信息（强制升级）样例如下： {"operate":"Update","params":{"fromForceWin":"true"},"comeBackParams":{}} “fromForceWin”字段表示升级类别，当前包含非强制升级和强制升级两种类别。 “fromForceWin”字段值为“false”，表示非强制升级。工业软件可选择是否升级并通知ISCDesk，如果工业软件选择升级，则ISCDesk会在工业软件关闭后进行升级。 “fromForceWin”字段值为“true”，表示强制升级。工业软件无法选择是否升级，ISCDesk会在工业软件关闭后进行升级。 当工业软件选择升级或存在强制升级信息时，建议工业软件执行保存并退出操作。 涉及接口 Sdk::CheckNewVersions 调用示例 ResultStatus CheckNewVersions(); 父主题： 升级相关

License相关 在进行License验证时，需要收集用户设备指纹信息，包括MAC地址、硬盘序列号、主板序列号和CPU序列号。设备指纹最大长度限制为5K字节。 设备指纹字符串拼接时，各参数之间以“|”号分割，获取不到时就为空。获取到的MAC地址和硬盘序列号有多个时，以英文“,”号分隔。字符串拼接完成后，转换为大写。字符串拼接如下： string='${macAddr}|${diskId}|${boardId}|${cpuId}'.toUpperCase(); 设备指纹示例：04:7C:16:5E:E3:5D|001B_444A_488B_5CEC.||BFEBFBFF00090672 Sdk::GetLicenseStringRequest Sdk::GetLicenseFileRequest Sdk::LicenseVerifyNotify 父主题： 管理在云

前提条件 在gitee中将SDK开源源码下载至本地，代码仓地址为https://gitee.com/HuaweiCloudDeveloper/huaweicloud-dme-iscdesk-cpp/tree/master-dev/。 当前提供两种方式获取SDK开源源码（注意：请选择“master-dev”分支代码）： 将“huaweicloud-DME-ISCDesk-cpp”代码仓克隆至本地。 将“huaweicloud-DME-ISCDesk-cpp”代码压缩包下载至本地。

接入流程 工业软件云License联营商品接入云商店的流程如下图所示： 图1 工业软件云License联营商品接入云商店流程 流程说明如下： 申请入驻云商店，成为商家。 云商店运营人员审核公司的资质信息。 根据工业软件云平台的商品接入规范进行应用改造。 准备生产接口服务器，根据本接入指南开发生产接口。 在卖家中心申请访问密钥。 将开发好的生产接口地址绑定访问密钥、并调测成功保存。 调测云商店查询订单、字符串/文件流上传接口。 在卖家中心发布应用资产。 工业软件云平台运营在海顿平台测试应用资产。 云商店运营审核应用资产上架。 在卖家中心申请联营认证。 云商店运营审核联营认证。 在卖家中心申请发布在线开通License联营商品。 云商店运营审核联营商品上架。 运营审核通过后商品上架成功，并在卖家中心自助管理生产接口通知消息。 父主题： 联营License客户端软件对接指南

响应消息 响应参数说明请参见下表： 参数 是否必选 类型 取值范围 说明 resultCode M String 6 调用结果码。 000000：表示资源同步开通 000004：表示资源异步开通 具体请参见《调用结果码说明》。 resultMsg O String 255 调用结果描述。 请及时关注商家信息中客服邮箱以及云商店账号绑定的邮箱的通知，收到调用失败通知邮件及时处理接口异常。 云商店会对接口异常的情况做监控，如商品频繁出现因接口异常的情况，云商店将对该商品做下架处理。 响应消息示例： { "resultCode":"000000", "resultMsg":"success." }

请求消息 请求参数说明请参见下表： 请求方法：POST 参数 是否必选 类型 取值范围 说明 activity M String 20 接口请求标识，用于区分接口请求场景。 异步申请License场景取值：getLicenseAsync instanceId M String 64 业务资源实例ID effectiveTime M String 32 License生效utc时间 expireTime O String 32 License失效utc时间，包周期类型必输 eventId M String 64 云商店业务流水号，用于商家服务器结合设备指纹，区分是否是同一次申请License的请求，支持License传输中断等业务需要重试的场景 deviceFingerprint O String 1024 设备指纹或硬件识别编码，用于需要绑定设备物理标识信息生成License的场景 testFlag O String 2 是否为调试请求。 1：调试请求 0：非调试请求 默认取值为“0”。 请求消息示例： curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=11C4C*********31DEF5C515*******B8A3A6D8******7A48×tamp=1680508066618&nonce=50D83FDECAED6CCD8EF597F2A577950527928BA287D04E6036E92B2806FD17DA' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"getLicenseAsync","eventId":"8****e5694*****c8","instanceId":"RA2****4LVS","effectiveTime":"2023-10-27 10:30:15 z","expireTime":"2024-10-27 10:30:15 z","deviceFingerprint":"8******6034e2*****60e1"}'

接口说明 用户通过云商店向商家申请License。 请及时关注商家信息中客服邮箱以及云商店账号绑定的邮箱的通知，收到调用失败通知邮件及时处理接口异常。 云商店会对接口异常的情况做监控，如商品频繁出现因接口异常的情况，云商店将对该商品做下架处理。 云商店服务有可能重发请求，针对同一请求，商家的服务器应当返回相同的License，不应该创建新的License，返回之前成功创建的License即可。 申请License流程如下图所示： 上传License流程如下图所示：

响应消息 响应参数说明请参见下表： 参数 是否必选 类型 取值范围 说明 resultCode M String 6 调用结果码。 具体请参见《调用结果码说明》。 resultMsg O String 255 调用结果描述。 请及时关注商家信息中客服邮箱以及云商店账号绑定的邮箱的通知，收到调用失败通知邮件及时处理接口异常。 云商店会对接口异常的情况做监控，如商品频繁出现因接口异常的情况，云商店将对该商品做下架处理。 响应消息示例： { "resultCode":"000000", "resultMsg":"success." }

请求消息 请求参数说明请参见下表： 请求方法：POST 参数 是否必选 类型 取值范围 说明 activity M String 32 接口请求标识，用于区分接口请求场景。 过期场景取值：releaseInstance instanceId M String 64 实例ID orderId O String 64 退订商品触发的释放实例场景下会传递退订订单ID orderLineId O String 64 云商店订单行ID。 testFlag O String 2 是否为调试请求。 1：调试请求 0：非调试业务 默认取值为“0”。 请求消息示例： curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=C4E5F264C92F737DEBECB***********80202B59027CEEFC4932×tamp=1680509885590&nonce=A49E8F86EE5BCAFBDFD3E53F1E09A29C6D9E8DACC67382EBCDD02CD55CBBB7AE' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"releaseInstance","instanceId":"10e758d0**********-81d03469a10e","orderId":"CS22111********VS","orderLineId":"CS221118*******S-000001","testFlag":"0"}'

请求消息 请求方法：POST 请求参数说明请参见下表： 参数 是否必选 类型 取值范围 说明 activity M String 32 接口请求标识，用于区分接口请求场景。 更新实例状态场景取值：updateInstanceStatus instanceId M String 64 实例ID status M String 32 变更状态： FREEZE：冻结 UNFREEZE：解冻 testFlag O String 2 是否为调试请求。 1：调试请求 0：非调试业务 默认取值为“0”。 请求消息示例： curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=95DD9FA6A8C***********5290919BCA3F78B9A254428A692CDF26E×tamp=1680509558159&nonce=9F26B85CAEB3A8439221BA293E9250BC5EA689225B523C291EA75CC76B469510' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"updateInstanceStatus","instanceId":"10e75*********1b-81d03469a10e","status":"FREEZE","testFlag":"1"}'

请求消息 请求参数说明请参见下表： 请求方法：POST 参数 是否必选 类型 取值范围 说明 activity M String 20 接口请求标识，用于区分接口请求场景。 续费场景取值：refreshInstance scene M String 64 场景，触发实例变更的场景： TRIAL_TO_FORMAL：试用转正 RENEWAL：续费 UNSUBSCRIBE_RENEWAL_PERIOD：退续费 orderId M String 64 云商店订单ID， 试用转正时传递转正订单ID 续费时传递当前续费订单ID 退续费时传递需要退订的续费订单ID orderLineId M String 64 云商店订单行ID。 instanceId M String 64 实例ID。 productId O String 64 产品标识，租户续费或转正产品实例时，如果订购周期类型发生变化，会传入变化后的产品类型对应的productId。 expireTime M String 20 过期时间。 格式：yyyyMMddHHmmss testFlag O String 2 是否为调试请求。 1：调试请求 0：非调试请求 默认取值为“0”。 请求消息示例： curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=3F6E6652B7BE26B27ABFC3D112***********20174FE8DE062×tamp=1680509496350&nonce=8BF8496A350E37BDB0E8956D39D433ED417C3FC9459DCFFE7F03BFBF69B12085' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"refreshInstance","expireTime":"20221124023618256","instanceId":"10e758d0-31ad********03469a10e","orderId":"CS2211*******VS","orderLineId":"CS221******000001","productId":"OFFI461******240","scene":"RENEWAL","testFlag":"0"}'

接口说明 按周期售卖的商品，用户试用转正、续费、退续费后，云商店调用该接口，更新实例的到期日期。 客户商品转正、续费下单或退订续费周期后，云商店将调用该接口请求商家执行业务变更，商家接口需要执行将到期日进行更新，并返回通知云商店。 商家需要保障更新实例接口通畅，如调用失败，将可能导致用户的业务被释放的风险。 请及时关注商家信息中客服邮箱以及云商店账号绑定的邮箱的通知，收到调用失败通知邮件及时处理接口异常。 云商店会对接口异常的情况做监控，如商品频繁出现因接口异常的情况，云商店将对该商品做下架处理。 商品更新实例流程如下图所示：

请求消息 请求参数说明请参见下表。云商店会结合商家创建上架的商品售卖模式来对应请求，商家也需要根据请求的信息来对应执行生产。 请求方式：POST 参数 是否必选 参数类型 最大字符长度 说明 activity M String 20 接口请求标识，用于区分接口请求场景。 新购场景取值：newInstance orderId M String 64 云商店订单ID。 orderLineId M String 64 云商店订单行ID。 businessId M String 64 云商店业务ID。 每一次请求，businessId皆不一致。 testFlag O String 2 是否为调试请求。 1：调试请求 0：非调试请求 默认取值为“0”。 请求消息示例： curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=11C4CD6279191DE931DEF5C51531DFFA9D37969F4E356B**********8×tamp=1680508066618&nonce=50D83FDECAED6CCD8EF597F2A577950527928BA287D04E6036E92B2806FD17DA' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"newInstance","businessId":"87b947**********-69420d60e3c8","orderId":"CS221118******","orderLineId":"CS22111********-000001","testFlag":"0"}'

响应消息 响应参数说明请参见下表： 参数 是否必选 类型 取值范围 参数说明 resultCode M String 6 调用结果码。 000000：表示资源同步开通 000004：表示资源异步开通 具体请参见《调用结果码说明》。 说明：如果创建实例耗时较长，建议返回0000004，云商店后续会通过查询实例信息接口查询实例开通结果 resultMsg O String 255 调用结果描述。 instanceId M String 64 实例ID 响应消息示例： { "resultCode":"000000", "resultMsg":"success." , "instanceId":"03pf80c2bae96vc49*********" }