创建一个智能推荐实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /v2/openapi/instances HTTP/1.1
请求参数
参数 |
类型 |
是否必需 |
描述 |
---|---|---|---|
type |
String |
是 |
指定实例的类型,分为标准型( Standard )。 |
chargeType |
String |
是 |
实例的付费方式。取值范围: PrePaid:预付费,包年包月。选择该类付费方式时,您必须确认自己的账号支持余额支付/信用支付,否则将返回 InvalidPayMethod 的错误提示,并且需要指定paymentInfo参数。PostPaid:按量付费(当前暂不支持)。 |
quota |
Map |
是 |
您要申请的配额信息 |
userCount |
Integer |
是 |
您要申请的用户表文档数的配额信息,限制请看系统限制。 |
itemCount |
Integer |
是 |
您要申请的物品表文档数的配额信息,限制请看系统限制。 |
qps |
Integer |
是 |
您要申请的推荐请求的QPS配额信息,限制请求系统限制。 |
paymentInfo |
Map |
否 |
付费信息。 |
duration |
Integer |
否 |
付费周期,包含1,2,3,4,5,6,7,8,9,10,12 |
pricingCycle |
String |
否 |
周期单位,包含:月(Month),年(Year)等 |
autoRenew |
Boolean |
否 |
是否自动续费,包含:是(true)和否(false) |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | InternalServerError |
错误码 |
message | String | An internal server error occurred |
错误详情 |
requestId | String | 8F81A922-6C81-46D6-B78C-CC35E16B1691 |
请求id |
result | Struct |
返回参数 |
|
instanceId | String | airec-cn-xxxxx |
实例id |
示例
请求示例
POST /openapi/instances
公共请求头
{
"chargeType": "PrePaid",
"type": "Standard",
"quota": {
"userCount": 1000000,
"qps": 20,
"itemCount": 1000000
},
"paymentInfo": {
"duration": 1,
"pricingCycle": "Month",
"autoRenew": true
}
}
正常返回示例
XML
格式
<RequestId>8F81A922-6C81-46D6-B78C-CC35E16B1691</RequestId>
<Result>
<InstanceId>airec-cn-xxxxx</InstanceId>
</Result>
JSON
格式
{
"RequestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
"Result": {
"InstanceId": "airec-cn-xxxxx"
}
}
错误码
访问错误中心查看更多错误码。