GetFunctionResource API を使用したアルゴリズムリソースの取得 - 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

*FunctionResource

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

なし

リクエスト構文

GET /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/resources/{resourceName} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーション ID。	my_app_group_name
functionName	string	必須	特徴名。	rank
resourceName	string	必須	インスタンス名。	fg_json

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
output	string	任意	出力レベル。	detail

レスポンスフィールド

フィールド	型	説明	例
	object
Status	string	状態コード。 OK: リクエストは成功しました。 FAIL: リクエストは失敗しました。	OK
HttpCode	integer	HTTP ステータスコード。	200
RequestId	string	リクエスト ID。	E215C843-0795-5293-AC9A-14FE0723E890
Message	string	返されたエラーメッセージ。	Resource not exist.
Code	string	返されたエラーコード。エラーが発生しなかった場合、これは空です。	Resource.NotExist
Result	object	返された結果。
CreateTime	integer	リソースが作成された時間。単位: ミリ秒。	1234
Data	object	リソースデータ。データの構造は resourceType によって異なります。
Content	string	raw_file タイプのリソースのファイルの内容。	abc
Generators	array<object>	feature_generator タイプのリソースの特徴ジェネレーターのリスト。
	array<object>	特徴ジェネレーターの説明。
Generator	string	特徴ジェネレーターのタイプ。	id
Input	object	入力。
Features	array<object>	入力特徴のリスト。
	object	入力特徴。
Name	string	特徴名。	system_item_id
Type	string	特徴タイプ。	item
Output	string	出力特徴の名前。	output_feature_name
Description	string	リソースの説明。	""
FunctionName	string	特徴名。	rank
ModifyTime	integer	リソースが最後に変更された時間。単位: ミリ秒。	1234
ReferencedInstances	array	参照されているアルゴリズムインスタンス名のリスト。
	string	インスタンス名。	instance1
ResourceName	string	リソース名。	fg_json
ResourceType	string	リソースタイプ。	raw_file
Latency	number	API リクエストの消費時間。単位: ミリ秒。	123

例

成功レスポンス

JSONJSON

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "E215C843-0795-5293-AC9A-14FE0723E890",
  "Message": "Resource not exist.",
  "Code": "Resource.NotExist",
  "Result": {
    "CreateTime": 1234,
    "Data": {
      "Content": "abc",
      "Generators": [
        {
          "Generator": "id",
          "Input": {
            "Features": [
              {
                "Name": "system_item_id",
                "Type": "item"
              }
            ]
          },
          "Output": "output_feature_name"
        }
      ]
    },
    "Description": "\"\"",
    "FunctionName": "rank",
    "ModifyTime": 1234,
    "ReferencedInstances": [
      "instance1"
    ],
    "ResourceName": "fg_json",
    "ResourceType": "raw_file"
  },
  "Latency": 123
}

エラーコード

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

変更履歴

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