ListFunctionResources - OpenSearch - Alibaba Cloud Documentation Center

Queries algorithm resources.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
opensearch:DescribeFunction	list	FunctionResource acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application ID.	my_app_group_name
functionName	string	Yes	The name of the feature.	rank
resourceType	string	No	The type of the resource. Valid values: feature_generator raw_file	feature_generator
output	string	No	The output level. Valid values: simple normal detail	detail
pageNumber	integer	No	The page number.	1
pageSize	integer	No	The number of entries returned per page.	10

Response parameters

Parameter	Type	Description	Example
	object
Status	string	The status of the request. Valid values: OK and FAIL.	OK
HttpCode	long	The HTTP status code returned.	200
TotalCount	long	The total number of records that meet the requirements.	2
RequestId	string	The request ID.	"3A809095-C554-5CF5-8FCE-BE19D4673790"
Message	string	The error message returned.	Invalid resource name.
Code	string	The error code returned. If no error occurs, this value is empty.	Resource.InvalidResourceName
Result	array<object>	The results returned.
Result	object
CreateTime	long	The time when the resource was created. Unit: milliseconds.	1234
Data	object	The resource data. The data structure varies with the resource type.
Content	string	The content of the file that corresponds to a resource of the raw_file type.	"abc"
Generators	array<object>	The feature generators that correspond to resources of the feature_generator type.
Generators	object
Generator	string	The type of the feature generator.	combo
Input	object	The input.
Features	array<object>	The input features.
Features	object
Name	string	The name of the feature.	system_item_id
Type	string	The type of the feature. Valid values: item user	item
Output	string	The name of the output feature.	feature1
Description	string	The description of the resource.	resource description
FunctionName	string	The name of the feature.	rank
ModifyTime	long	The time when the resource was modified. Unit: milliseconds.	1234
ReferencedInstances	array	The algorithm instances that are referenced.
ReferencedInstances	string	The name of the instance.	rank_model1
ResourceName	string	The name of the resource.	fg_json
ResourceType	string	The type of the resource.	feature_generator
Latency	double	The amount of time consumed for the request. Unit: milliseconds.	123

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation

No change history