すべてのプロダクト
Search
ドキュメントセンター

:ListImages

最終更新日:Nov 18, 2025

イメージのリストを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

paiimage:ListImages

list

*All Resource

*

なし なし

リクエスト構文

GET /api/v1/images HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

Name

string

任意

イメージの名前。あいまい検索がサポートされています。

tensorflow_2.9

PageNumber

integer

任意

イメージリストのページ番号。値は 1 から始まります。デフォルト値は 1 です。

1

PageSize

integer

任意

ページングクエリで各ページに返すエントリの数。デフォルト値は 20 です。

20

SortBy

string

任意

ページングクエリでソートに使用するフィールド。現在、ソートには GmtCreateTime フィールドのみが使用されます。

GmtCreateTime

Order

string

任意

ページングクエリの結果をソートする順序。このパラメーターは SortBy と共に使用されます。デフォルト値は ASC です。

  • ASC: 昇順。

  • DESC: 降順。

DESC

Labels

string

任意

ラベルのフィルター条件。複数の条件はカンマ (,) で区切ります。 単一のフィルター条件のフォーマットは Key=Value です。 Key でサポートされている値は次のとおりです。

  • system.chipType

  • system.dsw.cudaVersion

  • system.dsw.fromImageId

  • system.dsw.fromInstanceId

  • system.dsw.id

  • system.dsw.os

  • system.dsw.osVersion

  • system.dsw.resourceType

  • system.dsw.rootImageId

  • system.dsw.stage

  • system.dsw.tag

  • system.dsw.type

  • system.framework

  • system.origin

  • system.pythonVersion

  • system.source

  • system.supported.dlc

  • system.supported.dsw

system.framework=XGBoost 1.6.0,system.official=true

Verbose

boolean

任意

必須ではない情報を表示するかどうかを指定します。現在、必須ではない情報には Labels が含まれます。有効な値:

  • true: 必須ではない情報を含みます。

  • false: 必須ではない情報を含みません。

true

WorkspaceId

string

任意

ワークスペース ID。ワークスペース ID の取得方法の詳細については、「ListWorkspaces」をご参照ください。

20******55

Query

string

任意

イメージ名と説明であいまい検索を実行します。

name

Accessibility

string

任意

イメージの可視性。このパラメーターはカスタムイメージに対してのみ有効です。

  • PUBLIC: イメージは公開されています。

  • PRIVATE: イメージは非公開です。

PUBLIC

ImageUri

string

任意

レスポンスフィールド

フィールド

説明

object

レスポンス構造体。

RequestId

string

リクエスト ID。

5A14FA81-DD4E-******-6343FE44B941

TotalCount

integer

返されたイメージの総数。

2

Images

array<object>

イメージのリスト。

array<object>

イメージの詳細。

Name

string

イメージ名。

tensorflow_2.9

GmtCreateTime

string

イメージが作成された時刻。時刻は UTC で、フォーマットは ISO 8601 です。

2021-01-21T17:12:35.232Z

Description

string

イメージの説明。

desc

ImageUri

string

バージョン番号を含むイメージ URL。

registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0

Labels

array<object>

イメージラベルのリスト。

object

イメージラベル。

Key

string

ラベルのキー。

system.chipType

Value

string

ラベルの値。

GPU

ImageId

string

イメージ ID。

image-tzi7f9******s45t

Accessibility

string

イメージの可視性。有効な値:

  • PUBLIC: 現在のワークスペースのすべてのメンバーがイメージに対して操作を実行できます。

  • PRIVATE: 作成者のみがイメージに対して操作を実行できます。

PUBLIC

GmtModifiedTime

string

イメージが最後に変更された時刻。時刻は UTC で、フォーマットは ISO 8601 です。

2021-01-21T17:12:35.232Z

UserId

string

イメージを作成した Alibaba Cloud アカウントの UID。

155**********904

ParentUserId

string

イメージを作成した Alibaba Cloud アカウントの UID。

155**********904

WorkspaceId

string

ワークスペース ID。

20******55

Size

integer

イメージサイズ (バイト単位)。

2

SourceType

string

イメージソースのタイプ。

SourceId

string

イメージソースの ID。

成功レスポンス

JSONJSON

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "TotalCount": 2,
  "Images": [
    {
      "Name": "tensorflow_2.9",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "Description": "desc",
      "ImageUri": "registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0",
      "Labels": [
        {
          "Key": "system.chipType",
          "Value": "GPU"
        }
      ],
      "ImageId": "image-tzi7f9******s45t",
      "Accessibility": "PUBLIC",
      "GmtModifiedTime": "2021-01-21T17:12:35.232Z\n",
      "UserId": "155**********904",
      "ParentUserId": "155**********904",
      "WorkspaceId": "20******55",
      "Size": 2,
      "SourceType": "",
      "SourceId": ""
    }
  ]
}

エラーコード

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

変更履歴

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