GetTemplateSummary を使用してテンプレート情報を取得する方法 - ROS - Alibaba Cloud -

テンプレートリソースの情報は、関連するテンプレート、スタック、スタックグループ、または変更セットを使用して照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ros:GetTemplateSummary

get

Stack

acs:ros:{#regionId}:{#accountId}:stack/{#StackId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StackId	string	任意	スタック ID。 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、および StackGroupName パラメーターのうち、いずれか 1 つのみ指定できます。	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
TemplateBody	string	任意	テンプレート本文を含む構造です。テンプレート本文の長さは 1～524,288 バイトである必要があります。テンプレート本文の長さが上限を超えた場合は、URL が長すぎることによるリクエストの失敗を防ぐため、HTTP POST リクエストの本文にパラメーターを追加することを推奨します。 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、および StackGroupName パラメーターのうち、いずれか 1 つのみ指定できます。	{"ROSTemplateFormatVersion":"2015-09-01"}
RegionId	string	任意	テンプレートを使用するスタックまたはスタックグループのリージョン ID。 DescribeRegions API を呼び出して、最新のリージョンリストを取得できます。このパラメーターは、StackId、ChangeSetId、または StackGroupName パラメーターのいずれかが指定されている場合にのみ有効です。	cn-hangzhou
TemplateId	string	任意	テンプレートの ID。このパラメーターは、共有テンプレートとプライベートテンプレートに適用されます。 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、および StackGroupName パラメーターのうち、いずれか 1 つのみ指定できます。	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateURL	string	任意	テンプレート本文を含むファイルの URL。 URL は、HTTP または HTTPS の Web サーバー上、あるいは Object Storage Service (OSS) バケット内 (例: oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou) にあるテンプレートを指している必要があります。テンプレート本文の長さは、最大 524,288 バイトです。説明 OSS バケットのリージョン ID を指定しない場合、RegionId の値を使用します。 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、および StackGroupName パラメーターのうち、いずれか 1 つのみ指定できます。 URL の長さは、最大 1,024 バイトです。	oss://ros/template/demo
ChangeSetId	string	任意	変更セット ID。 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、および StackGroupName パラメーターのうち、いずれか 1 つのみ指定できます。	1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateVersion	string	任意	テンプレートバージョン。このパラメーターは、TemplateId が指定されている場合に有効です。	v1
StackGroupName	string	任意	スタックグループ名。 TemplateBody、TemplateURL、TemplateId、StackId、ChangeSetId、および StackGroupName パラメーターのうち、いずれか 1 つのみ指定できます。	my-stack-group
Parameters	array<object>	任意	テンプレートで定義されているパラメーター。
	object	任意
ParameterKey	string	任意	テンプレートで定義されているパラメーター N の名前。パラメーターの名前と値を指定しない場合、Resource Orchestration Service (ROS) はテンプレートで定義されているデフォルトの名前と値を使用します。 N の最大値： 200。説明 Parameters パラメーターはオプションです。 Parameters を指定する場合は、Parameters.N.ParameterKey と Parameters.N.ParameterValue の両方を指定する必要があります。	InstanceId
ParameterValue	string	任意	テンプレートで定義されているパラメーター N の値。 N の最大値： 200。説明 Parameters パラメーターはオプションです。 Parameters を指定する場合は、Parameters.N.ParameterKey と Parameters.N.ParameterValue の両方を指定する必要があります。	i-rotp2e20whfrs2****
ClientToken	string	任意	リクエストのべき等性を保証するために使用するクライアントトークンです。クライアントを使用してトークンを生成できますが、トークンがリクエスト間で一意であることを確認する必要があります。トークンは、文字、数字、ハイフン (-)、アンダースコア (_) を使用でき、長さは最大 64 文字です。詳細については、「べき等性の確保」をご参照ください。	123e4567-e89b-12d3-a456-42665544****

共通リクエストパラメーターの詳細は、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object
ResourceTypes	array	テンプレートで使用するすべてのリソースタイプ。
	string	テンプレートで使用するリソースタイプ。	["ALIYUN::ECS::VPC"]
Description	string	スタックテンプレートの説明。	No description
Parameters	array<object>	テンプレート内のパラメーター宣言のリスト。
	object	テンプレート内の単一のパラメーター宣言。	[{"Description":"", "Label":"Name", "NoEcho":"false", "ParameterKey":"Name", "Type":"String"}]
RequestId	string	リクエスト ID。	B288A0BE-D927-4888-B0F7-B35EF84B6E6
Version	string	テンプレートのバージョン。	2015-09-01
Metadata	object	テンプレートで定義されているメタデータ。	{"key": "value"}
ResourceIdentifierSummaries	array<object>	リソース識別子サマリー。サマリーには、インポートするリソースと、インポート時にリソースを識別するために使用するプロパティが記述されています。たとえば、VpcId は ALIYUN::ECS::VPC の識別子プロパティです。
	object
ResourceType	string	リソースタイプ。説明このリソースタイプでは、リソースインポート機能がサポートされています。	ALIYUN::ECS::VPC
LogicalResourceIds	array	テンプレート内で、ResourceType で指定されたタイプを持つすべてのリソースの論理 ID。
	string	テンプレート内で、ResourceType で指定されたタイプを持つリソースの論理 ID。	["Vpc"]
ResourceIdentifiers	array	リソースプロパティのリスト。リソースプロパティを使用して、管理対象のリソースを識別できます。たとえば、VpcId は ALIYUN::ECS::VPC の識別子プロパティです。
	string	リソースプロパティ。リソースプロパティを使用して、管理対象のリソースを識別できます。たとえば、VpcId は ALIYUN::ECS::VPC の識別子プロパティです。	["VpcId"]

例

成功レスポンス

JSONJSON

{
  "ResourceTypes": [
    "[\"ALIYUN::ECS::VPC\"]"
  ],
  "Description": "No description",
  "Parameters": [
    [
      {
        "Description": "",
        "Label": "Name",
        "NoEcho": "false",
        "ParameterKey": "Name",
        "Type": "String"
      }
    ]
  ],
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
  "Version": "2015-09-01",
  "Metadata": {
    "key": "value"
  },
  "ResourceIdentifierSummaries": [
    {
      "ResourceType": "ALIYUN::ECS::VPC",
      "LogicalResourceIds": [
        "[\"Vpc\"]"
      ],
      "ResourceIdentifiers": [
        "[\"VpcId\"]"
      ]
    }
  ]
}

エラーコード

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

変更履歴

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