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

指定されたリージョンで作成された 1 つ以上のカスタムイメージの情報をフォーマットして照会します。

今すぐお試しください

この 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 文字以下である必要があります。詳細については、「べき等性を確保する方法」をご参照ください。このトークンのフォーマットは ASCII 文字のみです。	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 個のインスタンス ID で構成される JSON 配列にすることができます。複数のインスタンス ID はコンマ (,) で区切ります。	["test1**", "test2**"]
SystemSnapshotId	string	任意	システムクラウドディスクのスナップショット ID。	s-bp14m09pq8***0g6
DataSnapshotId	string	任意	データクラウドディスクのスナップショット ID。	s-acscasca****
Tag	array<object>	任意	カスタムイメージのタグ。
	object	任意	タグ。
Key	string	任意	カスタムイメージのタグキー。タグキーのキー長の有効な値: 1～64。N の有効な値: 1～20。	TestKey
Value	string	任意	カスタムイメージのタグ値。タグ値の長さの有効な値: 1～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	スナップショットが作成された時間。時間は ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ フォーマットで表示されます。時間は協定世界時 (UTC) で表示されます。	2022-10-09T02:28:06Z
DataSnapshotName	string	データクラウドディスクのスナップショット名。	DataDiskSnapshot
SystemSnapshotId	string	システムクラウドディスクのスナップショット ID。	s-bp1h173hj21puxb***
InShare	boolean	カスタムイメージが ECS に共有されているかどうかを示します。	false
InShareUser	boolean	カスタムイメージがアカウント間で共有されているかどうかを示します。	False
InstanceId	string	イメージの作成元のシンプルアプリケーションサーバーのインスタンス ID。	2d06ee0520b44de1ae88d4be****
DataSnapshotId	string	データクラウドディスクのスナップショット ID。	s-bp19rn9u8eqzlfb***
RegionId	string	リージョン ID。	cn-hangzhou
SystemSnapshotName	string	システムクラウドディスクのスナップショット名。	SystemDiskSnapshot
Description	string	説明。	CustomImage-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	イメージから作成されたインスタンスの情報。フォーマットは JSON 配列です。
	string	イメージから作成されたインスタンスのインスタンス ID。	9ffb716db6ae406ca78a476c0c81****
UserId	integer	イメージのオーナーの Alibaba Cloud アカウント ID。	180185828710****
OsType	string	イメージのオペレーティングシステムタイプ。	Linux
RequiredSystemDiskSize	integer	イメージのシステムクラウドディスクサイズ。単位: GiB。	20
RequiredDataDiskSize	integer	イメージのデータクラウドディスクサイズ。単位: GiB。	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": "Data disk snapshot",
      "SystemSnapshotId": "s-bp1h173hj21puxb***",
      "InShare": false,
      "InShareUser": true,
      "InstanceId": "2d06ee0520b44de1ae88d4be****",
      "DataSnapshotId": "s-bp19rn9u8eqzlfb***",
      "RegionId": "cn-hangzhou",
      "SystemSnapshotName": "System disk snapshot",
      "Description": "Custom image-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.

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

変更履歴

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