使用CreateFunctionInstance创建算法实例-智能开放搜索 OpenSearch-阿里云-智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

创建指定功能的一个算法实例。

接口说明

一般先通过 GetFunctionCurrentVersion 接口获取当前功能使用的最新版本，版本中描述了创建实例所需的参数列表 createParameters、usageParameters，以及参数填写要求。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

opensearch:WriteFunction

create

*FunctionInstance

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

无

请求语法

POST /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
appGroupIdentity	string	是	应用名称	my_app_group_name
functionName	string	是	功能名称，支持的模型有： CTR 模型：ctr 人气模型：pop 类目模型：category 热词模型：hot 底纹模型：hint 下拉提示模型：suggest 分词模型：analyzer 词权重模型：termweight 同义词模型：synonym	ctr

请求参数

名称	类型	必填	描述	示例值
body	object	否	body 参数
instanceName	string	是	实例名称
modelType	string	是	模型类型
functionType	string	否	功能类型
description	string	否	实例描述
createParameters	array<object>	否	实例的参数列表
	object	否	参数项
name	string	否	参数名称
value	string	否	参数值
usageParameters	array<object>	否	使用参数
	object	否
name	string	否	参数名称
value	string	否	参数值
cron	string	否	Cron 表达式

示例（ctr）

POST /v4/openapi/app-groups/my-app/functions/ctr/instances
{
    "instanceName": "my_ctr",
    "modelType": "tf_checkpoint",
    "functionType": "PAAS",
    "cron": "0 0 ? * 0,1,3,5",
    "description": "",
    "createParameters": [
        {
            "name": "id_field",
            "value": "id"
        },
        {
            "name": "title_field",
            "value": "title"
        }
    ],
    "usageParameters": []
}

示例（hot）

POST /v4/openapi/app-groups/my-app/functions/hot/instances
{
    "instanceName":"my_hot",
    "modelType":"offline_inference",
    "functionType":"PAAS",
    "createParameters":[
        {
            "name":"filter",
            "value":"biz_type != 1"
        }
    ],
    "usageParameters": [
        {
            "name":"allow_dict_id",
            "value":"123"
        },
        {
            "name":"deny_dict_id",
            "value":"456"
        }
    ],
    "cron":"12 4 ? * 1,2,3,4,5,6,0"
}

返回参数

名称	类型	描述	示例值
	object	body 参数	{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : { } }
status	string
httpCode	integer
requestId	string
message	string
code	string
latency	integer

正常返回示例：

{
  "status" : "OK",
  "requestId" : "98724351-D6B2-5D8A-B089-7FFD1821A7E9",
  "httpCode": 200,
  "code": "",
  "message": "",
  "latency" : 123,
  "result" : {}
}

示例

正常返回示例

JSON格式

{
  "status": "",
  "httpCode": 0,
  "requestId": "",
  "message": "",
  "code": "",
  "latency": 0
}

错误码

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

变更历史

更多信息，参考变更详情。