Call the ListFunctionInstances API to list function instances - OpenSearch - Alibaba Cloud - OpenSearch

Retrieves all instances that meet the specified conditions under the current user.

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

get

*FunctionInstance

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	app_group_name
functionName	string	Yes	The feature name.	ctr

Request parameters

Parameter	Type	Required	Description	Example
modelType	string	No	The model type.	tf_checkpoint
functionType	string	No	The feature type.	"PAAS"
source	string	No	The instance source. Valid values: builtin: system instances. user: user instances. (Default) all: all instances.	user
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries per page. Default value: 10.	10
output	string	No	The level of detail in the response. Valid values: normal: displays information such as createParameters and cron. (Default) simple: displays only basic information. detail: returns detailed training task information.	normal

Example

GET /v4/openapi/app-groups/my-app/functions/ctr/instances?source=all&output=simple

Response elements

Element	Type	Description	Example
	object	The response body.
status	string
httpCode	integer
totalCount	integer
requestId	string
message	string
code	string
result	array<object>
	array<object>
belongs	object
category	string
domain	string
language	string
createParameters	array<object>
	object
name	string
value	string
usageParameters	array<object>
	object
	string
createTime	integer
description	string
functionName	string
functionType	string
instanceName	string
modelType	string
source	string
status	string
versionId	integer
extendInfo	string
cron	string
task	object
dagStatus	string
lastRunTime	integer
modifyTime	integer
latency	integer

Normal response:

{
    "status": "OK",
    "requestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "totalCount": 2,
    "result": [
        {
            "versionId": 100,
            "instanceName": "instance_1",
            "functionName": "hot",
            "functionType": "PAAS",
            "modelType": "offline_inference",
            "description": "",
            "status": "available",
            "belongs": {
                "domain": "ecommerce",
                "category": "general",
                "language": "zh"
            },
            "createTime": 100010,
            "source": "user"
        },
        {
            "versionId": 100,
            "instanceName": "instance_2",
            "functionName": "hot",
            "functionType": "PAAS",
            "modelType": "offline_inference",
            "description": "",
            "status": "available",
            "belongs": {
                "domain": "ecommerce",
                "category": "general",
                "language": "zh"
            },
            "createTime": 200020,
            "source": "user",
            "default": true
        }
    ]
}

Examples

Success response

JSON format

{
  "status": "",
  "httpCode": 0,
  "totalCount": 0,
  "requestId": "",
  "message": "",
  "code": "",
  "result": [
    {
      "belongs": {
        "category": "",
        "domain": "",
        "language": ""
      },
      "createParameters": [
        {
          "name": "",
          "value": ""
        }
      ],
      "usageParameters": [
        {
          "key": ""
        }
      ],
      "createTime": 0,
      "description": "",
      "functionName": "",
      "functionType": "",
      "instanceName": "",
      "modelType": "",
      "source": "",
      "status": "",
      "versionId": 0,
      "extendInfo": "",
      "cron": "",
      "task": {
        "dagStatus": "",
        "lastRunTime": 0
      },
      "modifyTime": 0
    }
  ],
  "latency": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.