All Products
Search
Document Center

:CreateInstance

Last Updated:Mar 01, 2024

Creates an Artificial Intelligence Recommendation (AIRec) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /v2/openapi/instances

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters
ParameterTypeRequiredDescription
typeStringYesThe type of the instance. Valid values: Algorithm Configuration Edition and Industry Operation Edition.
chargeTypeStringYesThe billing method of the instance. Valid values: PrePaid and PostPaid. PrePaid: the subscription billing method. If you set the value to PrePaid, make sure that your Alibaba Cloud account supports balance payment or credit payment. Otherwise, the system returns the InvalidPayMethod error message. If you set the value to PrePaid, you must also specify the paymentInfo parameter. PostPaid: the pay-as-you-go billing method. Currently, this method is not supported.
quotaMapYesThe quotas that you want to apply for.
userCountIntegerYesThe quota for the number of documents in the user table that you want to apply for. For more information about the limits on the quota, refer to the buy page.
itemCountIntegerYesThe quota for the number of documents in the item table that you want to apply for. For more information about the limits on the quota, refer to the buy page.
qpsIntegerYesThe queries per second (QPS) quota for recommendation requests that you want to apply for. For more information about the limits on the quota, refer to the buy page.
paymentInfoMapNoThe billing information.
durationIntegerNoThe billing cycle. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, and 12.
pricingCycleStringNoThe unit of the billing cycle. Valid values: Month and Year.
autoRenewBooleanNoSpecifies whether to enable auto-renewal. Valid values: true and false.

Response parameters

ParameterTypeDescriptionExample
object
resultobject

The returned results.

instanceIdstring

The instance ID.

airec-cn-xxxxx
codestring

The error code.

InternalServerError
requestIdstring

The request ID.

8F81A922-6C81-46D6-B78C-CC35E16B1691
messagestring

The error message.

An internal server error occurred

Examples

Sample success responses

JSONformat

{
  "result": {
    "instanceId": "airec-cn-xxxxx"
  },
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history