查询实例信息-j9九游会登录
接口说明
商家创建完资源后,云商店根据instanceid查询资源实例的信息。
查询实例信息流程如下图所示:

- 请及时关注商家信息中客服邮箱以及云商店账号绑定的邮箱的通知,收到调用失败通知邮件及时处理接口异常。
- 云商店会对接口异常的情况做监控,如saas商品频繁出现因接口异常的情况,云商店将对该商品做下架处理。
请求方法:post
body参数
|
参数 |
是否必选 |
类型 |
取值范围 |
说明 |
|---|---|---|---|---|
|
activity |
m |
string |
20 |
接口请求标识,用于区分接口请求场景。 查询实例场景取值:queryinstance |
|
instanceid |
m |
string |
100 |
实例id,支持批量,多个实例批量查询时用逗号分隔,单次最多支持100个实例查询。 |
|
testflag |
o |
string |
2 |
是否为调试请求。
|
请求消息示例:
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":"1"}'
响应消息
响应参数说明请参见下表:
|
参数 |
是否必选 |
类型 |
取值范围 |
说明 |
|---|---|---|---|---|
|
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" : "实例id",
"appinfo" : {
"frontendurl" : "https://www.***.com",
"adminurl" : "https://www.*****.com/admin",
"username" : "*****",
"password" : "*****",
"memo" : "have a test, 测试!"
}
}
]
}
// 按需计量场景
{
"resultcode" : "000000",
"resultmsg" : "success.",
"encrypttype" : "1",
"info" : [{
"instanceid" : "按需实例id",
"appinfo" : {
"frontendurl" : "https://www.***.com",
"adminurl" : "https://www.*****.com/admin",
"username" : "*****",
"password" : "*****",
"memo" : "have a test, 测试!"
},
"usageinfo" : [{
"relatedinstanceid" : "按需实例id",
"usagevalue" : "按需用量总和,假设这里填3",
"statisticaltime" : "20221101025113409",
"dashboardurl" : "https://www.baidu.com/dashboard"
}
]
}
]
}
// 一个实例多个用完即停按需套餐包场景
{
"resultcode" : "000000",
"resultmsg" : "success.",
"encrypttype" : "1",
"info" : [{
"instanceid" : "底层按需实例id",
"appinfo" : {
"frontendurl" : "https://www.***.com",
"adminurl" : "https://www.*****.com/admin",
"username" : "*****",
"password" : "*****",
"memo" : "have a test, 测试!"
},
"usageinfo" : [{
"relatedinstanceid" : "底层按需实例id",
"usagevalue" : "底层按需用量,是下面多个包用量的总和,假设这里填3",
"statisticaltime" : "20221101025113409",
"dashboardurl" : "https://www.baidu.com/dashboard"
}
]
}, {
"instanceid" : "包1实例id",
"appinfo" : {
"frontendurl" : "https://www.baidu.com",
"adminurl" : "https://www.baidu.com/admin",
"username" : "huawei",
"password" : "huawei123456",
"memo" : "have a test, 测试!"
},
"usageinfo" : [{
"relatedinstanceid" : "底层按需实例id",
"usagevalue" : "底层按需用量,假设这里填3",
"statisticaltime" : "20221101025113409",
"dashboardurl" : "https://www.baidu.com/dashboard"
}
]
}, {
"instanceid" : "包2实例id",
"appinfo" : {
"frontendurl" : "https://www.baidu.com",
"adminurl" : "https://www.baidu.com/admin",
"username" : "huawei",
"password" : "huawei123456",
"memo" : "have a test, 测试!"
},
"usageinfo" : [{
"relatedinstanceid" : "底层按需实例id",
"usagevalue" : "底层按需用量,假设这里填0",
"statisticaltime" : "20221101025113409",
"dashboardurl" : "https://www.baidu.com/dashboard"
}
]
}
]
}
// 多个实例多个用完即停按需套餐包场景
{
"resultcode" : "000000",
"resultmsg" : "success.",
"encrypttype" : "1",
"info" : [{
"instanceid" : "底层按需1实例id",
"appinfo" : {
"frontendurl" : "https://www.***.com",
"adminurl" : "https://www.*****.com/admin",
"username" : "*****",
"password" : "*****",
"memo" : "have a test, 测试!"
},
"usageinfo" : [{
"relatedinstanceid" : "底层按需1实例id",
"usagevalue" : "底层按需1用量",
"statisticaltime" : "20221101025113409",
"dashboardurl" : "https://www.baidu.com/dashboard"
}
]
}, {
"instanceid" : "底层按需2实例id",
"appinfo" : {
"frontendurl" : "https://www.***.com",
"adminurl" : "https://www.***.com/admin",
"username" : "*****",
"password" : "*****",
"memo" : "have a test, 测试!"
},
"usageinfo" : [{
"relatedinstanceid" : "底层按需2实例id",
"usagevalue" : "底层按需2用量",
"statisticaltime" : "20221101025113409",
"dashboardurl" : "https://www.baidu.com/dashboard"
}
]
}, {
"instanceid" : "包实例id",
"appinfo" : {
"frontendurl" : "https://www.baidu.com",
"adminurl" : "https://www.baidu.com/admin",
"username" : "huawei",
"password" : "huawei123456",
"memo" : "have a test, 测试!"
},
"usageinfo" : [{
"relatedinstanceid" : "底层按需1实例id",
"usagevalue" : "底层按需1用量",
"statisticaltime" : "20221101025113409",
"dashboardurl" : "https://www.baidu.com/dashboard"
},
{
"relatedinstanceid" : "底层按需2实例id",
"usagevalue" : "底层按需2用量",
"statisticaltime" : "20221101025113409",
"dashboardurl" : "https://www.baidu.com/dashboard"
}
]
}
]
}
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