調用ListFunctionInstances API擷取執行個體列表-智能OpenSearch OpenSearch-阿里雲 - 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 HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
appGroupIdentity	string	是	應用程式名稱。	app_group_name
functionName	string	是	功能名稱。	ctr

請求參數

名稱	類型	必填	描述	樣本值
modelType	string	否	模型類型。	tf_checkpoint
functionType	string	否	功能類型。	"PAAS"
source	string	否	執行個體來源。 builtin：系統執行個體 user：使用者執行個體（預設） all：全部執行個體	user
pageNumber	integer	否	頁碼，預設值為 1。	1
pageSize	integer	否	每頁大小，預設值為 10。	10
output	string	否	返回資訊的豐富度。 normal：顯示 createParameters、cron 等資訊（預設） simple：只顯示基本資訊 detail：返回訓練工作詳細資訊	normal

範例

GET /v4/openapi/app-groups/my-app/functions/ctr/instances?source=all&output=simple

返回參數

名稱	類型	描述	樣本值
	object	回應主體。
status	string
httpCode	integer
totalCount	integer
requestId	string
message	string
code	string
result	array<object>
	array<object>
belongs	object
category	string
domain	string
language	string
createParameters	array<object>
	object
name	string
value	string
usageParameters	array<object>
	object
	string
createTime	integer
description	string
functionName	string
functionType	string
instanceName	string
modelType	string
source	string
status	string
versionId	integer
extendInfo	string
cron	string
task	object
dagStatus	string
lastRunTime	integer
modifyTime	integer
latency	integer

正常返回結果：

{
    "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": "",
  "httpCode": 0,
  "totalCount": 0,
  "requestId": "",
  "message": "",
  "code": "",
  "result": [
    {
      "belongs": {
        "category": "",
        "domain": "",
        "language": ""
      },
      "createParameters": [
        {
          "name": "",
          "value": ""
        }
      ],
      "usageParameters": [
        {
          "key": ""
        }
      ],
      "createTime": 0,
      "description": "",
      "functionName": "",
      "functionType": "",
      "instanceName": "",
      "modelType": "",
      "source": "",
      "status": "",
      "versionId": 0,
      "extendInfo": "",
      "cron": "",
      "task": {
        "dagStatus": "",
        "lastRunTime": 0
      },
      "modifyTime": 0
    }
  ],
  "latency": 0
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。