After a customer purchases and pays for a software as a service (SaaS) product, Alibaba Cloud Marketplace calls this operation to instruct the independent software vendor (ISV) to create an SaaS instance.

  • You must return a unique instance ID for each SaaS instance that is created. Alibaba Cloud Marketplace must provide the instance ID when calling other SPI operations, for example, the operations for renewing the subscription and notifying the ISV of instance expiration.
  • We recommend that you use the value of the orderBizId parameter provided by Alibaba Cloud Marketplace as the instance ID.
  • Do not block this operation. If it takes a long period of time to create an instance, you can use a queue to buffer the requests, set the instance ID to 0, and then return the instance ID immediately. If the instance fails to be created, set the instance ID to 0. In this case, Alibaba Cloud Marketplace calls this operation again until a non-zero instance ID is returned.
  • This operation may be called multiple times. If it is called repeatedly, make sure that the same instance ID is returned for a single instance.

Request parameters

ParameterRequiredTypeDescription
tokenYesStringThe token for security verification.
actionYesStringThe operation that you want to perform. Set the value to createInstance.
aliUidYesStringThe unique ID of the Alibaba Cloud account that purchases the SaaS product.
orderBizIdYesStringThe business ID in Alibaba Cloud Marketplace.
orderIdYesStringThe ID of the order in Alibaba Cloud Marketplace.
productCodeYesStringThe code of the SaaS product.
skuIdYesStringThe SKU ID of the SaaS product.
trialYesBooleanSpecifies whether the SaaS product is purchased in trial use mode.
expiredOnNoDateTimeThe time when the SaaS product expires, in the yyyy-MM-dd HH:mm:ss format.
templateNoStringThe ID of the template. This parameter is applicable to template-type products for building sites.

Response parameters

ParameterRequiredTypeFieldDescription
instanceIdYesStringN/AThe unique ID of the SaaS instance provided by the ISV.
hostInfoNoJSONnameThe hostname of the server.
ipThe IP address of the server.
innerIpThe private IP address of the server.
usernameThe account for logging on to the server.
passwordThe password for logging on to the server.
cnameThe canonical domain name (CNAME) of the server.
tempDomainThe temporary domain name of the server.
ftpUsernameThe username for logging on to the FTP server.
ftpPasswordThe password for logging on to the FTP server.
regionThe information about the IDC where the server resides.
beianInfoThe information about the ICP filing.
databaseInfoThe information about the database.
appInfoNoJSONfrontEndUrlThe URL of the front-end system.
adminUrlThe URL of the back-end system.
usernameThe username of the administrator.
passwordThe password of the administrator.
authUrlThe URL for logging on the SaaS product without authentication.
infoNoJSONN/AThe custom key-value pair.

Sample requests

http://example.aliyundoc.com?
token=097a56e26a93c874140bbcdf403f3f60&action=createInstance&aliUid=123123323&orderId=100001&orderBizId=1&productCode=cmjj000123&skuId=sku-1
            

Sample responses

{
"instanceId": "1",

"hostInfo": {
        "name": "linux server",
        "ip": "127.0.0.1",
        "username": "user",
        "password":"user_password"
},

"appInfo": {
        "frontEndUrl":"http://example.com/",
        "adminUrl":"http://example.com/admin",
        "username":"admin",
        "password": "admin_password"
},

"info": {
        "key1": "my custom info"
}
}