全部產品
Search
文件中心

OpenSearch:GetFunctionInstance - 擷取執行個體詳情

更新時間:Dec 23, 2025

根據執行個體名稱擷取執行個體詳情。

調試

您可以在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

執行個體狀態

  1. unavailable: 暫無可用模型(需要訓練)

  2. 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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情