全部产品
Search
文档中心

智能开放搜索 OpenSearch:CreateInstance - 创建实例

更新时间:Oct 16, 2024

创建问天引擎实例。

接口说明

方法

POST

URI

/openapi/ha3/instances

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:CreateInstancecreate
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/*

请求语法

POST /openapi/ha3/instances HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求结构。

chargeTypestring

实例的付费方式。取值范围: PREPAY:预付费,包年包月。选择该类付费方式时,您必须确认自己的账号支持余额支付/信用支付,否则将返回 InvalidPayMethod 的错误提示,并且需要指定 paymentInfo 参数。POSTPAY:按量付费(当前暂不支持)。

PREPAY
componentsarray<object>

实例相关的规格信息列表。

object

实例相关的规格信息列表。

codestring

规格 code,和售卖参数保持一致

searcherdocsize
valuestring

控件填写的数据。

200
orderobject

付费信息。

autoRenewboolean

是否自动续费,包含:是(true)和否(false)

true
durationlong

付费周期,包含 1,2,3,4,5,6,7,8,9,10,12

29
pricingCyclestring

周期单位,包含:月(Month),年(Year)等

Month

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

D39EE0F1-D7EF-5F46-B781-6BF4185308B0
resultobject

返回结果。

instanceIdstring

实例 id

ha-cn-pl32rf0****

返回示例

正常返回示例

{
	"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
  "result": {
      "instanceId": "deeprec-cn-xxxxxx1"
    }
}

异常返回示例

{
	"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
  "code": "InternalServerError",
  "message":"internal server error"
}

详情可参考响应结构

示例

正常返回示例

JSON格式

{
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0",
  "result": {
    "instanceId": "ha-cn-pl32rf0****"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-03API 内部配置变更,不影响调用查看变更详情
2024-06-28API 内部配置变更,不影响调用查看变更详情