GetFunctionVersion による関数バージョン詳細の取得 - OpenSearch

関数バージョンの情報を照会します。

今すぐお試しください

この 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/functions/{functionName}/versions/{versionId} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
functionName	string	必須	機能の名前。	ctr
versionId	integer	必須	バージョンの ID。	100

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

リクエストの例

GET /v4/openapi/functions/ctr/version/101

レスポンスフィールド

フィールド	型	説明	例
	object	応答本文。	{}
Status	string	リクエストのステータス。	OK
HttpCode	integer	HTTP ステータスコード。	200
RequestId	string	リクエスト ID。	1638157479281
Message	string	エラーメッセージ。	version not exist.
Code	string	エラーコード。	Version.NotExist
Result	object	結果の本文。	[]
FunctionName	string	機能の名前。	ctr
FunctionType	string	機能のタイプ。有効な値: PAAS SAAS	PAAS
ModelType	string	モデルのタイプ。	tf_checkpoint
VersionConfig	object	バージョンの構成。	{ "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\"required\": true, \"pattern?\": \"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\"}", "componentProps": "{\"component\": \"Input\", \"attributes\": {\"defaultValue\": \"value1\"}}" } ], "depends": [ { "dependency": "依赖项", "condition": "条件", "description": "" } ], "usageParameters": [] }
CreateParameters	array<object>	インスタンスの作成に使用されるパラメーター。	[ { "name": "params1", "required": "true", "formItemProps": "{\"required\": true, \"pattern?\": \"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\"}", "componentProps": "{\"component\": \"Input\", \"attributes\": {\"defaultValue\": \"value1\"}}" } ]
	object	パラメーターの本文。	{}
Name	string	パラメーターの名前。	params1
Required	string	パラメーターが必須かどうかを示します。	true
Depends	array<object>	インスタンスの依存関係。	[ { "dependency": "依赖项", "condition": "条件", "description": "" } ]
	object	パラメーターの本文。	{}
Condition	string	条件。	""
Dependency	string	依存関係。	""
Description	string	説明。	""
UsageParameters	array<object>	インスタンスのオンライン使用中に使用されるパラメーター。	[]
	object	パラメーターの本文。	{}
Name	string	パラメーターの名前。	""
Required	string	パラメーターが必須かどうかを示します。	""
VersionId	integer	バージョンの ID。	101
VersionName	string	バージョンの名前。	v1
Latency	integer	リクエストのレイテンシ。	123

成功レスポンスの例

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "result": {
        "versionName": "v1",
        "versionId": 101,
        "functionName": "ctr",
        "modelType": "tf_checkpoint",
        "functionType": "PAAS",
        "versionConfig": {
            "createParameters": [
                {
                    "name": "params1",
                    "required": "true",
                    "formItemProps": "{\"required\": true, \"pattern?\": \"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\"}",
                    "componentProps": "{\"component\": \"Input\", \"attributes\": {\"defaultValue\": \"value1\"}}"
                }
            ],
            "depends": [
                {
                    "dependency": "the dependency",
                    "condition": "the condition",
                    "description": ""
                }
            ],
            "usageParameters": []
        }
    }
}

例

成功レスポンス

JSONJSON

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "1638157479281",
  "Message": "version not exist.",
  "Code": "Version.NotExist",
  "Result": {
    "FunctionName": "ctr",
    "FunctionType": "PAAS",
    "ModelType": "tf_checkpoint",
    "VersionConfig": {
      "CreateParameters": [
        {
          "Name": "params1",
          "Required": "true"
        }
      ],
      "Depends": [
        {
          "Condition": "\"\"",
          "Dependency": "\"\"",
          "Description": "\"\""
        }
      ],
      "UsageParameters": [
        {
          "Name": "\"\"",
          "Required": "\"\""
        }
      ]
    },
    "VersionId": 101,
    "VersionName": "v1"
  },
  "Latency": 123
}

エラーコード

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

変更履歴

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