ListCustomImages API を使用したカスタムイメージのクエリ - SAS

指定されたリージョン内のカスタムイメージの情報を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

swas-open:ListCustomImages

get

*CustomImage

acs:swas-open:{#regionId}:{#accountId}:customimage/*

*CustomImage

acs:swas-open:{#regionId}:{#accountId}:customimage/{#CustomImageId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	カスタムイメージに対応するシンプルアプリケーションサーバーのリージョン ID。 ListRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。 ClientToken の値は ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。	123e4567-e89b-12d3-a456-426655440000
ImageIds	string	任意	シンプルアプリケーションサーバーのイメージ ID。値は、最大 100 個のイメージ ID で構成される JSON 配列です。複数のイメージ ID はコンマ (,) で区切ります。	["fe9c66133a9d4688872869726b52**", "794c230fd3e64ea19f83f4d7a0ad**"]
PageSize	integer	任意	1ページあたりのエントリ数。最大値：100。デフォルト値：10。	10
PageNumber	integer	任意	ページ番号。デフォルト値：1。	1
ImageNames	string	任意	シンプルアプリケーションサーバーのイメージ名。値は、最大 100 個のイメージ名で構成される JSON 配列です。複数のイメージ名はコンマ (,) で区切ります。	["test1**", "test2**"]
SystemSnapshotId	string	任意	システムディスクのスナップショット ID。	s-bp14m09pq8***0g6
DataSnapshotId	string	任意	データディスクのスナップショット ID。	s-acscasca****
Tag	array<object>	任意	カスタムイメージのタグ N。
	object	任意	カスタムイメージのタグ。
Key	string	任意	タグ N のキー。タグキーの長さは 1～64 文字です。 N の有効値：1～20。	TestKey
Value	string	任意	タグ N の値。タグ値の長さは最大 64 文字です。 N の有効値：1～20。	TestValue
ResourceGroupId	string	任意	リソースグループの ID。	rg-aek2bti7cf7yj2i
Share	boolean	任意	共有イメージを照会するかどうかを指定します。有効値： False：共有イメージを照会しません。共有イメージはレスポンスに含まれません。 True：共有イメージを照会します。共有イメージはレスポンスに含まれます。このパラメーターを指定しない場合、すべてのイメージが返されます。	False
InstanceId	string	任意	イメージの派生元であるシンプルアプリケーションサーバーの ID。	ace0706b2ac4454d984295a94213****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
CustomImages	array<object>	照会されたカスタムイメージの配列。
	array<object>	配列オブジェクトに関する情報。
CreationTime	string	スナップショットが作成された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は UTC です。	2022-10-09T02:28:06Z
DataSnapshotName	string	データディスクのスナップショットの名前。	数据盘快照
SystemSnapshotId	string	システムディスクのスナップショット ID。	s-bp1h173hj21puxb***
InShare	boolean	カスタムイメージが Elastic Compute Service (ECS) に共有されているかどうかを示します。	false
InShareUser	boolean	カスタムイメージがアカウント間で共有されているかどうかを示します。	False
InstanceId	string	イメージの派生元であるシンプルアプリケーションサーバーの ID。	2d06ee0520b44de1ae88d4be****
DataSnapshotId	string	データディスクのスナップショット ID。	s-bp19rn9u8eqzlfb***
RegionId	string	リージョン ID。	cn-hangzhou
SystemSnapshotName	string	システムディスクのスナップショットの名前。	系统盘快照
Description	string	カスタムイメージの説明。	自定义镜像-1
Name	string	カスタムイメージの名前。	test
ImageId	string	カスタムイメージの ID。	m-bp1e79zktg26n2b***
Status	string	カスタムイメージのステータス。有効値： 0：コピー中 1：利用可能 2：利用不可 3：作成失敗 4：作成中	1
Tags	array<object>	カスタムイメージのタグ。
	object	カスタムイメージのタグ。
Key	string	カスタムイメージのタグキー。	TestKey
Value	string	カスタムイメージのタグ値。	TestValue
InstanceName	string	シンプルアプリケーションサーバーの名前。	swas-asdf23***
ResourceGroupId	string	リソースグループの ID。	rg-acfm2h2lvp3ublq
CreateInstances	array	イメージから作成されたシンプルアプリケーションサーバー。
	string	イメージから作成されたシンプルアプリケーションサーバーの ID。	9ffb716db6ae406ca78a476c0c81****
UserId	integer	イメージが属する Alibaba Cloud アカウントの ID。	180185828710****
OsType	string	イメージのオペレーティングシステムタイプ。	Linux
RequiredSystemDiskSize	integer	イメージのシステムディスクのサイズ。単位：GB。	20
RequiredDataDiskSize	integer	イメージのデータディスクのサイズ。単位：GB。	20
SourceImageName	string	シンプルアプリケーションサーバーの作成に使用されるソースイメージの名前。	CentOS
SourceImageVersion	string	シンプルアプリケーションサーバーの作成に使用されるソースイメージのバージョン。	8.0
TotalCount	string	返されたエントリの総数。	4
PageSize	string	1ページあたりのエントリ数。	10
PageNumber	string	ページ番号。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "CustomImages": [
    {
      "CreationTime": "2022-10-09T02:28:06Z",
      "DataSnapshotName": "数据盘快照",
      "SystemSnapshotId": "s-bp1h173hj21puxb***",
      "InShare": false,
      "InShareUser": true,
      "InstanceId": "2d06ee0520b44de1ae88d4be****",
      "DataSnapshotId": "s-bp19rn9u8eqzlfb***",
      "RegionId": "cn-hangzhou",
      "SystemSnapshotName": "系统盘快照",
      "Description": "自定义镜像-1",
      "Name": "test",
      "ImageId": "m-bp1e79zktg26n2b***",
      "Status": "1",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "InstanceName": "swas-asdf23***",
      "ResourceGroupId": "rg-acfm2h2lvp3ublq",
      "CreateInstances": [
        "9ffb716db6ae406ca78a476c0c81****"
      ],
      "UserId": 0,
      "OsType": "Linux",
      "RequiredSystemDiskSize": 20,
      "RequiredDataDiskSize": 20,
      "SourceImageName": "CentOS",
      "SourceImageVersion": "8.0"
    }
  ],
  "TotalCount": "4",
  "PageSize": "10",
  "PageNumber": "1"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	An error occurred while processing your request.

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

変更履歴

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