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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eflo:ListExperimentPlans

list

*ExperimentPlan

acs:eflo:{#regionId}:{#accountId}:experimentplan/*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
ResourceName	array	任意	リソース。
	string	任意	リソースの名前。	cls-pim0anlrtm3ef4vstou001
PlanTaskStatus	array	任意	実行ステータス。
	string	任意	ステータス。	RUNNING
CreatTimeOrder	string	任意	作成時刻のソート順。	desc
StartTimeOrder	string	任意	開始時刻のソート順。	desc
EndTimeOrder	string	任意	終了時刻のソート順。	desc
Page	integer	任意	ページ番号。	1
Size	integer	任意	1 ページあたりのエントリ数。	100
ResourceGroupId	string	任意	リソースグループ ID。	rg-aekzij65sf2rr5i
Tag	array<object>	任意	タグ。
	object	任意	タグ。最大 20 個のタグを指定できます。
Key	string	任意	タグキー。	owner
Value	string	任意	タグ値。	test
TemplateId	integer	任意	テンプレート ID。	96
ResourceId	integer	任意	リソース ID。	189

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	クエリ結果。
Data	array<object>	データ。
	object	クエリ結果。
PlanId	integer	計画の ID。	189
CreateTime	string	計画が作成された時刻。	2024-07-08 10:12:42
UpdateTime	string	計画が最後に更新された時刻。	2024-07-08 10:12:42
TemplateId	integer	関連付けられている実験計画テンプレートの ID。	6
TemplateName	string	関連付けられている実験計画テンプレートの名前。	test
ResourceName	string	関連付けられているリソースの名前。	q_ecs_xpec_postpay_c
PlanTaskStatus	object	実験計画の実行ステータス。
	integer	ステータス。	1
StartTime	string	開始時刻。	2024-07-08 10:12:42
EndTime	string	終了時刻。	2024-07-08 10:22:42
ResourceGroupId	string	リソースグループの ID。	rg-aek5behqmwbfhuy
Tags	array<object>	タグ。
	object	タグ。
TagKey	string	タグキー。	owner
TagValue	string	タグ値。	test
ResourceId	integer	リソース ID。	189
RequestId	string	リクエスト ID。	FA9F1DE7-103B-5C18-AE9E-EB2BFF11C685
TotalCount	integer	エントリの総数。	0
AccessDeniedDetail	string	アクセス拒否の詳細。	{}

例

成功レスポンス

JSONJSON

{
  "Data": [
    {
      "PlanId": 189,
      "CreateTime": "2024-07-08 10:12:42",
      "UpdateTime": "2024-07-08 10:12:42",
      "TemplateId": 6,
      "TemplateName": "test",
      "ResourceName": "q_ecs_xpec_postpay_c",
      "PlanTaskStatus": {
        "key": 1
      },
      "StartTime": "2024-07-08 10:12:42",
      "EndTime": "2024-07-08 10:22:42",
      "ResourceGroupId": "rg-aek5behqmwbfhuy",
      "Tags": [
        {
          "TagKey": "owner",
          "TagValue": "test"
        }
      ],
      "ResourceId": 189
    }
  ],
  "RequestId": "FA9F1DE7-103B-5C18-AE9E-EB2BFF11C685",
  "TotalCount": 0,
  "AccessDeniedDetail": "{}"
}

エラーコード

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

変更履歴

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