Build an OpenSearch Algorithm Instance via CreateFunctionInstance API - OpenSearch - Alibaba Cloud - OpenSearch

Operation description

Before calling this operation, call the GetFunctionCurrentVersion operation to obtain the latest version of the feature. The version describes the parameter lists createParameters and usageParameters required for creating an instance, as well as the parameter requirements.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:WriteFunction

create

*FunctionInstance

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The body parameters.	my_app_group_name
functionName	string	Yes	The application name.	my_app_group_name

Request parameters

Parameter	Type	Required	Description	Example
		No	The feature name. Valid values: ctr: CTR model pop: popularity model category: category model hot: hot word model hint: hint model suggest: drop-down suggestion model analyzer: token model termweight: term weighting model synonym: synonym model	ctr

Example (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": []
}

Example (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"
}

Response elements

Element	Type	Description	Example
	object	The body parameters.	{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : { } }
status	string
httpCode	integer
requestId	string
message	string
code	string
latency	integer

Sample success response:

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.