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

查询实例信息

接口说明

  • 按次或包周期商品非必选调测接口,按需和按需套餐包商品必选。
  • 用户在购买了商品后需要查询所购买的商品实例信息,对于按需商品,还需要实时返回当前用户的按需用量信息 。
  • 用户如果购买了按需套餐包,还需要通过这个接口返回套餐包的用量信息。

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

请求消息

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

请求方法:GET

参数

是否必选

类型

最大字符长度

说明

authToken

M

String

50

安全校验令牌。

取值请参见authToken取值说明

activity

M

String

20

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

查询实例场景取值:queryInstance

timeStamp

M

String

20

请求发起时的时间戳,取UTC时间。

格式:yyyyMMddHHmmssSSS

instanceId

M

String

64

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

testFlag

O

String

2

是否为调试请求。

  • 1:调试请求
  • 0:非调试业务

默认取值为“0”。

请求示例:

https://example.isv.com?activity=queryInstance&instanceId=ebc28eb6-4606-4098-b4bd-c201c99a0654%2Cfe28e27e-1157-4105-8592-24cc9488db10%2C92df74e4-163e-4e0b-a206-d9800d33881b&testFlag=1&timeStamp=20230327065233980&authToken=Eh%2F3Ud%2BR1j3d%2FwOui5CAcvRipM8IuribvgkXfJAsTfE%3D

响应消息

响应参数说明请参见下表:

表1 响应参数表

参数

是否必选

类型

最大字符长度

说明

resultCode

M

String

6

调用结果码。

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

resultMsg

O

String

255

调用结果描述。

encryptType

O

String

3

敏感信息加密算法

1:AES256_CBC_PKCS5Padding(默认值)

2:AES128_CBC_PKCS5Padding

说明:

敏感信息加密算法是AES256_CBC_PKCS5Padding时返回值为1;

敏感信息加密算法是AES128_CBC_PKCS5Padding时返回值为2;

info

O

InstanceInfo[]

/

实例详情

InstanceInfo数据结构定义如下:

表2 响应参数表

参数

是否必选

类型及范围

最大字符长度

参数说明

instanceId

M

String

64

实例id

appInfo

O

AppInfo

N/A

应用实例信息。

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

说明:

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

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

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

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

usageInfo

O

UsageInfo[]

N/A

应用实例关联的用量信息,按需和按需套餐包实例需要返回,对应按需套餐包,需要分别返回套餐包关联的所有费用项的用量信息

AppInfo数据结构定义如下:

表3 响应参数表

参数

是否必选

类型及范围

最大字符长度

参数说明

frontEndUrl

M

String

512

前台地址。

客户购买商品后,可以访问的网站地址。

adminUrl

O

String

512

管理地址。

客户购买商品后,可以访问的管理后台地址。

userName

O

String

128

加密后的管理员账号。

客户购买商品后,访问商家管理后台的账号(一般为邮箱和手机号)。该值由16位iv加密向量和base编码后的用户名密文组成。

iv+base64(AES_CBC(accessKey,userName))

需要使用Key值对账号做加密处理,加密算法以encryptType参数为准。代码示例请参见ISV Server对资源开通后的用户名和密码加密

password

O

String

128

加密后的管理员初始密码。

客户购买商品后,访问商家管理后台的密码(一般由商家生成)。该值由16位iv加密向量和base编码后的密码密文组成。

iv+base64(AES_CBC(accessKey,pwd))

需要使用Key值对密码做加密处理,加密算法以encryptType参数为准。代码示例请参见 ISV Server对资源开通后的用户名和密码加密

memo

O

String

1024

备注。

如果备注包含中文内容,请将中文转换成unicode编码,例如:“中文”可以转换成“\u4e2d\u6587”。

UsageInfo数据结构定义如下:

表4 响应参数表

参数

是否必选

类型及范围

最大字符长度

参数说明

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.baidu.com",
                 "adminUrl" : "https://www.baidu.com/admin",
                 "userName" : "huawei",
                 "password" : "huawei123456",
                 "memo" : "hvave 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.baidu.com",
                 "adminUrl" : "https://www.baidu.com/admin",
                 "userName" : "huawei",
                 "password" : "huawei123456",
                 "memo" : "hvave 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" : "hvave 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"
                 }
             ]
        }
    ]
}