调用GetFunctionDefaultInstance获取默认实例_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

获取app默认使用的算法实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
opensearch:DescribeFunction	get	FunctionDefaultInstance acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
appGroupIdentity	string	是	应用名称	my_app_group_name
functionName	string	是	功能名称	ctr

示例

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

返回参数

名称	类型	描述	示例值
	object	响应体
Status	string	请求状态	OK
HttpCode	long	http 状态码	200
RequestId	string	请求 id	062BA91F-A568-5779-8A5B-9E62C9BB3DC1
Message	string	返回的错误信息	default instance not set.
Code	string	返回的状态码	DefaultInstance.NotExist
Result	object	结果
InstanceName	string	默认实例名称	model1
Latency	long	默认运行时间	123
InstanceName	string	实例名称	sh-bp1oi31w1jn4ctdyv
FunctionName	string	功能名称	cdn_waf

正常返回示例

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

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史