GetFunctionTask 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

*FunctionTask

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

なし

リクエスト構文

GET /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks/{generation} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーションの名前。	my_app_group_name
functionName	string	必須	機能の名前。	ctr
instanceName	string	必須	インスタンスの名前。	test_model_2
generation	string	必須	反復回数。	1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

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

リクエストの例

GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks/3

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
Status	string	リクエストのステータス。	OK
HttpCode	integer	HTTP ステータスコード。	200
RequestId	string	リクエストの ID。	A4D487A9-A456-5AA5-A9C6-B7BF2889CF74
Message	string	エラーメッセージ。	operation success
Code	string	エラーコード。	Task.NotExist
Result	object	リクエストの結果。
EndTime	integer	タスクの終了時刻を示すタイムスタンプ。単位: ミリ秒。	1647213406267
ExtendInfo	string	拡張情報。JSON 文字列です。	{\"recall\":91,\"errors\":[]}
FunctionName	string	機能の名前。	ctr
Generation	string	反復回数。	1
Progress	integer	進行状況。90 は 90% を示します。	90
RunId	string	タスクの ID。	trigger__2021-03-05T12:18:41
StartTime	integer	タスクの開始時刻を示すタイムスタンプ。単位: ミリ秒。	1647212220000
Status	string	タスクのステータス。有効な値: success failed running	success
Latency	integer	リクエストの消費時間 (ミリ秒)。	123

正常なレスポンスの例

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "result": {
      "functionName": "ctr",
      "progress": 100,
      "status": "success",
      "startTime": 100010,
      "endTime": 200020,
      "extendInfo": "{\"recall\":91,\"errors\":[]}",
      "runId": "trigger__2021-03-05T12:18:41",
      "generation": "3"
    }
}

例

成功レスポンス

JSONJSON

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
  "Message": "operation success",
  "Code": "Task.NotExist",
  "Result": {
    "EndTime": 1647213406267,
    "ExtendInfo": "{\\\"recall\\\":91,\\\"errors\\\":[]}",
    "FunctionName": "ctr",
    "Generation": "1",
    "Progress": 90,
    "RunId": "trigger__2021-03-05T12:18:41",
    "StartTime": 1647212220000,
    "Status": "success"
  },
  "Latency": 123
}

エラーコード

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

変更履歴

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