All Products
Search
Document Center

OpenSearch:CreateFunctionResource

Last Updated:Oct 16, 2024

Creates an algorithm resource for a specific feature.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:WriteFunction
  • FunctionResource
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The name of the application.

my_app_group_name
functionNamestringYes

The name of the feature.

rank
bodyobjectYes

The body of the request.

DataobjectNo

The resource data. The data structure varies with the resource type.

ContentstringNo

The content of the file that corresponds to a resource of the raw_file type.

"abc"
Generatorsarray<object>No

The feature generators that correspond to resources of the feature_generator type.

objectNo
GeneratorstringNo

The type of the feature generator.

Valid values:

  • lookup

  • sequence

  • overlap

  • raw

  • combo

  • id

id
InputobjectNo

The input.

Featuresarray<object>No

The input features.

objectNo
NamestringNo

The name of the feature.

system_item_id
TypestringNo

The type of the feature.

Valid values:

  • item

  • user

item
OutputstringNo

The name of the output feature.

item_id_feature
DescriptionstringNo

The description of the resource.

""
ResourceNamestringNo

The name of the resource.

fg_jsoon
ResourceTypestringNo

The resource type.

Valid values:

  • feature_generator

  • raw_file

feature_generator

Response parameters

ParameterTypeDescriptionExample
object
Statusstring

The status code. Valid values:

  • OK
  • FAIL
OK
HttpCodelong

The HTTP status code returned.

200
RequestIdstring

The request ID.

A4D487A9-A456-5AA5-A9C6-B7BF2889CF74
Messagestring

The error message returned.

""
Codestring

The error code. If no error occurs, this parameter is left empty.

""
Latencydouble

The time consumed for the request. Unit: milliseconds.

123

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.