本文导读

展开导读

文档首页/ 云商店/ 接入指南/ SaaS类商品接入指南V2.0（新商品上架）/ 基础接口描述/ 查询实例信息

查询实例信息

更新时间：2024-06-12 GMT+08:00

查看PDF

接口说明

商家创建完资源后，云商店根据instanceId查询资源实例的信息

查询实例信息流程如下图所示：

点击放大

请求消息

请求参数说明请参见下表：

请求方法：POST

Body参数

参数	是否必选	类型	取值范围	说明
activity	M	String	20	接口请求标识，用于区分接口请求场景。升级场景取值：queryInstance
instanceId	M	String	100	实例ID，支持批量，多个实例批量查询时用逗号分隔，单次最多支持100个实例查询。
testFlag	O	String	2	是否为调试请求。 1：调试请求 0：非调试请求默认取值为“0”。

参数

是否必选

类型

取值范围

说明

activity

String

接口请求标识，用于区分接口请求场景。

升级场景取值：queryInstance

instanceId

String

100

实例ID，支持批量，多个实例批量查询时用逗号分隔，单次最多支持100个实例查询。

testFlag

String

是否为调试请求。

1：调试请求
0：非调试请求

默认取值为“0”。

请求消息示例：

curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=9C61F188C3C2889C2DD201B00E42041BDCE4751F31E35805DE412969F0A7829C&timestamp=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[]		实例详情。

参数

是否必选

类型

取值范围

说明

resultCode

String

调用结果码。

具体请参见调用结果码说明。

resultMsg

String

255

调用结果描述。

info

InstanceInfo[]

实例详情。

InstanceInfo数据结构定义如下：

参数	是否必选	类型及范围	取值范围	参数说明
instanceId	M	String	64	实例id。
appInfo	O	AppInfo	N/A	应用实例信息。客户购买商品后，商家需要返回登录服务地址（网站地址）或免登地址供客户后续操作。说明： SaaS商品必须向客户提供应用使用信息，包括使用地址、账号、密码等。如可实现通过短信、邮件等其他方式发送使用信息，则接口中允许不响应；否则，必须在接口中返回应用实例信息。如使用信息不仅包含使用地址及账号密码，可通过如下memo参数灵活返回其他使用信息或使用说明等。 appInfo数据结构定义请参见下表。

参数

是否必选

类型及范围

取值范围

参数说明

instanceId

String

实例id。

appInfo

AppInfo

N/A

应用实例信息。

客户购买商品后，商家需要返回登录服务地址（网站地址）或免登地址供客户后续操作。

说明：

SaaS商品必须向客户提供应用使用信息，包括使用地址、账号、密码等。

如可实现通过短信、邮件等其他方式发送使用信息，则接口中允许不响应；否则，必须在接口中返回应用实例信息。

如使用信息不仅包含使用地址及账号密码，可通过如下memo参数灵活返回其他使用信息或使用说明等。

appInfo数据结构定义请参见下表。

appInfo数据结构定义如下：

参数	是否必选	类型及范围	取值范围	参数说明
frontEndUrl	M	String	512	前台地址。客户购买商品后，可以访问的网站地址。
adminUrl	O	String	512	管理地址。客户购买商品后，可以访问的管理后台地址。
userName	O	String	128	管理员帐号。
password	O	String	128	管理员初始密码。
memo	O	String	1024	备注。说明：如果备注包含中文内容，请将中文转换成unicode编码，例如：“中文”可以转换成“\u4e2d\u6587”。

响应消息示例：

{
    "resultCode": "000000",
    "resultMsg": "success.",
    "Info": [
        {
            "instanceId": "huaweitest123",
            "appInfo": {
                "frontEndUrl": "https://www.baidu.com",
                "userName": "zhangsan123",
                "password": "zhangsan123",
                "memo": "hvave a test, 测试！"
            }
            ]
  }

父主题： 基础接口描述

上一篇：创建实例

下一篇：更新实例

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

查询实例信息

接口说明

请求消息

响应消息

意见反馈

文档内容是否对您有帮助？

文档反馈