Marketplace:Create an instance

• Return a unique identifier (instanceId) for each application instance. Alibaba Cloud Marketplace uses this identifier for subsequent operations, such as renewals and expirations.

• We recommend that you use the value of the orderBizId parameter as the instanceId.

• Do not block this call. If the operation is time-consuming, use a queue for buffering, set instanceId=0, and return immediately. If the operation fails, also set instanceId=0. Alibaba Cloud Marketplace will retry the call (up to 120 times) until it receives a valid instanceId.

• This call may be invoked multiple times. Ensure that your endpoint is idempotent.

• For products with extra billing items, the API request includes parameters for these items at the same level as other parameters. The parameter key matches the key you specified when publishing the product, and the value is the customer's selection. For example, if you have two extra billing items with the keys "Count" and "Num", and a customer places an order with Count=2 and Num=3, these parameters and their values are included in the request. You must initialize the service and record these values.

Parameters

Response

Sample request

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

Sample response

{
  "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"
  }
}

FAQ

1. When creating an instance, how can I identify the product and specifications that a customer purchased?

The productCode parameter is the code for the purchased product. You can find this code in the Product Code column on the product management page in the service provider console.

If the product has multiple product specifications, the skuId parameter corresponds to the specification code. You can find this code under product release > product sales information.

For example, on the Product Sales Information page, the specification code for the Enterprise Edition might be yuncode4757500001, and the code for the Flagship Edition might be yuncode4757500002.