DescribeImageComponents - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

1 つ以上のイメージコンポーネントの詳細を照会します。

操作説明

NextToken を前回の DescribeImageComponents 呼び出しで返された NextToken の値にセットし、MaxResults をセットしてページあたりのエントリ数の最大値を指定できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeImageComponents

get

*ImageComponent

acs:ecs:{#regionId}:{#accountId}:imagecomponent/*

*ImageComponent

acs:ecs:{#regionId}:{#accountId}:imagecomponent/{#imagecomponentId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ResourceGroupId	string	任意	リソースグループ ID。このパラメーターを使用してリソースをフィルターする場合、リソース数は 1,000 を超えることはできません。説明デフォルトのリソースグループによるフィルタリングはサポートされていません。	rg-bp67acfmxazb4p****
Tag	array<object>	任意	タグ。
	object	任意
Key	string	任意	タグキー。N の有効な値: 1～20。	TestKey
Value	string	任意	タグ値。N の有効な値: 1～20。	TestValue
Name	string	任意	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	testComponent
NextToken	string	任意	リソースグループ ID。このパラメーターを使用してリソースをフィルターする場合、リソース数は 1,000 を超えることはできません。説明デフォルトのリソースグループによるフィルタリングはサポートされていません。	AAAAAdDWBF2****
MaxResults	integer	任意	イメージコンポーネント名。完全に一致のみサポートされています。	50
Owner	string	任意	ページネーショントークン。このパラメーターを前回の呼び出しで返された NextToken の値に設定します。最初のリクエストではこのパラメーターを設定する必要はありません。	SELF
ImageComponentId	array	任意	ページングのページあたりのエントリ数の最大値。有効な値: 1～500。デフォルト値: 50。	ic-bp67acfmxazb4p****
	string	任意	クエリするイメージコンポーネントの ID。N の有効な値: 1～20。	ic-bp67acfmxazb4p****
ComponentType	string	任意	イメージコンポーネントタイプ。有効な値: SELF: 自分で作成したカスタムイメージコンポーネント。 ALIYUN: Alibaba Cloud が提供するシステムコンポーネント。	Build
SystemType	string	任意	クエリするイメージコンポーネントの ID。N の有効な値: 1～20。	Linux
ComponentVersion	string	任意	コンポーネントタイプ。有効な値: Build Test。	1.0.*
		任意	コンポーネントがサポートするオペレーティングシステム。有効な値: Linux Windows。
		任意	major.minor.パッチ初期化のコンポーネントバージョン番号。各部分は非負の整数である必要があります。ワイルドカード (*) を使用して、1 つの部分を置き換えてあいまい一致を行うこともできます。説明このパラメーターは Name が指定されている場合にのみ効果があります。

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	この呼び出しで返されたページネーショントークン。このトークンの使用方法については、操作の説明を参照してください。	AAAAAdDWBF2****
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返されたイメージコンポーネントの総数。	1
MaxResults	integer	ページングのページあたりのエントリ数の最大値。	50
ImageComponent	object
ImageComponentSet	array<object>	イメージコンポーネントの詳細のリスト。
	array<object>
CreationTime	string	コンポーネントが作成された時間。	2020-11-24T06:00:00Z
Description	string	説明。	This is description.
SystemType	string	コンポーネントがサポートするオペレーティングシステム。	Linux
ImageComponentId	string	イメージコンポーネントの ID。	ic-bp67acfmxazb4p****
ComponentType	string	コンポーネントタイプ。	Build
ResourceGroupId	string	リソースグループ ID。	rg-bp67acfmxazb4p****
Name	string	コンポーネント名。	testComponent
Content	string	コンポーネントの内容。	Tasks: - Name: HelloWorld Action: RunShellCommand Properties: commandContent: echo hello world
Owner	string	イメージコンポーネントタイプ。有効な値: SELF: 自分で作成したカスタムイメージコンポーネント。 ALIYUN: Alibaba Cloud が提供するシステムコンポーネント。	SELF
Tags	object
Tag	array<object>	タグキーと値のペアのリスト。
	object
TagValue	string	タグ値	TestValue
TagKey	string	タグキー	TestKey
ComponentVersion	string	コンポーネントのバージョン番号。	1.0.0
Parameters	object
Parameter	array<object>	イメージコンポーネントに含まれるパラメーターのリスト。
	object
Name	string	パラメーター名。	paramName
Type	string	パラメータータイプ。有効な値: String Number Boolean。	String
DefaultValue	string	パラメーターのデフォルト値。	paramDefaultValue

例

成功レスポンス

JSONJSON

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImageComponent": {
    "ImageComponentSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "Description": "This is description.",
        "SystemType": "Linux",
        "ImageComponentId": "ic-bp67acfmxazb4p****",
        "ComponentType": "Build",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Name": "testComponent",
        "Content": "Tasks:\n  - Name: HelloWorld\n    Action: RunShellCommand\n    Properties:\n      commandContent: echo hello world\n",
        "Owner": "SELF",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ComponentVersion": "1.0.0",
        "Parameters": {
          "Parameter": [
            {
              "Name": "paramName",
              "Type": "String",
              "DefaultValue": "paramDefaultValue"
            }
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.Owner	The specified parameter \"Owner\" is not valid.
400	InvalidImageComponentIdSize.ExceededMaxNumber	%s
400	InvalidSystemType.NotSupportedValue	%s.
400	InvalidComponentType.NotSupportedValue	%s.
400	InvalidParameter.ComponentVersion	The specified ComponentVersion is invalid.
403	Invalid.NextToken	The specified NextToken is not valid.

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

変更履歴

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