すべてのプロダクト
Search

このプロダクト

    :関数ごとのAPI操作の一覧

    ドキュメントセンター

    :関数ごとのAPI操作の一覧

    最終更新日:Sep 29, 2025

    次の表に、ROS (Resource Orchestration Service) で使用できるAPI操作を示します。

    スタック操作

    スタック内のリソースとその依存関係のテンプレートを定義し、そのテンプレートを使用してスタックを作成できます。 スタックの作成後、スタックを照会、更新、または削除できます。

    API説明
    PreviewStack指定したテンプレートを使用して作成するスタックをプレビューします。
    CreateStackスタックを作成します。
    ContinueCreateStack失敗した前のスタックのテンプレートに基づいて別のスタックを作成します。
    SetDeletionProtectionスタックの削除保護を設定します。
    UpdateStackスタックを更新します。
    CancelUpdateStackスタックの更新をキャンセルします。
    GetStackスタックの情報を照会します。
    リストスタックスタックのリストを照会します。
    ListStackEventsスタックとそのリソースイベントを照会します。
    ListStackOperationRisksスタック削除操作によって発生するリスクが高いリソースを検出し、リスクごとに理由を照会します。
    DeleteStackスタックとそのすべてのリソースを削除します。

    リソース操作

    ROSを使用すると、さまざまなリソースを管理できます。 リソーステンプレートをリソースタイプ別に照会するか、指定したスタック内のリソースタイプまたはリソースの詳細を照会して、ROS内のリソースの情報を取得できます。

    ROSでサポートされているリソースタイプの詳細については、「サービス別のリソースタイプのリスト」をご参照ください。

    API説明
    GetResourceTypeTemplateリソースのテンプレートをリソースタイプごとに照会します。
    ListStackResources指定したスタックのリソースリストを照会します。
    GetStackResource指定されたスタック内のリソースに関する情報を照会します。
    GetResourceTypeリソースタイプの詳細を照会します。
    ListResourceTypesサポートされているリソースタイプのリストを照会します。
    MoveResourceGroupリソースを特定のリソースグループに移動します。

    シナリオ操作

    ROSは、リソース管理を容易にするシナリオ機能を提供します。 コンソールでシナリオにリソースを追加し、リソースのレプリケーションや集中管理などの操作を実行できます。

    API説明
    CreateTemplateScratchシナリオを作成します。
    UpdateTemplateScratchシナリオを更新します。
    ListTemplateScratchesシナリオのリストを照会します。
    GetTemplateScratchシナリオの情報を照会します。
    DeleteTemplateScratchシナリオを削除します。
    GenerateTemplateByScratchシナリオテンプレートを生成します。

    テンプレート操作

    テンプレートは、スタック内のリソースとその依存関係を定義するJSONまたはYAMLテキストファイルで、スタックの作成に使用できます。 たとえば、CreateTemplate操作を呼び出してALIYUN::ECS::VPCリソースを含むテンプレートを作成し、CreateStack操作を呼び出してスタックを作成します。 これにより、仮想プライベートクラウド (VPC) を作成できます。

    さらに、テンプレートID、テンプレートコンテンツ、またはテンプレートで定義されているリソース価格を照会できます。 テンプレートを他のユーザーと共有することもできます。 これにより、複数のAlibaba Cloudアカウントで1つのテンプレートを使用して、スタックを効率的に作成できます。

    API説明
    GenerateTemplatePolicyテンプレートのポリシー情報を生成します。
    CreateTemplateテンプレートを作成します。
    ValidateTemplateスタックの作成に使用するテンプレートを検証します。
    UpdateTemplateテンプレートを更新します。
    GetTemplateテンプレートに関連付けられているスタックや変更セットなど、テンプレートの詳細情報を照会します。
    GetTemplateEstimateCostテンプレートに基づいて作成されるリソースの推定価格を照会します。
    GetTemplateSummary新規または既存のテンプレートの情報を照会します。
    GetTemplateParameterConstraintsテンプレートパラメーターの値を照会します。
    ListTemplatesテンプレートのリストを照会します。
    ListTemplateVersionsテンプレートの1つ以上のバージョンを照会します。
    SetTemplatePermissionテンプレートを共有または共有解除します。
    DeleteTemplateテンプレートを削除します。

    スタックポリシー操作

    スタックポリシーは、指定されたスタックの更新操作を定義して、スタックの更新中にスタック内のリソースが誤って更新または削除されないようにするために使用されるJSONまたはYAMLテキストファイルです。 スタックポリシーを設定または照会できます。

    API説明
    SetStackPolicyスタックポリシーを設定します。
    GetStackPolicyスタックポリシーの情報を照会します。

    セット操作の変更

    変更セットを作成および実行して、実行中のスタックを更新できます。

    API説明
    CreateChangeSet変更セットを作成します。
    ExecuteChangeSet変更セットを実行します。
    GetChangeSet変更セットの情報を照会します。
    ListChangeSets変更セットのリストを照会します。
    DeleteChangeSet変更セットを削除します。

    スタックグループ操作

    スタックグループをユニットとして使用して、ROSでスタックを管理できます。 テンプレートを使用してスタックグループを作成できます。 これにより、リージョン間で複数のAlibaba Cloudアカウント内にスタックを作成できます。 スタックグループとスタックグループ操作の情報を照会することもできます。

    CreateStackGroup操作を呼び出してスタックグループを作成した後、CreateStackInstances操作を呼び出して、指定したリージョンの指定したアカウント内にスタックインスタンスを作成できます。

    説明 DeleteStackGroup操作を呼び出してスタックグループを削除する前に、DeleteStackInstances操作を呼び出して、スタックグループからすべてのスタックインスタンスを削除する必要があります。
    API説明
    CreateStackGroupスタックグループを作成します。
    UpdateStackGroupスタックグループを更新します。
    GetStackGroupスタックグループの情報を照会します。
    ListStackGroupsスタックグループのリストを照会します。
    GetStackGroupOperationスタックグループ操作の情報を照会します。
    ListStackGroupOperationsスタックグループ操作のリストを照会します。
    ListStackGroupOperationResultsスタックグループに対する操作の結果を照会します。
    StopStackGroupOperationスタックグループ操作を停止します。
    CreateStackInstances指定したリージョンの指定したアカウント内にスタックインスタンスを作成します。
    UpdateStackInstances指定したリージョンの指定したアカウント内のスタックインスタンスを更新します。
    GetStackInstanceスタックグループに関連付けられているスタックインスタンスの詳細情報を照会します。
    ListStackInstancesスタックグループに関連付けられているスタックインスタンスを照会します。
    DeleteStackInstances指定したリージョンの指定したアカウント内のスタックインスタンスを削除します。
    DeleteStackGroupスタックグループを削除します。

    ドリフト検出操作

    ROSの制御が及ばないサービスを使用してリソース構成を変更すると、関連するスタックまたはスタックグループがドリフトする可能性があります。 ドリフト検出を実行してドリフトを修正できます。 たとえば、DetectStackDrift操作を呼び出して、スタックのドリフト検出を実行できます。 スタックがドリフトしている場合は、UpdateStackTemplateByResourcesを呼び出してスタックテンプレートを変更し、スタックドリフトを解消できます。

    API説明
    DetectStackResourceDriftスタック内の個々のリソースのドリフトを検出します。
    DetectStackDriftスタック上のドリフトを検出します。
    DetectStackGroupDriftスタックグループのドリフトを検出します。
    GetStackDriftDetectionStatusスタックのドリフト検出ステータスを照会します。
    ListStackResourceDrifts指定したスタック内のリソースのドリフト情報を照会します。
    UpdateStackTemplateByResourcesテンプレートを修正してスタックドリフトを除去します。

    タグ操作

    分類と管理の目的で、スタック、スタックグループ、またはテンプレートにタグを追加できます。

    API説明
    TagResources指定したROSリソースリストにタグを作成して追加します。
    ListTagResources1つ以上のROSリソースに追加されたタグを照会します。
    ListTagKeysタグキーのリストを照会します。
    ListTagValues指定されたタグキーの1つ以上の値を照会します。
    UntagResources指定したROSリソースリストからタグを削除および削除します。

    その他の操作

    スタック、スタックグループ、またはスタックインスタンスを作成するときは、RegionIdパラメーターを指定する必要があります。 この場合、DescribeRegions操作を呼び出して、最新のリージョンリストを照会できます。

    スタックを作成または更新するときに、SignalResource操作を呼び出してシグナルを送信できます。 障害信号により、スタックの作成または更新が失敗する可能性があります。

    さらに、GetServiceProvisionsを呼び出して複数のクラウドサービスのアクティベーションステータスとRAMロール情報を同時に照会し、GetFeatureDetailsを呼び出してROSでサポートされている特定の機能の詳細を照会できます。

    API説明
    DescribeRegions利用可能なリージョンを照会します。
    SignalResource信号を送信します。
    GetServiceProvisionsAlibaba CloudサービスのアクティベーションステータスとRAMロールを照会します。
    GetFeatureDetailsROSでサポートされている機能の詳細を照会します。