すべてのプロダクト
Search

このプロダクト

    :GetTemplateEstimateCost

    ドキュメントセンター

    :GetTemplateEstimateCost

    最終更新日:Jun 04, 2026

    テンプレート内のリソースの概算価格を照会します。

    操作説明

    • Resource Orchestration Service (ROS) テンプレートで価格照会をサポートするリソースの詳細については、「リソース価格の概算」トピックの「価格照会をサポートするリソースタイプ」セクションをご参照ください。

    • Terraform テンプレートで価格照会をサポートするリソースの詳細については、「Terraform でサポートされる ROS の機能とリソース」トピックの「Terraform でサポートされる ROS リソース」セクションをご参照ください。

    次のサンプルコードは、テンプレートに基づいて作成する Elastic IP (EIP) アドレスの概算価格を照会する方法の例を示しています。この例では、次のテンプレートが使用されます。

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Isp": {
      "Type": "String",
      "Default": "BGP"
    },
    "Name": {
      "Type": "String",
      "Default": "test"
    },
    "Netmode": {
      "Type": "String",
      "Default": "public"
    },
    "Bandwidth": {
      "Type": "Number",
      "Default": 5
    }
  },
  "Resources": {
    "NewEip": {
      "Type": "ALIYUN::VPC::EIP",
      "Properties": {
        "InstanceChargeType": "Prepaid",
        "PricingCycle": "Month",
        "Isp": {
          "Ref": "Isp"
        },
        "Period": 1,
        "DeletionProtection": false,
        "AutoPay": false,
        "Name": {
          "Ref": "Name"
        },
        "InternetChargeType": "PayByTraffic",
        "Netmode": {
          "Ref": "Netmode"
        },
        "Bandwidth": {
          "Ref": "Bandwidth"
        }
      }
    }
  }
}

    今すぐお試しください

    この 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:GetTemplateEstimateCost

    get

    Template

    acs:ros:{#regionId}:{#accountId}:template/{#TemplateId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TemplateURL

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアントを使用して値を生成できますが、異なるリクエスト間で値が一意であることを確認する必要があります。

    トークンは最大 64 文字で、文字、数字、ハイフン (-)、アンダースコア (_) を含めることができます。

    詳細については、「べき等性の保証」をご参照ください。

    oss://ros-template/demo
    RegionId

    string

    必須

    テンプレートの ID です。このパラメーターは、共有テンプレートとプライベートテンプレートに適用されます。

    説明

    TemplateBody、TemplateURL、TemplateId、TemplateScratchId のうち、いずれか 1 つのパラメーターのみを指定する必要があります。

    cn-hangzhou
    TemplateBody

    string

    任意

    テンプレート本文を含む構造です。テンプレート本文は 1～524,288 バイトの長さである必要があります。テンプレート本文の長さが上限を超える場合は、URL が長すぎることによるリクエストの失敗を防ぐために、HTTP POST リクエストの本文にパラメーターを追加することを推奨します。

    説明

    TemplateBody、TemplateURL、TemplateId、TemplateScratchId のうち、いずれか 1 つのパラメーターのみを指定する必要があります。

    ROSTemplateFormatVersion: '2015-09-01'\nResources:\n vpc:\n Type: ALIYUN::ECS::VPC
    ClientToken

    string

    任意

    パラメーター N の名前です。パラメーターの名前と値を指定しない場合、ROS はテンプレートで指定されたデフォルトの名前と値を使用します。

    N の最大値：200。

    例：

    • Parameters.1.ParameterKey: Name

    • Parameters.2.ParameterKey: Netmode

    説明

    Parameters パラメーターはオプションです。Parameters を指定する場合は、Parameters.N.ParameterKey と Parameters.N.ParameterValue の両方を指定する必要があります。

    123e4567-e89b-12d3-a456-42665544****
    TemplateId

    string

    任意

    パラメーター N の値です。

    N の最大値：200。

    例：

    • Parameters.1.ParameterValue: DemoEip

    • Parameters.2.ParameterValue: public

    説明

    Parameters パラメーターはオプションです。Parameters を指定する場合は、Parameters.N.ParameterKey と Parameters.N.ParameterValue の両方を指定する必要があります。

    5ecd1e10-b0e9-4389-a565-e4c15efc****
    TemplateVersion

    string

    任意

    シナリオの ID です。

    シナリオの ID の照会方法の詳細については、「ListTemplateScratches」をご参照ください。

    説明

    TemplateBody、TemplateURL、TemplateId、TemplateScratchId のうち、いずれか 1 つのパラメーターのみを指定する必要があります。

    v1
    Parameters

    array<object>

    任意

    シナリオのリージョン ID です。デフォルト値は RegionId パラメーターの値と同じです。

    DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    object

    任意

    パラメーターのリストです。

    ParameterKey

    string

    必須

    リクエストの ID です。

    Name
    ParameterValue

    string

    必須

    リソースの詳細です。

    DemoEip
    TemplateScratchId

    string

    任意

    シナリオの ID です。

    ts-aa9c62feab844a6b****
    TemplateScratchRegionId

    string

    任意

    シナリオのリージョン ID です。デフォルト値は RegionId パラメーターの値と同じです。

    DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    cn-hangzhou
    StackId

    string

    任意

    スタックの ID です。

    このパラメーターは、構成変更シナリオで概算価格を照会するために使用されます。

    指定されたスタックに Elastic Compute Service (ECS) インスタンスが 1 つだけ含まれており、インスタンスタイプが ecs.s6-c1m2.large であると仮定します。インスタンスタイプを ecs.s6-c1m1.small にスペックダウンし、価格照会に使用されるテンプレートで新しい ApsaraDB RDS インスタンスを指定します。照会された結果は、ECS インスタンスのスペックダウンによる返金額と、新しい ApsaraDB RDS インスタンスの価格の合計です。

    c754d2a4-28f1-46df-b557-9586173a****

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID です。

    6DEA36EF-C97D-5658-A4AC-4F5DB08D1A89
    Resources

    object

    リソースの詳細です。

    {   "NewEip": {     "Type": "ALIYUN::VPC::EIP",     "Success": true,     "Result": {       "Order": {         "TaxAmount": 0.0,         "Currency": "CNY",         "RuleIds": [           "102204102264****"         ],         "TradeAmount": 87.5,         "OriginalAmount": 125.0,         "DiscountAmount": 37.5       },       "OrderSupplement": {         "ChargeType": "PrePaid",         "Period": 1,         "Quantity": 1,         "PriceType": "Total",         "PeriodUnit": "Month"       },       "InquiryType": "Buy",       "Rules": {         "Rule": [           {             "RuleDescId": "102204102264****",             "Name": "Contract_Discount_Full_Order_30%_Off"           }         ]       }     }   } }

    次の表に、Resources に含まれるパラメーターを示します。

    パラメーター型例説明
    Order注文に関する情報です。
    - CurrencyStringCNY通貨単位。有効値：CNY：この値は中国サイト (aliyun.com) でのみ利用可能です。USD：この値は国際サイト (alibabacloud.com) でのみ利用可能です。
    - OriginalAmountLong125元の価格です。
    - DiscountAmountLong15.63割引額です。
    - TradeAmountLong109.37取引価格。元の価格から割引額を引いたものに等しくなります。
    - TaxAmountLong0利用可能な税額です。
    - CouponsArray{"Coupon": []}利用可能なプロモーションです。
    - RuleIdsArray[102204102264****]プロモーションルールの ID です。
    InquiryTypeStringBuy価格照会タイプ。有効値：Buy：新規リソースの価格照会。ModificationBuy：リソース構成変更の価格照会。
    Rulesプロモーションルールです。
    - Ruleプロモーションルールです。
    - - NameStringContract discount_order discount_8.750 discountプロモーションルールの名前です。
    - - RuleDescIdLong102204102264****プロモーションルールの ID です。
    OrderSupplement注文に関する補足情報です。
    - AutoRenewBooleanfalse自動更新を有効にするかどうかを指定します。有効値：true、false
    - ChargeTypeStringPrePaid課金方法です。
    - PeriodLong1サブスクリプション期間です。
    - PeriodUnitStringMonthサブスクリプション期間の単位。有効値：Year、Month
    - PriceTypeStringTotal価格タイプです。
    - QuantityLong1数量です。

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "6DEA36EF-C97D-5658-A4AC-4F5DB08D1A89",
  "Resources": {
    "test": "test",
    "test2": 1
  }
}

    エラーコード

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

    変更履歴

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