擷取使用者下，合格所有執行個體。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
opensearch:DescribeFunction |
get |
*FunctionInstance
|
無 | 無 |
請求文法
GET /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances HTTP/1.1路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| appGroupIdentity |
string |
是 |
應用程式名稱 |
app_group_name |
| functionName |
string |
是 |
功能名稱 |
ctr |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| modelType |
string |
否 |
模型類型 |
tf_checkpoint |
| functionType |
string |
否 |
功能類型 |
"PAAS" |
| source |
string |
否 |
執行個體來源
|
user |
| pageNumber |
integer |
否 |
頁碼，預設值為 1 |
1 |
| pageSize |
integer |
否 |
每頁大小，預設值為 10 |
10 |
| output |
string |
否 |
返回資訊的豐富度
|
normal |
樣本
GET /v4/openapi/app-groups/my-app/functions/ctr/instances?source=all&output=simple
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
響應體 |
||
| Status |
string |
請求狀態 |
"OK" |
| HttpCode |
integer |
http 狀態代碼 |
200 |
| TotalCount |
integer |
總條數 |
2 |
| RequestId |
string |
請求 id |
A4D487A9-A456-5AA5-A9C6-B7BF2889CF74 |
| Message |
string |
錯誤資訊，正常為空白 |
instance not exist. |
| Code |
string |
錯誤碼，正常為空白 |
Instance.NotExist |
| Result |
array<object> |
結果清單 |
[] |
|
array<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 |
描述 |
" " |
| 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 |
| VersionId |
integer |
版本 ID |
123 |
| Latency |
integer |
api 請求耗時 （單位毫秒） |
123 |
正常返回結果：
{
"status": "OK",
"requestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
"httpCode": 200,
"code": "",
"message": "",
"latency": 123,
"totalCount": 2,
"result": [
{
"versionId": 100,
"instanceName": "instance_1",
"functionName": "hot",
"functionType": "PAAS",
"modelType": "offline_inference",
"description": "",
"status": "available",
"belongs": {
"domain": "ecommerce",
"category": "general",
"language": "zh"
},
"createTime": 100010,
"source": "user"
},
{
"versionId": 100,
"instanceName": "instance_2",
"functionName": "hot",
"functionType": "PAAS",
"modelType": "offline_inference",
"description": "",
"status": "available",
"belongs": {
"domain": "ecommerce",
"category": "general",
"language": "zh"
},
"createTime": 200020,
"source": "user",
"default": true
}
]
}
樣本
正常返回樣本
JSON格式
{
"Status": "\"OK\"",
"HttpCode": 200,
"TotalCount": 2,
"RequestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
"Message": "instance not exist.",
"Code": "Instance.NotExist",
"Result": [
{
"Belongs": {
"Category": "\"general\"",
"Domain": "\"ecommerce\"",
"Language": "\"zh\"\t"
},
"CreateParameters": [
{
"Name": "\"param1\"",
"Value": "\"value1\""
}
],
"UsageParameters": [
{
"Name": "use_param1",
"Value": "value1"
}
],
"CreateTime": 1234,
"Cron": "0 3 ? * 0,1,3,5 (周日，周一，周三，周五淩晨3點)",
"Description": "\" \"",
"ExtendInfo": "\"{\\\"dataReport\\\":{},\\\"errors\\\":{}}\"",
"FunctionName": "\"ctr\"",
"FunctionType": "\"PAAS\"",
"InstanceName": "\"ctr_test\"",
"ModelType": "\"tf_checkpoint\"",
"Source": "\"user\"",
"Status": "available",
"VersionId": 123
}
],
"Latency": 123
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。