All Products
Search
Document Center

OpenSearch:UpdateFunctionResource

Last Updated:Aug 05, 2024

Updates an algorithm resource.

Operation description

You can call this operation to update the information about resources by resource name. You can modify only the values of data and description.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:WriteFunctionupdate
  • FunctionResource
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
    none
none

Request syntax

PUT /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName}

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The application ID.

my_app_group_name
functionNamestringYes

The name of the feature.

rank
resourceNamestringYes

The name of the resource.

fg_json
bodyobjectNo

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.

combo
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.

item
OutputstringNo

The name of the output feature.

feature1
DescriptionstringNo

The description of the resource.

updated description

Response parameters

ParameterTypeDescriptionExample
object
Statusstring

The status of the request.

OK
HttpCodelong

The HTTP status code returned.

200
RequestIdstring

The request ID.

7E375703-5B12-5466-8B48-C4D01AE1291A
Messagestring

The error message returned.

Invalid request.
Codestring

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

InvalidRequest
Latencydouble

The time consumed for the request. Unit: milliseconds.

123

Examples

Sample success responses

JSONformat

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "7E375703-5B12-5466-8B48-C4D01AE1291A",
  "Message": "Invalid request.",
  "Code": "InvalidRequest",
  "Latency": 123
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history