使用CreateFunctionInstance建立演算法執行個體-智能OpenSearch OpenSearch-阿里雲 - OpenSearch

介面說明

一般先透過 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	是	body 參數。	my_app_group_name
functionName	string	是	應用程式名稱。	my_app_group_name

請求參數

名稱	類型	必填	描述	樣本值
		否	功能名稱，支援的模型有： CTR 模型：ctr 人氣模型：pop 類目模型：category 熱詞模型：hot 底紋模型：hint 下拉提示模型：suggest 斷詞模型：analyzer 詞權重模型：termweight 同義詞模型：synonym	ctr

範例（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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。