API 概要 - Resource Orchestration Service - Alibaba Cloud ドキュメントセンター

API 標準および多言語対応の SDK

本製品 (ROS/2019-09-10) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。

カスタム署名

署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。

はじめに

Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。

API セキュリティを確保するには、以下を作成し、設定する必要があります。

RAM ユーザー
RAM ユーザー用の AccessKey ペア

スタック操作

API	タイトル	説明
CreateStack	CreateStack	ROS テンプレートからスタックを作成し、一連のリソースをデプロイします。
UpdateStack	UpdateStack	スタック内のリソースを更新します。
PreviewStack	PreviewStack	テンプレートに基づき、作成または更新するスタックの情報をプレビューします。この API を呼び出して、テンプレート内のリソースが有効かどうかを検証できます。

シナリオ操作

API	タイトル	説明
CreateTemplateScratch	CreateTemplateScratch	テンプレートスクラッチ (シナリオ) を作成します。

テンプレート操作

API	タイトル	説明
CreateTemplate	CreateTemplate	カスタムテンプレートを作成します。
ListTemplates	List Templates	プライベートテンプレートと共有テンプレートの一覧を照会します。
GetTemplateParameterConstraints	GetTemplateParameterConstraints	テンプレート内のパラメーターの有効な値を照会します。
ValidateTemplate	ValidateTemplate	テンプレート URL または本文を指定して、スタックの作成に使用するテンプレートを検証します。

変更セット関連の API オペレーション

API	タイトル	説明
CreateChangeSet	CreateChangeSet	スタックの変更セットを作成し、実行前に変更をプレビューできるようにします。
GetChangeSet	GetChangeSet	指定の変更セットの詳細を返します。オプションで、関連するテンプレートの詳細も含めることができます。
ListChangeSets	ListChangeSets	作成済みの変更セットの詳細を照会します。

スタックグループの操作

API	タイトル	説明
CreateStackGroup	CreateStackGroup	ROS テンプレートからスタックグループを作成し、複数の Alibaba Cloud アカウントとリージョンにまたがってスタックを作成します。
UpdateStackGroup	UpdateStackGroup	既存のスタックグループを更新します。
ListStackGroups	ListStackGroups	リージョン内のスタックグループを照会します。
GetStackGroup	GetStackGroup	Alibaba Cloud リージョン内のスタックグループの詳細を名前で照会します。
CreateStackInstances	CreateStackInstances	指定された複数のリージョンで、1 つ以上のアカウントに対してスタックインスタンスを作成します。

タグ操作

API	タイトル	説明
TagResources	TagResources	リソースにタグを作成・付与します。
ListTagKeys	ListTagKeys	指定したリージョン内のスタックまたはテンプレートのタグキーを照会します。

リソースタイプのオペレーション

API	タイトル	説明
SetResourceType	SetResourceType	リソースタイプ、またはそのバージョンの説明を変更します。
DeregisterResourceType	DeregisterResourceType	リソースタイプ、またはその特定のバージョンを削除します。
ListResourceTypes	ListResourceTypes	サポートされているリソースタイプの一覧を照会します。
GetResourceTypeTemplate	GetResourceTypeTemplate	リソースタイプに基づいてサンプルテンプレートを生成します。
GetResourceType	GetResourceType	属性、プロパティ、サポートされている機能などを含むリソースタイプを照会します。
ListResourceTypeVersions	ListResourceTypeVersions	ユーザーが作成したバージョンや ROS が提供するバージョンなど、リソースタイプのバージョンを照会します。

その他の操作

API	タイトル	説明
GetServiceProvisions	GetServiceProvisions	Alibaba Cloud サービスの有効化ステータスと、サービスにリンクされたロールの情報を照会します。
GetFeatureDetails	GetFeatureDetails	Resource Orchestration Service (ROS) がサポートする機能の詳細を照会します。

API 概要：その他

