GetFunctionInstance - 获取实例详情 - 智能开放搜索 OpenSearch

根据实例名称获取实例详情。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

opensearch:DescribeFunction

get

*FunctionInstance

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

无

请求语法

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

路径参数

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

请求参数

名称	类型	必填	描述	示例值
output	string	否	控制返回信息的丰富度： simple：只显示基本信息 normal：显示 createParameters, cron 等信息（默认） detail: 返回训练任务信息	detail

示例

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

返回参数

名称	类型	描述	示例值
	object	响应体	{}
Status	string	请求状态	OK
HttpCode	integer	http 状态码	200
RequestId	string	请求 id	68ED4E1B-92B8-5821-A886-9C90686139EB
Message	string	返回的错误信息	instance not exist.
Code	string	返回的错误码（没有错误为空）	Instance.NotExist
Result	object	实例详情	{}
Belongs	object	所属信息
Category	string	垂类	general
Domain	string	行业	ecommerce
Language	string	适用的语种缩写	zh（默认）
CreateParameters	array<object>	创建参数列表
	object	参数体
Name	string	参数名称	param1
Value	string	参数值	value1
UsageParameters	array<object>	使用参数列表
	object	参数体
Name	string	参数名称	use_param1
Value	string	参数值	value1
CreateTime	integer	创建时间（单位毫秒）	1234
Cron	string	训练信息，cron 语法（Minutes Hours DayofMonth Month DayofWeek），为空表示不进行周期训练	0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)
Description	string	实例描述	instance descriptions
ExtendInfo	string	扩展信息（json string）	{\"dataReport\":{},\"errors\":{}}
FunctionName	string	功能名称	ctr
FunctionType	string	功能类型	PAAS
InstanceName	string	实例名称	ctr_test
ModelType	string	模型类型	tf_checkpoint
Source	string	实例来源 user 用户实例 builtin 内置实例	user
Status	string	实例状态 unavailable: 暂无可用模型（需要训练） available：可用	available
Task	object	训练任务信息（没有任务则不显示）
DagStatus	string	任务状态 "success"：成功 "failed"：失败 "untrained": 待训练 "pending": 调度中 "running"：训练中	success
LastRunTime	integer	上一次运行时间，单位：毫秒	1234
VersionId	integer	版本 id	101
Latency	integer	api 请求耗时（单位：毫秒）	123

正常返回示例：

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "result": {
        "versionId": 100,
        "instanceName": "ctr_test",
        "functionName": "ctr",
        "functionType": "PAAS",
        "modelType": "tf_checkpoint",
        "description": "测试",
        "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
        }
    }
}

示例

正常返回示例

JSON格式

{
  "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（默认）"
    },
    "CreateParameters": [
      {
        "Name": "param1",
        "Value": "value1"
      }
    ],
    "UsageParameters": [
      {
        "Name": "use_param1",
        "Value": "value1"
      }
    ],
    "CreateTime": 1234,
    "Cron": "0 3 ? * 0,1,3,5 (周日，周一，周三，周五凌晨3点)",
    "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
}

错误码

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

变更历史

更多信息，参考变更详情。