ListFunctionResources - OpenSearch - Alibaba Cloud Documentation Center

Lists the algorithm resources.

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:DescribeFunction

list

*FunctionResource

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application ID.	my_app_group_name
functionName	string	Yes	The function name.	rank

Request parameters

Parameter	Type	Required	Description	Example
resourceType	string	No	The resource type. Valid values: feature_generator : feature_generator raw_file : raw_file	feature_generator
output	string	No	The output level.	detail
pageNumber	integer	No	The page number.	1
pageSize	integer	No	The page size.	10

Response elements

Element	Type	Description	Example
	object
Status	string	The request status. Valid values: OK and FAIL.	OK
HttpCode	integer	The HTTP status code.	200
TotalCount	integer	The total number of records that meet the requirements.	2
RequestId	string	The request ID.	"3A809095-C554-5CF5-8FCE-BE19D4673790"
Message	string	The returned error message.	Invalid resource name.
Code	string	The returned error code. This parameter is empty if no error occurs.	Resource.InvalidResourceName
Result	array<object>	The result.
	array<object>	The result body.
CreateTime	integer	The time when the resource was created. Unit: milliseconds.	1234
Data	object	The resource data. The structure of the data varies based on the resourceType.
Content	string	The content of the file that corresponds to the raw_file resource.	"abc"
Generators	array<object>	The list of feature generators that correspond to the feature_generator resource.
	array<object>	The description of the feature generator.
Generator	string	The type of the feature generator.	combo
Input	object	The input.
Features	array<object>	The list of input features.
	object	The input feature.
Name	string	The feature name.	system_item_id
Type	string	The feature type. Valid values: item : item user : user	item
Output	string	The name of the output feature.	feature1
Description	string	The description of the resource.	resource description
FunctionName	string	The function name.	rank
ModifyTime	integer	The time when the resource was last modified. Unit: milliseconds.	1234
ReferencedInstances	array	The names of the referenced algorithm instances.
	string	The instance name.	rank_model1
ResourceName	string	The resource name.	fg_json
ResourceType	string	The resource type.	feature_generator
Latency	number	The request latency. Unit: milliseconds.	123

Examples

Success response

JSON format

{
  "Status": "OK",
  "HttpCode": 200,
  "TotalCount": 2,
  "RequestId": "\"3A809095-C554-5CF5-8FCE-BE19D4673790\"",
  "Message": "Invalid resource name.",
  "Code": "Resource.InvalidResourceName",
  "Result": [
    {
      "CreateTime": 1234,
      "Data": {
        "Content": "\"abc\"",
        "Generators": [
          {
            "Generator": "combo",
            "Input": {
              "Features": [
                {
                  "Name": "system_item_id",
                  "Type": "item"
                }
              ]
            },
            "Output": "feature1"
          }
        ]
      },
      "Description": "resource description",
      "FunctionName": "rank",
      "ModifyTime": 1234,
      "ReferencedInstances": [
        "rank_model1"
      ],
      "ResourceName": "fg_json",
      "ResourceType": "feature_generator"
    }
  ],
  "Latency": 123
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.