- 云商店介绍
-
接入指南
-
商品接入相关接口
- SaaS类商品接入指南 V2.0(新商品上架)
- SaaS类商品接入指南 V1.0(已下线)
- 联营License类授权码商品接入指南(2.0版本)
- 联营License类商品接入指南(已下线)
- 自动部署接入指南
- 联营License客户端软件对接指南
- 商品交易相关接口
-
商品接入相关接口
- 用户指南
-
商家指南
- 为什么要加入云商店
- 商家入驻
- 商品发布
- 商品交易
- 商家结算
- 店铺运营
- 政策与权益
- 中资出海
-
商家常见问题
- 商家入驻相关问题
- 联营计划相关问题
-
商品发布相关问题
- 如何在云商店发布商品
- 如何发布多SKU定价规格
- 商品发布申请提交后,审核需要多久
- 如何判断发布的商品对应云商店上的哪种商品接入类型
- 云商店商品上架的使用有效期
- 新商品发布时,“商品说明”中能否插入图片
- 为什么在商品发布页面没有发布联营商品按钮
- 如何创建SaaS按需规格和按需套餐包
- 如何补充商品交付模板
- 商品名称发布说明
- 商品logo、商品主图与视频、商品简介、商品说明发布说明
- 联营商品服务支持条款发布说明
- 通用商品服务协议发布说明
- 服务与支持、使用指南发布说明
- 软件著作权证书发布说明
- 通用商品规格发布说明
- 联营商品规格对照报价单填写说明
- 联营服务流发布说明
- 生产接口地址、安全漏洞扫描、关联应用发布说明
- 如何发布SaaS类商品试用规格
- 云商店镜像资产无法选择到已创建私人镜像的原因
- 商品管理相关问题
- 服务监管相关问题
- 结算相关问题
- 协议与规范
- 客户服务商指南
- 平台规范与通知
- 文档下载
- 通用参考
链接复制成功!
查询实例信息
接口说明
商家创建完资源后,云商店根据instanceId查询资源实例的信息。
查询实例信息流程如下图所示:
请求方法:POST
Body参数
参数 |
是否必选 |
类型 |
取值范围 |
说明 |
---|---|---|---|---|
activity |
M |
String |
20 |
接口请求标识,用于区分接口请求场景。 升级场景取值:queryInstance |
instanceId |
M |
String |
100 |
实例ID,支持批量,多个实例批量查询时用逗号分隔,单次最多支持100个实例查询。 |
testFlag |
O |
String |
2 |
是否为调试请求。
默认取值为“0”。 |
请求消息示例:
curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=9C61F188C3C2889C2DD201B00E42041BDCE4751F31E35805DE412969F0A7829C×tamp=1680508237508&nonce=9FB42E04DF4594B1FAA50B304E647AD7154AB9B4F144A65F1168886540A8B24C' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"queryInstance","instanceId":"10e758d0-31ad-4c4b-8f1b-81d03469a10e","testFlag":"0"}'
响应消息
响应参数说明请参见下表:
参数 |
是否必选 |
类型 |
取值范围 |
说明 |
---|---|---|---|---|
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" } ] } ] }