GetFunctionInstance - OpenSearch - Alibaba Cloud Documentation Center

Queries the details of an algorithm instance by instance name.

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	150057101
functionName	string	Yes	The name of the feature.	ctr
instanceName	string	Yes	The name of the instance.	ctr_test
output	string	No	Specifies the richness of returned information. Valid values: simple: displays only the basic information. normal: displays information such as createParameters and cron. This is the default value. detail: returns the details of the training task.	detail

Sample requests

GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test?output=detail

Response parameters

Parameter	Type	Description	Example
	object	The response body.
Status	string	The status of the request.	OK
HttpCode	long	The HTTP status code.	200
RequestId	string	The ID of the request.	68ED4E1B-92B8-5821-A886-9C90686139EB
Message	string	The error message.	instance not exist.
Code	string	The error code. If no error occurs, this parameter is left empty.	Instance.NotExist
Result	object	The details of the instance.
Belongs	object	The information about the instance.
Category	string	The category.	general
Domain	string	The industry.	ecommerce
Language	string	The abbreviation of the language that applies.	zh
CreateParameters	array<object>	The parameters that are used to create the instance.
CreateParameters	object	The parameter body.
Name	string	The name of the parameter.	param1
Value	string	The value of the parameter.	value1
UsageParameters	array<object>	The parameters that are used.
UsageParameters	object	The parameter body.
Name	string	The name of the parameter.	use_param1
Value	string	The value of the parameter.	value1
CreateTime	long	The time when the task was created. Unit: milliseconds.	1234
Cron	string	The cron expression used to schedule training, in the format of (Minutes Hours DayofMonth Month DayofWeek). If the value is empty, it indicates that no periodic training is performed.	0 3 ? \* 0,1,3,5 (at 3 a.m. on Sunday, Monday, Wednesday, and Friday)
Description	string	The description of the instance.	instance descriptions
ExtendInfo	string	The extended information, which is a JSON string.	{\"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	How the instance is created. Valid values: user: The instance is created by user. builtin: The instance is created by the system.	user
Status	string	The status of the instance. Valid values: unavailable: No model is available. Models must be trained before you can use them. available: Models can be used.	available
Task	object	The information about the training task. This parameter is not displayed if no task is available.
DagStatus	string	The status of the task. Valid values: success: succeeded failed: failed untrained: to be trained pending: being scheduled running: being trained	success
LastRunTime	long	The time consumed for the most recent run, in milliseconds.	1234
VersionId	long	The ID of the version.	101
Latency	long	The time consumed for the request, in milliseconds.	123

Sample success responses

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "result": {
        "versionId": 100,
        "instanceName": "ctr_test",
        "functionName": "ctr",
        "functionType": "PAAS",
        "modelType": "tf_checkpoint",
        "Description": "test",
        "status": "available",
        "belongs": {
            "domain": "ecommerce",
            "category": "general",
            "language": "zh"
        },
        "createTime": 100010,
        "createParameters": [
            {
                "name": "param1",
                "value": "val1"
            }
        ],
        "usageParameters": [
            {
                "name": "use_param1",
                "value": "val1"
            }
        ],
        "extendInfo": "{\"error\":{},\"dataReport\":{}}",
        "cron": "",
        "task": {
            "dagStatus": "running",
            "progress": 30,
            "lastRunTime": 200020
        }
    }
}

Examples

Sample success responses

JSONformat

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "68ED4E1B-92B8-5821-A886-9C90686139EB",
  "Message": "instance not exist.",
  "Code": "Instance.NotExist",
  "Result": {
    "Belongs": {
      "Category": "general",
      "Domain": "ecommerce",
      "Language": "zh\n"
    },
    "CreateParameters": [
      {
        "Name": "param1",
        "Value": "value1"
      }
    ],
    "UsageParameters": [
      {
        "Name": "use_param1",
        "Value": "value1"
      }
    ],
    "CreateTime": 1234,
    "Cron": "0 3 ? \\* 0,1,3,5 (at 3 a.m. on Sunday, Monday, Wednesday, and Friday)\n",
    "Description": "instance descriptions",
    "ExtendInfo": "{\\\"dataReport\\\":{},\\\"errors\\\":{}}",
    "FunctionName": "ctr",
    "FunctionType": "PAAS",
    "InstanceName": "ctr_test",
    "ModelType": "tf_checkpoint",
    "Source": "user",
    "Status": "available",
    "Task": {
      "DagStatus": "success",
      "LastRunTime": 1234
    },
    "VersionId": 101
  },
  "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