CreateFunctionResource - OpenSearch - Alibaba Cloud Documentation Center

Creates an algorithm resource for a specified feature.

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

*FunctionResource

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The ID or name of the application group.	my_app_group_name
functionName	string	Yes	The name of the feature.	rank

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
Data	object	No	The resource data. Its structure depends on the `ResourceType` value.
Content	string	No	The file content. Use this for `raw_file` resources.	"abc"
Generators	array<object>	No	A list of feature generators. Use this for `feature_generator` resources.
	array<object>	No	The details of the feature generator.
Generator	string	No	The type of the feature generator. Valid values: lookup : lookup sequence : sequence overlap : overlap raw : raw combo : combo id : id	id
Input	object	No	The input.
Features	array<object>	No	The list of input features.
	object	No	An input feature.
Name	string	No	The name of the feature.	system_item_id
Type	string	No	The type of the feature. Valid values: item : item user : user	item
Output	string	No	The name of the output feature.	item_id_feature
Description	string	No	The description of the resource.	""
ResourceName	string	No	The name of the resource.	fg_jsoon
ResourceType	string	No	The type of the resource. Valid values: feature_generator : feature_generator raw_file : raw_file	feature_generator

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the request. OK: The request was successful. FAIL: The request failed.	OK
HttpCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	A4D487A9-A456-5AA5-A9C6-B7BF2889CF74
Message	string	The returned message.	""
Code	string	The error code. This is empty if the request succeeds.	""
Latency	number	The request processing time in milliseconds.	123

Examples

Success response

JSON format

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
  "Message": "\"\"",
  "Code": "\"\"",
  "Latency": 123
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.