CreateFunctionInstance_智能开放搜索 OpenSearch_API文档-阿里云OpenAPI开发者门户

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

opensearch:WriteFunction	Create	FunctionInstance acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	无	无

请求语法

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

路径参数

字段名称	字段详情
appGroupIdentitystring	应用名称示例值:my_app_group_name参考取值来源: CreateAppGroupCredentials ListAppGroups
functionNamestring	功能名称，支持的模型有：展开详情示例值:ctr参考取值来源: CreateFunctionTask

请求参数

字段名称	字段详情
Bodyobject	body 参数示例值:{ "instanceName": "ctr_test", "modelType": "tf_checkpoint", "createParameters": [ { "name": "title_field", "value": "title" }, { "name": "description_field", "value": "" }, { "name": "tags_field", "value": "" }, { "name": "id_field", "value": "item_id" }, { "name": "category_field", "value": "cate" } ], "description": "测试实例", }

请求说明

示例（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"
}

返回参数

字段名称	字段详情
Statusstring	状态码示例值:OK
HttpCodeinteger<int64>	http 状态码注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:200
RequestIdstring	请求 id 示例值:98724351-D6B2-5D8A-B089-7FFD1821A7E9
Messagestring	错误信息，正常时为空示例值:version not exist.
Codestring	错误码示例值:Version.NotExist
Latencyinteger<int64>	请求耗时，单位 ms 注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:123

返回说明

正常返回示例：

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

返回示例

变更历史

	变更时间	变更内容概要	操作
	2023-03-30	变更请求参数Body
	2023-03-28	变更请求参数Body