すべてのプロダクト
Search

このプロダクト

    OpenSearch:ListFunctionInstances

    ドキュメントセンター

    OpenSearch:ListFunctionInstances

    最終更新日:Nov 24, 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 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

    リクエストのステータス。

    "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 式です。このパラメーターが空の場合、定期的なトレーニングは実行されません。

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

    string

    説明。

    " "
    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
    VersionId

    integer

    バージョン ID。

    123
    Latency

    integer

    リクエストのレイテンシ (ミリ秒)。

    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
        }
    ]
}

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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