ListFunctionInstances - OpenSearch - Alibaba Cloud Documentation Center

Lists all instances that match the specified conditions.

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 name of the application.	app_group_name
functionName	string	Yes	The name of the feature.	ctr

Request parameters

Parameter	Type	Required	Description	Example
modelType	string	No	The type of the model.	tf_checkpoint
functionType	string	No	The type of the feature.	"PAAS"
source	string	No	The source of the instance. Valid values: builtin: The instance is created by the system. user: The instance is created by the user. This is the default value. all: All instances.	user
pageNumber	integer	No	The page number. The default value is 1.	1
pageSize	integer	No	The number of entries per page. The default value is 10.	10
output	string	No	The level of detail for the returned information. Valid values: normal: Displays information such as createParameters and cron. This is the default value. simple: Displays only basic information. detail: Returns the details of the training task.	normal

Examples

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	The status of the request.	"OK"
HttpCode	integer	The HTTP status code.	200
TotalCount	integer	The total number of entries.	2
RequestId	string	The ID of the request.	A4D487A9-A456-5AA5-A9C6-B7BF2889CF74
Message	string	The error message. This parameter is empty if the request is successful.	instance not exist.
Code	string	The error code. This parameter is empty if the request is successful.	Instance.NotExist
Result	array<object>	The list of instances.	[]
	array<object>	The information about the instance.	{}
Belongs	object	The ownership information of the instance.	{}
Category	string	The category.	"general"
Domain	string	The industry.	"ecommerce"
Language	string	The language code.	"zh"
CreateParameters	array<object>	The list of parameters for the instance.	[]
	object	The parameter body.	{}
Name	string	The name of the parameter.	"param1"
Value	string	The value of the parameter.	"value1"
UsageParameters	array<object>	The list of parameters in use.
	object	The parameter body.
Name	string	The name of the parameter.	use_param1
Value	string	The value of the parameter.	value1
CreateTime	integer	The time when the instance was created.	1234
Cron	string	The training schedule. This is a cron expression in the format of Minutes Hours DayofMonth Month DayofWeek. If this parameter is empty, periodic training is not performed.	0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)
Description	string	The description.	" "
ExtendInfo	string	The extended information. This is a JSON string that contains information such as model evaluation results and error messages.	"{\"dataReport\":{},\"errors\":{}}"
FunctionName	string	The name of the feature.	"ctr"
FunctionType	string	The type of the feature.	"PAAS"
InstanceName	string	The name of the instance.	"ctr_test"
ModelType	string	The type of the model.	"tf_checkpoint"
Source	string	The source of the instance. Valid values: user: The instance is created by the user. builtin: The instance is created by the system.	"user"
Status	string	The status of the instance. Valid values: unavailable: No model is available. You must train a model before you can use the instance. available: The instance is available.	available
VersionId	integer	The version ID.	123
Latency	integer	The request latency, in milliseconds.	123

Sample success responses

{
    "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": "\"OK\"",
  "HttpCode": 200,
  "TotalCount": 2,
  "RequestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
  "Message": "instance not exist.",
  "Code": "Instance.NotExist",
  "Result": [
    {
      "Belongs": {
        "Category": "\"general\"",
        "Domain": "\"ecommerce\"",
        "Language": "\"zh\"\t"
      },
      "CreateParameters": [
        {
          "Name": "\"param1\"",
          "Value": "\"value1\""
        }
      ],
      "UsageParameters": [
        {
          "Name": "use_param1",
          "Value": "value1"
        }
      ],
      "CreateTime": 1234,
      "Cron": "0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)",
      "Description": "\" \"",
      "ExtendInfo": "\"{\\\"dataReport\\\":{},\\\"errors\\\":{}}\"",
      "FunctionName": "\"ctr\"",
      "FunctionType": "\"PAAS\"",
      "InstanceName": "\"ctr_test\"",
      "ModelType": "\"tf_checkpoint\"",
      "Source": "\"user\"",
      "Status": "available",
      "VersionId": 123
    }
  ],
  "Latency": 123
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.