全部產品
Search
文件中心

Resource Orchestration Service:GetTemplateEstimateCost - 查詢範本中建立資源的預估價格

更新時間:Dec 15, 2025

通過指定模板和模板參數查詢建立資源棧的預估價格。

介面說明

本文將提供一個樣本,查詢範本中建立的 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"
        }
      }
    }
  }
}

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ros:GetTemplateEstimateCost

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

TemplateURL

string

包含模板主體的檔案的位置。URL 必須指向位於 Web 服務器(HTTP 或 HTTPS)或阿里雲 OSS 儲存空間(例如:oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou)中的模板,模板的最大長度為 524,288 個位元組。如未指定 OSS 地區,預設與 RegionId 取值相同。

說明

您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 和 TemplateScratchId 其中一個參數。

oss://ros-template/demo

RegionId

string

資源棧所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。

cn-hangzhou

TemplateBody

string

模板主體的結構。長度為 1~524,288 個位元組。如果長度較長,則建議通過 HTTP POST+Body Param 的方式,將參數放在請求體中進行傳遞,避免因 URL 過長而導致請求失敗。

說明

您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 和 TemplateScratchId 其中一個參數。

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

ClientToken

string

保證請求的等冪性。 該值由用戶端產生,並且必須全域唯一。
長度不超過 64 個字元。可包含英文字母、數字、短劃線(-)和底線(_)。
更多資訊,請參見如何保證等冪性

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

TemplateId

string

模板 ID。支援共用模板和私人模板。

說明

您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 和 TemplateScratchId 其中一個參數。

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

TemplateVersion

string

模板版本。僅在指定 TemplateId 時生效。

v1

Parameters

array<object>

參數。

object

ParameterKey

string

參數的名稱。如果未指定模板中定義的參數名稱和參數值,ROS 將使用模板中指定的預設值。
N 的最大值為:200。 取值樣本:

  • Parameters.1.ParameterKey:Name

  • Parameters.2.ParameterKey:Netmode

說明

Parameters 為選擇性參數。如果需要指定 Parameters,則 Parameters.N.ParameterKey 和 Parameters.N.ParameterValue 必須同時指定。

Name

ParameterValue

string

參數值。
N 的最大值為:200。 取值樣本:

  • Parameters.1.ParameterValue:DemoEip

  • Parameters.2.ParameterValue:public

說明

Parameters 為選擇性參數。如果需要指定 Parameters,則 Parameters.N.ParameterKey 和 Parameters.N.ParameterValue 必須同時指定。

DemoEip

TemplateScratchId

string

資源情境 ID。

關於如何擷取資源情境 ID,請參見 ListTemplateScratches

說明

您必須且僅能指定 TemplateBody、TemplateURL、TemplateId 和 TemplateScratchId 其中一個參數。

ts-aa9c62feab844a6b****

TemplateScratchRegionId

string

資源情境所屬的地區 ID,預設與 RegionId 取值相同。

您可以調用 DescribeRegions 查看最新的阿里雲地區列表。

cn-hangzhou

StackId

string

資源棧 ID。

當填寫此參數時,表示查詢變更配置情境的預估價格。

假設指定資源棧中僅有一個 ECS 執行個體,且規格是 ecs.s6-c1m2.large。詢價使用的新模板將規格改為 ecs.s6-c1m1.small(降配),並新增一個 RDS 執行個體。則詢價結果為 ECS 執行個體變更配置價格(本例由於是降配,則是退款)和新購 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": "合約優惠_整單_7.0折" } ] } } } }

Resources 各參數含義如下所示。

名稱類型樣本值描述
Order訂單資訊。
- CurrencyStringCNY貨幣單位。取值:
CNY:該值僅適用於中國站。
USD:該值僅適用於國際站。

- OriginalAmountFloat125.0原價。
- DiscountAmountFloat15.63抵扣金額。
- TradeAmountFloat109.37最終價,為原價減去折扣。
- TaxAmountFloat0.0可選稅額。
- CouponsArray{"Coupon": []}可選促銷。
- RuleIdsArray[102204102264****]活動規則列表。
InquiryTypeStringBuy詢價類型。取值:
Buy:新購詢價。
ModificationBuy:變更配置詢價。

Rules活動規則。
- Rule活動規則。
- - NameString合約優惠_整單_8.750 折活動規則名稱。
- - RuleDescIdLong102204102264****活動規則 ID。
OrderSupplement訂單補充資訊。
- AutoRenewBooleanfalse是否自動續約。取值:
true:自動續約。
false:不自動續約。

- ChargeTypeStringPrePaid付費方式。
- PeriodLong1計費時間長度。
- PeriodUnitStringMonth訂用帳戶計費方式的時間長度單位。取值:
Year:年。
Month:月。

- PriceTypeStringTotal價格類型。
- QuantityLong1數量。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "6DEA36EF-C97D-5658-A4AC-4F5DB08D1A89",
  "Resources": {
    "NewEip": {
      "Type": "ALIYUN::VPC::EIP",
      "Success": true,
      "Result": {
        "Order": {
          "TaxAmount": 0,
          "Currency": "CNY",
          "RuleIds": [
            "102204102264****"
          ],
          "TradeAmount": 87.5,
          "OriginalAmount": 125,
          "DiscountAmount": 37.5
        },
        "OrderSupplement": {
          "ChargeType": "PrePaid",
          "Period": 1,
          "Quantity": 1,
          "PriceType": "Total",
          "PeriodUnit": "Month"
        },
        "InquiryType": "Buy",
        "Rules": {
          "Rule": [
            {
              "RuleDescId": "102204102264****",
              "Name": "合約優惠_整單_7.0折"
            }
          ]
        }
      }
    }
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情