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

DescribeLaunchTemplates 操作を呼び出します。TemplateTag、TemplateResourceGroupId、LaunchTemplateId などのパラメーターを指定して、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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeLaunchTemplates

get

LaunchTemplate

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

LaunchTemplate

acs:ecs:{#regionId}:{#accountId}:launchtemplate/{#launchtemplateId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
TemplateTag	array<object>	任意	起動テンプレートのタグキーと値のペアのリスト。説明現在、起動テンプレートタグの作成とクエリは API 操作の呼び出しによってのみ可能です。コンソールでは起動テンプレートタグの作成や表示はサポートされていません。
	object	任意	起動テンプレートのタグキーと値のペアの情報。
Key	string	任意	起動テンプレートのタグキー。N の有効な値: 1～20。単一のタグを使用してリソースをフィルターする場合、指定されたタグを持つリソースの数は 1000 を超えることはできません。複数のタグを使用してリソースをフィルターする場合、指定されたすべてのタグがバインドされたリソースの数は 1000 を超えることはできません。リソースの数が 1000 を超える場合は、 ListTagResources 操作を呼び出してクエリしてください。	TestKey
Value	string	任意	起動テンプレートのタグ値。N の有効な値: 1～20。	TestValue
PageNumber	integer	任意	起動テンプレートリストのページ番号。最小値: 1。デフォルト値: 1。	1
PageSize	integer	任意	ページネーションクエリの 1 ページあたりのエントリ数。デフォルト値: 10。	10
TemplateResourceGroupId	string	任意	起動テンプレートが属するリソースグループの ID。このパラメーターを使用してリソースをフィルターする場合、リソースの数は 1000 を超えることはできません。説明デフォルトのリソースグループによるフィルタリングはサポートされていません。	rg-acfmxazb4p****
LaunchTemplateId	array	任意	1 つ以上の起動テンプレート ID の配列。一度に最大 100 個の起動テンプレートをクエリできます。テンプレートを特定するには、LaunchTemplateId または LaunchTemplateName を指定する必要があります。	lt-m5e3ofjr1zn1aw7q****
	string	任意	起動テンプレート ID。一度に最大 100 個の起動テンプレートをクエリできます。テンプレートを特定するには、LaunchTemplateId または LaunchTemplateName を指定する必要があります。	lt-m5e3ofjr1zn1aw7q****
LaunchTemplateName	array	任意	1 つ以上の起動テンプレート名の配列。一度に最大 100 個の起動テンプレートをクエリできます。テンプレートを特定するには、LaunchTemplateId または LaunchTemplateName を指定する必要があります。	wd-152630748****
	string	任意	起動テンプレートの名前。一度に最大 100 個の起動テンプレートをクエリできます。テンプレートを特定するには、LaunchTemplateId または LaunchTemplateName を指定する必要があります。	wd-152630748****

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	ページあたりのエントリ数	10
RequestId	string	リクエスト ID	04F0F334-1335-436C-A1D7-6C044FE12CBA
PageNumber	integer	現在のページ番号。	1
TotalCount	integer	起動テンプレートの総数。	1
LaunchTemplateSets	object
LaunchTemplateSet	array<object>	起動テンプレート情報のリスト。
	array<object>	起動テンプレートの情報。
LaunchTemplateName	string	起動テンプレートの名前。	wd-152630748****
DefaultVersionNumber	integer	起動テンプレートのデフォルトのバージョン番号。	1
ModifiedTime	string	バージョンが起動テンプレートに追加または削除された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は協定世界時 (UTC) で表示されます。	2018-05-14T14:18:00Z
LaunchTemplateId	string	起動テンプレートの ID。	lt-m5e3ofjr1zn1aw7q****
CreateTime	string	起動テンプレートが作成された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は協定世界時 (UTC) で表示されます。	2018-05-14T14:18:00Z
ResourceGroupId	string	起動テンプレートが属するリソースグループの ID。	rg-acfmxazb4p****
CreatedBy	string	起動テンプレートを作成した Alibaba Cloud アカウントの ID。	20169351435666****
LatestVersionNumber	integer	起動テンプレートの最新バージョン番号。	1
Tags	object
Tag	array<object>	起動テンプレートのタグ。説明 API オペレーションの呼び出しによってのみ、起動テンプレートのタグの追加と照会ができます。ECS コンソールでは、起動テンプレートのタグの追加や表示はできません。
	object	起動テンプレートのタグ。
TagValue	string	起動テンプレートのタグキー。	TestValue
TagKey	string	起動テンプレートのタグ値。	TestKey

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE12CBA",
  "PageNumber": 1,
  "TotalCount": 1,
  "LaunchTemplateSets": {
    "LaunchTemplateSet": [
      {
        "LaunchTemplateName": "wd-152630748****",
        "DefaultVersionNumber": 1,
        "ModifiedTime": "2018-05-14T14:18:00Z",
        "LaunchTemplateId": "lt-m5e3ofjr1zn1aw7q****",
        "CreateTime": "2018-05-14T14:18:00Z",
        "ResourceGroupId": "rg-acfmxazb4p****",
        "CreatedBy": "20169351435666****",
        "LatestVersionNumber": 1,
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidRegion.NotExist	%s
400	MissingParameter	%s
400	InvalidParameter	%s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	InnerServiceFailed	%s
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

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

変更履歴

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