すべてのプロダクト
Search
ドキュメントセンター

OpenSearch:GetFunctionInstance

最終更新日:Dec 23, 2025

インスタンス名でアルゴリズムインスタンスの詳細を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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 式。(分 時 日 月 曜日) のフォーマットです。値が空の場合は、定期的なトレーニングが実行されないことを示します。

0 3 ? * 0,1,3,5 (周日,周一,周三,周五凌晨3点)

Description

string

インスタンスの説明。

instance descriptions

ExtendInfo

string

拡張情報。JSON 文字列です。

{\"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

リクエストの所要時間 (ミリ秒単位)。

123

正常なレスポンスの例

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

成功レスポンス

JSONJSON

{
  "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
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。