API	タイトル	説明
CancelStackOperation	CancelStackOperation	スタックのオペレーションをキャンセルします。
CancelUpdateStack	CancelUpdateStack	スタックの更新オペレーションをキャンセルします。スタックの更新中または作成中に、このオペレーションを呼び出すことで、スタックの更新をキャンセルできます。
ContinueCreateStack	ContinueCreateStack	スタックの作成に失敗した後、作成を続行します。
CreateAITask	Create AI Task	AI タスクを作成します。
CreateDiagnostic	CreateDiagnostic	診断タスクを作成します。
DeleteChangeSet	DeleteChangeSet	変更セットを削除します。
DeleteDiagnostic	DeleteDiagnostic	診断レコードを削除します。
DeleteStack	DeleteStack	必要に応じてリソースを保持したまま、スタックを削除します。
DeleteStackGroup	DeleteStackGroup	スタックグループを削除します。
DeleteStackInstances	DeleteStackInstances	指定したアカウントとリージョンからスタックインスタンスを削除します。リソースを保持することもできます。
DeleteTemplate	DeleteTemplate	テンプレートを削除します。
DeleteTemplateScratch	DeleteTemplateScratch	シナリオを削除します。
DescribeRegions	DescribeRegions	利用可能なリージョンの一覧を照会します。
DetectStackDrift	DetectStackDrift	スタック内のリソースに対してドリフト検出を実行し、リソースが想定されるテンプレートの構成からドリフトしているかどうかを確認します。
DetectStackGroupDrift	DetectStackGroupDrift	スタックグループに対してドリフト検出を実行し、想定されるテンプレートの構成からドリフトしているかどうかを確認します。
DetectStackResourceDrift	DetectStackResourceDrift	スタック内のリソースに対してドリフト検出を実行し、想定される構成からドリフトしているかどうかを判断します。
EnableServiceAccess	EnableServiceAccess	信頼されたサービスアクセスを有効にします。
EnableServices	EnableServices	サービスを一括で有効にします。
ExecuteChangeSet	ExecuteChangeSet	変更セットを実行します。
GenerateTemplateByScratch	GenerateTemplateByScratch	リソースシナリオのテンプレートを生成します。
GenerateTemplatePolicy	GenerateTemplatePolicy	テンプレートを使用してポリシー情報を生成します。
GetAITask	GetAITask	タスク ID に基づいて AI タスクの情報を照会します。
GetDiagnostic	GetDiagnostic	指定した診断レポート ID に基づいて診断の詳細を取得します。
GetServiceAccess	GetServiceAccess	信頼されたサービスのアクセスステータスを照会します。
GetStack	GetStack	スタックの情報を照会します。
GetStackDriftDetectionStatus	GetStackDriftDetectionStatus	スタックのドリフト検出ステータスを照会します。
GetStackGroupOperation	GetStackGroupOperation	Alibaba Cloud のリージョンにおけるスタックグループのオペレーションの情報を照会します。
GetStackInstance	GetStackInstance	スタックグループに関連付けられているスタックインスタンスの情報を照会します。
GetStackPolicy	GetStackPolicy	指定したスタックのスタックポリシーを照会します。
GetStackResource	GetStackResource	スタック内の指定されたリソースの情報を照会します。
GetTemplate	GetTemplate	スタック、スタックグループ、変更セット、または任意のカスタムテンプレートの情報を使用して、テンプレートの詳細を照会します。
GetTemplateEstimateCost	GetTemplateEstimateCost	テンプレート内のリソースの見積価格を照会します。
GetTemplateScratch	GetTemplateScratch	リソースシナリオの詳細を照会します。
GetTemplateSummary	GetTemplateSummary	該当するテンプレート、スタック、スタックグループ、または変更セットを使用して、テンプレートリソースの情報を照会します。
ImportStacksToStackGroup	ImportStacksToStackGroup	複数の異なるアカウントからスタックをスタックグループにインポートします。
ListAITaskEvents	ListAITaskEvents	AI タスクのイベントを照会します。
ListAITasks	ListAITasks	AI タスクの一覧を照会します。
ListDiagnostics	ListDiagnostics	診断レポートの一覧を照会します。
ListResourceTypeRegistrations	ListResourceTypeRegistrations	リソース登録レコードの一覧を照会します。
ListStackEvents	ListStackEvents	スタックおよびそのリソースイベントを照会します。
ListStackGroupOperationResults	ListStackGroupOperationResults	スタックグループオペレーションの結果一覧を照会します。
ListStackGroupOperations	ListStackGroupOperations	Alibaba Cloud のリージョンにおけるスタックグループオペレーションの一覧を照会します。
ListStackInstances	ListStackInstances	Alibaba Cloud のリージョンにおけるスタックグループに関連付けられているスタックインスタンスの一覧を照会します。
ListStackOperationRisks	ListStackOperationRisks	スタック関連のオペレーションリスクを検出し、不足している権限とリスクの原因を返します。
ListStackResourceDrifts	ListStackResourceDrifts	スタック内のリソースのドリフトの一覧を照会します。
ListStackResources	ListStackResources	スタック内のリソースの一覧を照会します。この例では、中国 (杭州) リージョンにある ID が `4a6c9851-3b0f-4f5f-b4ca-a14bf691\* \* \* \* \` のスタック内のリソースを照会します。
ListStacks	ListStacks	スタックの一覧を照会します。
ListSummaries	ListSummaries	概要の一覧を照会します。
ListTagResources	ListTagResources	Alibaba Cloud リージョン内のテンプレートまたはスタックのリソースに追加されたタグの一覧を照会します。
ListTagValues	ListTagValues	Alibaba Cloud リージョン内のテンプレートまたはスタックのリソースに追加されたタグ値の一覧を照会します。
ListTemplateScratches	ListTemplateScratches	シナリオの一覧を照会します。
ListTemplateVersions	ListTemplateVersions	テンプレートのバージョンの一覧を照会します。
MoveResourceGroup	MoveResourceGroup	リソースを特定のリソースグループに移動します。
RegisterResourceType	RegisterResourceType	新しいリソースタイプを作成するか、既存のリソースタイプの新しいバージョンを作成します。
SetDeletionProtection	SetDeletionProtection	スタックの削除保護設定を変更します。
SetStackPolicy	SetStackPolicy	スタックのスタックポリシーを設定します。
SetTemplatePermission	SetTemplatePermission	テンプレートを共有または共有解除します。
SignalResource	SignalResource	スタック内のリソースにシグナルを送信します。
StopStackGroupOperation	StopStackGroupOperation	スタックグループで進行中のオペレーションを停止します。
UntagResources	UntagResources	リソースからタグを削除してから、タグを削除します。
UpdateStackInstances	UpdateStackInstances	指定したリージョン内の 1 つ以上のアカウントに対して、スタックインスタンスを更新します。
UpdateStackTemplateByResources	UpdateStackTemplateByResources	ドリフト検出を実行してスタックドリフトを解消します。
UpdateTemplate	Update Template	テンプレートを更新します。
UpdateTemplateScratch	UpdateTemplateScratch	シナリオを更新します。