GetFunctionDefaultInstance - OpenSearch - Alibaba Cloud Documentation Center

Queries the algorithm instance that an application uses by default.

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	my_app_group_name
functionName	string	Yes	The name of the feature.	ctr

Sample requests

GET /v4/openapi/app-groups/my-app/functions/pop/default-instances

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.	062BA91F-A568-5779-8A5B-9E62C9BB3DC1
Message	string	The error message.	default instance not set.
Code	string	The error code.	DefaultInstance.NotExist
Result	object	The result of the request.
InstanceName	string	The default instance name.	model1
Latency	long	The default running time.	123
InstanceName	string	The name of the instance.	sh-bp1oi31w1jn4ctdyv
FunctionName	string	The name of the feature.	cdn_waf

Sample success responses

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "result": {
        "instanceName": "pop_test"
    }
}

Examples

Sample success responses

JSONformat

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "062BA91F-A568-5779-8A5B-9E62C9BB3DC1",
  "Message": "default instance not set.",
  "Code": "DefaultInstance.NotExist",
  "Result": {
    "InstanceName": "model1"
  },
  "Latency": 123,
  "InstanceName": "sh-bp1oi31w1jn4ctdyv",
  "FunctionName": "cdn_waf"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history