华为云用户手册

响应示例 状态码： 200 OK 资产使用情况列表。 { "data" : [ { "artifact_id" : "66f6bb97-c70a-43d9-aa73-************", "artifact_name" : "customers", "consumer_user_name" : "paas_roma_l00489135", "consumer_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "consumer_connector_name" : "连接器B", "action_count_list" : [ { "action" : "MODIFY", "count" : 1 }, { "action" : "DOWNLOAD", "count" : 1 }, { "action" : "VIEW", "count" : 2 } ] } ]}

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/audit-logs/artifact-usages 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 artifact_id 否 String 资产ID。 参数校验规则：最小长度1，最大长度50，匹配字母、数字和符号-。 artifact_name 否 String 资产名称。 参数校验规则：只能包含英文字母、数字、下划线、中文及-，并且只能以中文和英文开头，最小长度1，最大长度200。 action 否 String 执行动作过滤： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD start_time 否 String 开始时间。 end_time 否 String 结束时间。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

入门流程 首次使用 云存储 网关服务，建议参考表1逐步操作，创建云上云下数据同步管理的云存储网关。 表1 CS G使用流程简介 操作步骤 操作说明 准备工作 注册华为云，并准备符合要求的本地待部署客户端环境，用于部署网关。 创建网关 在CSG管理控制台新建网关，下载网关安装包。 安装网关 在用户本地客户端安装网关，并获取能连接到浏览器的网关IP。 初始化网关 在CSG管理控制台和用户本地客户端，通过网关IP和访问密钥（AK/SK）连接激活网关，建立CSG管理控制台与用户本地网关的连接。网关激活成功后，在管理控制台设置缓存盘。 创建文件共享 在CSG管理控制台，创建以OBS桶目录为共享源的文件共享，并配置共享权限。 挂载文件共享 在用户本地客户端挂载NFS文件共享。挂载成功后，用户则可将本地操作数据同步上云，无缝管理云上云下数据。

操作步骤 表1 验证项 检查项 操作步骤 新增文件能够同步到OBS中 1、登录挂载NFS文件共享的主机，使用cp命令拷贝测试文件到挂载NFS文件共享的目录。 2、等待5分钟后，登录华为云 对象存储服务 控制台，检查新增文件是否同步到NFS文件共享关联的OBS桶中。 修改文件的内容能够同步到OBS中 1、登录挂载NFS文件共享的主机，使用vim等命令修改测试文件，并保存退出。 2、等待5分钟后，登录华为云对象存储服务控制台，下载测试文件，检查OBS桶中的对应文件是否更新。 删除文件能够同步删除OBS中对应的文件 1、登录挂载NFS文件共享的主机，使用rm命令删除测试文件。 2、等待5分钟后，登录华为云对象存储服务控制台，检查OBS桶中对应文件是否删除。 网关监控数据正常 登录华为云云存储网关控制台，在网关列表，单击名称链接进入网关详情，单击缓存空间使用率右上角的更多监控，查看当前网关的“带宽”、“IOPS”、“内存利用率”等指标是否有监控数据。 数据上云期间，会占用部分带宽用以数据上传。如果您当前使用的华为云专线网络，且该专线同时被用于其他业务，为了不影响该专线上其他业务正常运行，建议您在评估后为云部署网关设置合理的限流带宽。 设置限流带宽流程： (1) 进入CSG控制台网关列表; (2) 单击要设置限流带宽的网关名称； (3) 单击“更多”，单击“编辑”； (4) 设置“限流带宽”值，单位为MB/s，默认值为0不限流； (5) 单击“确认”；稍等一分钟左右即可生效；

操作步骤 以“CSG-gateway_3.19.11.tar.gz”版本安装包为例，说明网关软件安装步骤。 使用PuTTY/FTP等工具登录待部署服务器，以root用户登录待部署服务器，使用SFTP工具将网关软件包和对应的SHA256文件上传到待部署服务器。进入存放“CSG-gateway_3.19.11.tar.gz”的目录，执行以下命令，查看已成功下载的安装包。 ls -ltr 回显信息如下： [root@localhost csg]# ls -ltrtotal 182692-rw-------. 1 root root 99 Apr 26 22:25 CSG-gateway_3.19.11.tar.gz.sha256-rw-------. 1 root root 187071260 Apr 26 22:25 CSG-gateway_3.19.11.tar.gz 执行如下命令校验网关软件包完整性，当回显信息显示OK，表明完整性校验成功。 sha256sum -c CSG-gateway_x.x.x.tar.gz.sha256 回显信息如下： [root@localhost csg]# sha256sum -c CSG-gateway_3.19.11.tar.gz.sha256CSG-gateway_3.19.11.tar.gz: OK 执行以下命令，解压安装包。 tar -zxvf CSG-gateway_x.x.x.tar.gz 回显信息如下： # tar -zxvf CSG-gateway_3.19.11.tar.gzCSG-gateway_3.19.11/CSG-gateway_3.19.11/vars/CSG-gateway_3.19.11/vars/main.ymlCSG-gateway_3.19.11/action/CSG-gateway_3.19.11/action/env.shCSG-gateway_3.19.11/action/uninstall.shCSG-gateway_3.19.11/action/install_all.shCSG-gateway_3.19.11/action/install_rpm.shCSG-gateway_3.19.11/action/stop_all.shCSG-gateway_3.19.11/action/start_all.shCSG-gateway_3.19.11/config/CSG-gateway_3.19.11/manifest.ymlCSG-gateway_3.19.11/repo/CSG-gateway_3.19.11/repo/filegateway-om-1.0.3.20190411175311-1.x86_64.rpmCSG-gateway_3.19.11/repo/filegateway-1.0.3.20190411175311-1.x86_64.rpmYou have mail in /var/spool/mail/root 执行以下命令，查看解压后的安装包。 ls –ltr 回显信息如下： # ls -ltrtotal 191076drwxr-xr-x. 6 root root 78 Apr 11 17:56 CSG-gateway_3.19.11- rw- r--r--. 1 root root 195658900 Apr 11 18:05 CSG-gateway_3.19.11.tar.gzYou have mail in /var/spool/mail/root 进入解压后安装包action文件目录，执行以下命令安装网关所必须的rpm软件包。 sh install_rpm.sh 安装日志回显如下信息，则网关安装成功： # sh install_rpm.sh Install all rpms finished. 如果网关服务器是ECS，安装rpm软件包长时间卡住或者执行失败，建议暂时绑定弹性公网IP，重新执行sh install_rpm.sh命令，完成rpm软件包安装后解绑弹性公网IP即可。 执行以下命令安装网关。 sh appctl.sh install 安装日志回显如下信息，则网关安装成功。 install filegateway success （可选）为了系统安全进行软件安全加固。 执行以下脚本命令，限制root用户使用ssh登录网关服务器。同时选择本地服务器对应IP地址，绑定到系统服务端口。 sh security_reinforce.sh 回显信息如下： [root@gateway ~]# sh {安装包目录}/action/security_reinforce.sh[root@dfv action]# sh security_reinforce.sh-create a new user csgmanager for login startuseradd: warning: the home directory already exists.Not copying any file from skel directory into it.Creating mailbox file: File existsChanging password for user csgmanager.New password:Retype new password:passwd: all authentication tokens updated successfully.-create a new user csgmanager for login end-prohibits the root from logging in through ssh start-prohibits the root from logging in through ssh end-bind IP address startplease specify a local IPv4 address as the manager IP(used by SSH service)option [0] : 111.111.111.111/19option [1] : 222.222.222.222/19select an existing option:0please specify a local IPv4 address as the service IP(used by NFS service)option [0] : 111.111.111.111/19option [1] : 222.222.222.222/19select an existing option:1[warning] you have chosen 111.111.111.111/19 as manager IP , 222.222.222.222/19 as service IP[warning] if bind the wrong IP address may cause the service to be abnormal[warning] enter "yes" to continue, enter others to reselect:yesprocessing...Files are successfully uploaded to the cloud. Time elapsed: 0 minWaiting for the gateway to stop...Command executed successfully.Main gateway process starting.......successfully.Monitoring process starting...successfully.Cache disk activating...successfully.config tomcat server ip 111.111.111.111.bind ntp server ip 111.111.111.111.-bind IP address endexecute end 执行了安全加固命令后，无法使用root账号通过ssh登录服务器。需先使用csgmanager账号通过ssh登录服务器，然后执行“su root”，通过密码认证切换到root用户。 为了系统的安全，建议定期修改csgmanager和root的密码。 在action文件目录下，执行如下命令，启动OM进程，开始使用网关。 sh appctl.sh start OM进程回显如下信息，则网关正常运行。 start filegateway successfully

操作步骤 以root用户登录本地服务器。 挂载前，查看本地服务器系统是否安装NFS客户端。 表1 查询和安装NFS客户端 操作系统 查询命令 回显信息（已安装） 安装命令 Red Hat、Fedora或Oracle Enterprise Linux、Euler OS 2.3 rpm -qa|grep nfs libnfsidmapnfs-utils sudo yum -y install nfs-utils SUSE或OpenSUSE rpm -qa|grep nfs nfsidmap nfs-client zypper install nfs-client Debian或Ubuntu dpkg -l nfs-common nfs-common sudo apt-get install nfs-common 不同操作系统回显信息不同，如果回显表1信息，说明已经成功安装NFS客户端，则执行步骤3；如果未回显表中信息，则需执行表中安装命令安装NFS客户端。 登录客户端执行如下命令，创建本地挂载路径。 mkdir /本地路径 执行如下命令，挂载文件共享。 mount -t nfs -o vers=3,timeo=600,nolock 网关IP:/共享名称 /本地路径 执行如下命令，查看文件共享挂载结果。 df –h 在/etc/rc.local中追加如下加粗部分，确保操作系统重启时，能够自动挂载文件共享。 #!/bin/bash# THIS FILE IS ADDED FOR COMPATIBILITY PURPOSES## It is highly advisable to create own systemd services or udev rules# to run scripts during boot instead of using this file.## In contrast to previous versions due to parallel execution during boot# this script will NOT be run after all other services.## Please note that you must run 'chmod +x /etc/rc.d/rc.local' to ensure# that this script will be executed during boot.touch /var/lock/subsys/localmount -t nfs -o vers=3,timeo=600,nolock 网关IP:/共享名称 /本地路径 挂载成功后，用户可以在客户端使用CSG提供的NFS文件共享服务，进行相应的文件共享操作。

组网要求 客户端可以使用NFS协议通过公网挂载并访问，但是NFS协议传输未加密，出于安全考虑，不建议将本地客户端与云存储网关通过公网互联。推荐用户数据中心网关组网使用以下网络平面： 数据面网络：NFS客户端通过数据面网络将业务数据写入网关。 华为云专线网络：用户本地网关通过云专线（Direct Connect，DC）连接API网关和OBS，接收网关控制台配置命令和上报网关状态、监控数据到控制台，以及业务数据上传到OBS。 云专线需能连接到用户本地网关，并能连接到华为云对象存储服务、云解析服务和API网关服务的网络。 管理面网络：通过管理网络连接网关和配置网关。 NAS存储网络（有条件必选）：当外接NAS作为网关缓存时，网关通过该网络将数据写到NAS存储。

操作步骤 登录CSG管理控制台。 在网关列表选择网关，单击待操作网关名称。 进入当前网关详情页面。 目前一个网关仅支持创建一个文件共享，一个文件共享对应一个桶目录或桶文件夹目录。 单击“创建文件共享”，进入文件共享创建页面，如图1。 图1 创建文件共享 设置共享名称，选择“桶”，输入“名称后缀”。 “桶”：在下拉列表中选择桶，作为文件共享源。因CSG目前仅支持数据上传到标准存储类型的桶，故下拉列表中仅显示未加密的标准存储类型桶。如果桶不存在，需先在OBS创建可用标准存储类型桶，再刷新桶列表选择。创建桶详细操作指导，请参考OBS创建桶。 （可选）“桶内文件夹”：桶中一级或多级文件夹名称，例如：一级文件夹/二级文件夹/....。设置后共享层级到文件夹层，网关读/写该文件夹中存储数据。自定义“名称后缀”允许包含数字、字母，及特殊字符“-”“_”，多层级间以“/”连接，且长度范围为0~64个字符。 “文件共享名称”：文件共享名称由桶名和桶内文件夹组成，格式为“桶名/名称后缀”。共享名称全局唯一，不能与任何已有共享名称重复，且创建成功后不能修改名称，创建时请设置合适的桶名。共享名称创建完成后作为文件共享的虚拟路径。 用户自定义的“桶内文件夹”对应桶中文件夹名称。如果桶中无该名称文件夹，将在桶中生成自定义名称的文件夹。 “文件共享名称”路径下文件的绝对路径总长度不能超过1024字符。 设置用户映射权限，选择“用户权限”。 “用户权限”：通过NFS协议中用户映射，可将客户端虚拟/实际用户或用户组的ID映射给正在对NFS进行读/写操作的用户，这个用户则具有映射用户或用户组ID所允许的权限。 “None”：默认取值，表示所有用户及所属用户组无映射。 “Root_Squash”：表示将Root用户及所属用户组映射为匿名用户或用户组。 “All_Squash”：表示将所有用户及所属用户组都映射为匿名用户或用户组。 （可选）设置客户端读/写权限。输入“只读客户端列表”和“读写客户端列表”。 “只读客户端列表”：只能读取OBS桶中对象的客户端。可输入多个客户端IP，用逗号隔开，支持输入IP、IP段、通配符“*”。 “读写客户端列表”：能读取OBS桶中对象和写入数据到OBS桶中的客户端。可输入多个客户端IP，用英文逗号隔开，支持输入IP、IP段、通配符“*”。 当一个客户端IP被同时设置了只读权限和读写权限时，取最大的权限生效，即有读写权限。 当客户端列表置空，即未设置客户端读/写权限时，禁止所有客户端对共享的OBS桶目录读/写权限。 当客户端列表置*，表示OBS桶目录对所有客户端开放，即所有客户端对共享的OBS桶目录有读/写权限。 确认信息无误后，单击“立即创建”，创建文件共享。

端口要求 为了保障数据安全、防止来自公网的NFS连接，建议运行云存储网关的服务器的端口配置如表2。 表2 端口使用说明 端口 协议 使用说明 22端口 TCP 使用端口通过SSH协议访问CSG管理控制台主机，对用户内部网络内服务器选择性开放。 123端口 UDP NTP客户端地址用于提供时间同步服务。 7443端口 TCP CSG初始配置Web服务端口，通过认证访问密钥（AK/SK）使用端口激活网关，对执行激活网关CSG管理控制台服务器开放。 111，20048端口 TCP/UDP 使用端口连接文件共享，对挂载NFS文件共享的客户端开放。 2049，2051，2052端口 TCP 使用端口连接文件共享，对挂载NFS文件共享的客户端开放。 10000-11023端口 TCP NFS文件锁服务端口，当多客户端文件锁时触发。

在线测试模板操作步骤 点击“执行测试”按钮； 执行测试时，根据商家的模板，开通云资源时会产生一定费用（部署时可查看费用明细），测试完成后，请及时删除已开通的资源，避免产生持续扣费。 进入 RFS 控制台，创建资源栈选择“已有模板”，模板来源选择“URL”； 进入“配置参数”页面，按照页面提示填写配置参数后进入下一页； 进入“资源栈设置”页面，完成资源栈设置； 确认配置参数和资源栈设置无误后，点击创建执行计划； 查看费用明细，如下图所示，此处商家需要确保模板中包含的云资源都能正常询出价格，如果不能正常询出价格，可参考：预估执行计划价格； 如费用明细无误，单击部署后，等待资源部署成功； 部署成功后，即华为云 资源编排 服务RFS完成了应用软件自动部署模板的开发。 本示例创建的云资源需要商家支付相应的费用，当商家不需要这些资源的时候，请删除资源栈并及时删除这些资源。

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

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

获取软件包下载地址 在做应用自动化部署时，商家需要将软件包上传到云商店资产中心，资产的创建和软件包的上传请参考《新增资产操作指导》。 资产创建成功后，商家将获得资产ID、资产类型和资产的版本，如下图所示。 资产ID、资产类型和资产版本将在Terraform模板中使用，商家可以通过Data Sources：huaweicloud_koogallery_assets，查询托管在云商店的软件包，示例代码如下，商家可以在Shell和PowerShell脚本中通过${ software_url_decode }获得软件包的下载地址，获得下载地址后，商家可以下载软件包并进行解压安装。 data "huaweicloud_koogallery_assets" "assets" { asset_id = "asset_id" deployed_type = "software_package" asset_version = "V1.0" }locals { software_url = data.huaweicloud_koogallery_assets.assets.assets[0].software_pkg_deployed_object[0].internal_path software_url_decode = jsondecode("\"${local.software_url}\"") } 父主题： 发布应用资产，上传软件包和模板

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

定义 云商店每次调用商家的接口时会根据一定规则对请求生成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即为访问密钥

举例 商家收到的调用请求数据示例如下： 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"}'

响应参数 表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长。 响应示例 表3 状态码 状态码 描述 200 请求成功。 400 请求错误。 状态码：200 请求成功。 示例1 { "access_token" : "******", "token_type" : "Bearer", "expires_in" : 7200, "scope" : "get_user_info" } 示例2 { "access_token" : "******", "token_type" : "Bearer", "expires_in" : 7200, "scope" : "get_user_info", "refresh_token" : "******" } 状态码：400 请求错误。 { "error" : "invalid_grant", "error_description" : "Invalid authorization code" }

请求参数 表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

接口说明 用户购买联营SaaS类应用后，登录到华为云买家中心控制台，将应用与企业绑定时，云商店调用该接口请求商家同步该企业应用的认证信息，商家接口需要执行应用同步，保存应用信息，并返回通知云商店。 针对应用同步场景接口调用失败的情况，由买家选择是否重试，并用短信或邮件的形式通知商家接口调用失败。 商家的服务器在处理接口请求时，需要做好幂等性处理。 对于同一个实例，相同的租户，相同的应用，要支持多次请求新增，或者删除，多次新增不应产生新的数据，且需要返回成功，如果是删除，多次删除也需要返回成功，不能因已删除返回失败，删除时不需要校验(创建实例)接口产生的实例是否存在 应用同步流程如下图所示：

错误码 表2 错误码 http状态码 resultCode resultMsg 描述 200 MKT.0000 Success. 请求成功 500 MKT.0999 System internal error. 其它服务内部错误 500 MKT.0100 Failure of input parameter 输入参数校验失败 参数范围超限，非法值或格式错误 400 MKT.0101 Invalid parameter 参数无效 输入非接口定义的参数，多参数或少必选参数 400 MKT.0199 Request parameter error 请求参数错误 其它参数错误 401 MKT.0150 Illegal operation 通常是进行了不被授权的操作，例如instanceId对应的产品不是AK/SK对应的商家发布的 401 MKT.0151 No authority 无API访问权限 token非商家角色 401 MKT.0154 Illegal token 鉴权失败 token无效 406 MKT. 0250 Access frequency overlimit 访问频率超限 500 MKT.9001 Instance ID not found. 实例ID不存在（商品续费、过期、资源释放接口可能返回） 500 MKT.9002 Invalid usage enties. 计量实体无效 500 MKT.9003 Usage records extends size limit. 计量记录数超出限制（100条） 500 MKT.9004 Record beginTime extends Limit. 计量记录的起始时间超出有效期（当前时间21天以内） 其中，仅在resultCode为MKT.0100、MKT.0150、MKT.0250、MKT.9001、MKT.9002、MKT.9004、MKT.9005时，失败响应中包含extra_info字段。失败响应中resultMsg除字段描述，还包含响应失败详情。您可以结合失败详情和extra_info内容定位并解决问题。 成功响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "resultCode": "MKT.0000", "resultMsg": "Success", "orderInfo": { "orderId": "CS2207261447AUY4H", "orderType": "NEW", "createTime": "20220726064736", "orderLine": [ { "orderLineId": "CS2207261447AUY4H-000001", "chargingMode": "PERIOD", "periodType": "year", "periodNumber": 1, "expireTime": "20230726155959", "productInfo": [ { "productId": "OFFI758576253042421760", "skuCode": "da9b4d34-ee8a-4355-a823-13e034e49986", "linearValue": 10, "productName": "SaaS测试商品,测试规格,基础版,包周期" } ], "extendParams": [] } ], "buyerInfo": { "mobilePhone": "18699999999", "email": 123@test.com, "customerId": "688055390f3049f283fe9f1aa90f7ds3", "customerName": "hw1235sd3123" } }} 失败响应示例 HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=UTF-8Content-Length: lengthDate: response time { "resultCode": "CBC.0150", "resultMsg": "Illegal operation. param[isvId] and param[instanceId] does not match." }

联营SaaS类商品接入流程介绍 联营SaaS类商品接入云商店概览： 如上图所示，联营SaaS接入分成为2个阶段： Kit对接：商家根据业务所需进行接口调试（参考1.4基础接口描述和1.5联营kit接口描述）； 账号测试：商家在云商店的“卖家中心”进行1.8 接口调试，1.6 应用凭证申请，并获取应用测试账号，完成1.7.4 用户登录接口调测。 对于商家来说，完成接口对接与测试后，可以申请发布联营SaaS产品；本文档涉及Kit对接和验证用户账号登录，关于买家如何完成应用的购买与配置，请参考《联营账号快捷开通流程》。 联营SaaS类商品接入云商店的详细流程如下图所示： 流程说明如下： 申请入驻云商店，成为商家。 云商店运营人员审核公司的资质信息。 准备生产接口服务器，根据本接入指南开发生产接口。 在卖家中心调试生产接口，参考1.8 接口调试。 在卖家中心完成安全 漏洞扫描 。 在卖家中心创建应用凭证，参考1.6 应用凭证申请和修改。 在卖家中心申请测试账号。 WEB场景的界面登录验证。 验证登录成功。 加入联营计划，成为联营商家。 在卖家中心申请发布商品。 云商店运营人员审批通过后，产品发布为联营商品。 在卖家中心自助管理生产接口通知消息。 父主题： 接入流程

登录场景：accesstoken续期 用户登录获得的access_token有效期默认为2小时，refresh_token刷新令牌有效期默认为30天，在用户持续访问应用的情况下，服务端应提供access_token的续期功能。 续期功能内部调用时序图： 接口URL请参考联营能力开放接口的刷新Access Token，示例URL如下： {domain_name}/api/v1/oauth2/token Content-Type:application/x-www-form-urlencoded&client_id=NzZeWuiJa91dPSRdZQChMazIh13AW...&client_secret=******...&refresh_token=******...&grant_type=refresh_token 父主题： 联营账号基于WEB登录

操作步骤 去掉模板中的Region属性 检查模板中的所有resources，去掉region属性，如下图所示。在创建华为云资源的时候，如果不指定Region，将会使用provider级别的Region，更新信息可参考huaweicloud provider的文档； 去掉provider.tf中的Region，最终providers.tf的配置如下： ① // Configure the HuaweiCloud Provider② provider "huaweicloud" {} 动态获取当前Console所在region 华为云的云服务大多是Region级的服务，在创建各种云服务的时候，可能会需要用到Region的地方，此时可以动态的获取Region，如下所示，后续所有需要用到Region的地方可直接引用local.region。 // 查询可用区data "huaweicloud_availability_zones" "az" {}locals { // 获取当前Console所在的Region region = data.huaweicloud_availability_zones.az.region}

状态码 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协议的版本，无法完成处理。 父主题： 接口使用方法

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

响应消息 响应参数说明请参见下表： 参数 是否必选 类型 取值范围 说明 resultCode M String 6 调用结果码。 具体请参见调用结果码说明。 resultMsg O String 255 调用结果描述。 info O InstanceInfo[] N/A 实例详情 InstanceInfo数据结构定义如下： 参数 是否必选 类型及范围 取值范围 参数说明 instanceId M String 64 实例id appInfo O AppInfo N/A 应用实例信息。 客户购买商品后，商家需要返回登录服务地址（网站地址）或免登地址供客户后续操作。 说明： SaaS商品必须向客户提供应用使用信息，包括使用地址、账号、密码等。 如可实现通过短信、邮件等其他方式发送使用信息，则接口中允许不响应；否则，必须在接口中返回应用实例信息。 如使用信息不仅包含使用地址及账号密码，可通过如下memo参数灵活返回其他使用信息或使用说明等。 appInfo数据结构定义请参见下表。 usageInfo O UsageInfo[ N/A 应用实例关联的用量信息，按需和按需套餐包实例需要返回，对应按需套餐包，需要分别返回套餐包关联的所有费用项的用量信息。 appInfo数据结构定义如下： 参数 是否必选 类型及范围 取值范围 参数说明 frontEndUrl M String 512 前台地址。 客户购买商品后，可以访问的网站地址。 adminUrl O String 512 管理地址。 客户购买商品后，可以访问的管理后台地址。 userName O String 128 管理员帐号。 password O String 128 管理员初始密码。 memo O String 1024 备注。 说明： 如果备注包含中文内容，请将中文转换成unicode编码，例如：“中文”可以转换成“\u4e2d\u6587”。 UsageInfo数据结构定义如下： 参数 是否必选 类型及范围 最大字符长度 参数说明 relatedInstanceId O String 64 关联的按需实例ID，当查询按需套餐包实例的用量数据时，还需要返回此用量对应的按需实例id，譬如，当前套餐包包含短信100条和彩信50条，则在查询此套餐包的用量扣减时需要返回两个UsageInfo信息，分别对应短信和彩信的用量信息，relatedInstanceId分别对应短信和彩信按需实例ID usageValue M Double(12,4) 20 使用量具体值，最多支持4位有效小数，对于按需实例，应该是一个总体的累积值，对于按需套餐包实例，应该是套餐包的已用用量信息 statisticalTime M String 20 使用量统计时间，取UTC时间。 格式：yyyyMMddHHmmssSSS dashboardUrl O String 512 用量详细查看看板地址。 客户购买按需或按需套餐包商品后，可以在这个平台查看具体的用量信息。 响应消息示例： { "resultCode" : "000000", "resultMsg" : "success.", "encryptType" : "1", "info" : [{ "instanceId" : "ebc28eb6-4606-4098-b4bd-c201c99a0654", "appInfo" : { "frontEndUrl" : "https://www.***.com", "adminUrl" : "https://www.*****.com/admin", "userName" : "*****", "password" : "*****", "memo" : "have a test, 测试！" }, "usageInfo" : [{ "relatedInstanceId" : "ebc28eb6-4606-4098-b4bd-c201c99a0654", "usageValue" : "0.12", "statisticalTime" : "20221101025113409", "dashboardUrl" : "https://www.baidu.com/dashboard" } ] }, { "instanceId" : "fe28e27e-1157-4105-8592-24cc9488db10", "appInfo" : { "frontEndUrl" : "https://www.***.com", "adminUrl" : "https://www.***.com/admin", "userName" : "*****", "password" : "*****", "memo" : "have a test, 测试！" }, "usageInfo" : [{ "relatedInstanceId" : "fe28e27e-1157-4105-8592-24cc9488db10", "usageValue" : "2042", "statisticalTime" : "20221101025113409", "dashboardUrl" : "https://www.baidu.com/dashboard" } ] }, { "instanceId" : "92df74e4-163e-4e0b-a206-d9800d33881b", "appInfo" : { "frontEndUrl" : "https://www.baidu.com", "adminUrl" : "https://www.baidu.com/admin", "userName" : "huawei", "password" : "huawei123456", "memo" : "have a test, 测试！" }, "usageInfo" : [{ "relatedInstanceId" : "ebc28eb6-4606-4098-b4bd-c201c99a0654", "usageValue" : "3309", "statisticalTime" : "20221101025113409", "dashboardUrl" : "https://www.baidu.com/dashboard" }, { "relatedInstanceId" : "fe28e27e-1157-4105-8592-24cc9488db10", "usageValue" : "3309", "statisticalTime" : "20221101025113409", "dashboardUrl" : "https://www.baidu.com/dashboard" } ] } ]}

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