根据实例名称获取实例详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
opensearch:DescribeFunction |
get |
*FunctionInstance
|
无 | 无 |
请求语法
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 |
否 |
控制返回信息的丰富度：
|
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 (周日，周一，周三，周五凌晨 |
| 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 |
| status |
string |
实例状态
|
available |
| task |
object |
训练任务信息（没有任务则不显示） |
|
| dagStatus |
string |
任务状态
|
success |
| lastRunTime |
integer |
上一次运行时间，单位：毫秒 |
1234 |
| versionId |
integer |
版本 id |
101 |
| modifyTime |
integer |
算法实例最后修改时间戳。 |
0 |
| 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 (周日，周一，周三，周五凌晨",
"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,
"modifyTime": 0
},
"latency": 123
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。