ListRunMetrics API による実行メトリックの取得とページネーション - PAI

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

paiexperiment:ListRunMetrics

get

*All Resource

*

なし

リクエスト構文

GET /api/v1/runs/{RunId}/metrics HTTP/1.1

パスパラメータ

パラメーター	型	必須 / 任意	説明	例
RunId	string	必須	実行 ID。	run-1qJhzJ2YXgX****

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Key	string	必須	実行のメトリックのキー。	loss
PageToken	integer	任意	ページングトークン。トークンは 0 から始まります。デフォルト値は 0 です。	0
MaxResults	integer	任意	返す結果の最大数。デフォルト値は 10 です。	100

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
requestId	string	リクエストの ID。	ADF6D849-*****-7E7030F0CE53
Metrics	array	メトリックのリスト。
	RunMetric	メトリックの詳細。
NextPageToken	integer	次のページの結果を取得するためのトークン。値が 0 の場合は、すべての結果が返されたことを示します。次のリクエストで `PageToken` パラメーターにこのパラメーターの値を使用して、次のページを取得します。	0

例

成功レスポンス

JSONJSON

{
  "requestId": "ADF6D849-*****-7E7030F0CE53",
  "Metrics": [
    {
      "Value": 0,
      "Step": 0,
      "Timestamp": 0,
      "Key": ""
    }
  ],
  "NextPageToken": 0
}

エラーコード

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

変更履歴

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