GetTemplateEstimateCost - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

Consulta los precios estimados de los recursos en una plantilla.

Descripción de la operación

Para obtener más información sobre los recursos que admiten la consulta de precios en las plantillas de Resource Orchestration Service (ROS), consulte la sección "Tipos de recursos que admiten la consulta de precios" del tema Estimar precios de recursos.
Para obtener más información sobre los recursos que admiten la consulta de precios en las plantillas de Terraform, consulte la sección "Recursos de ROS compatibles con Terraform" del tema Características y recursos de ROS compatibles con Terraform.

El siguiente código de ejemplo muestra cómo consultar el precio estimado de una dirección IP elástica (EIP) que desea crear mediante una plantilla. En este ejemplo, se utiliza la siguiente plantilla:

{
  "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"
        }
      }
    }
  }
}

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ros:GetTemplateEstimateCost

get

Template

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
TemplateURL	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el valor, pero debe asegurarse de que el valor sea único entre diferentes solicitudes. El token puede tener hasta 64 caracteres de longitud y puede contener letras, dígitos, guiones (-) y guiones bajos (_). Para obtener más información, consulte Garantizar la idempotencia.	oss://ros-template/demo
RegionId	string	Sí	El ID de la plantilla. Este parámetro se aplica a las plantillas compartidas y privadas. Nota Debe especificar solo uno de los siguientes parámetros: TemplateBody, TemplateURL, TemplateId y TemplateScratchId.	cn-hangzhou
TemplateBody	string	No	La estructura que contiene el cuerpo de la plantilla. El cuerpo de la plantilla debe tener una longitud de 1 a 524,288 bytes. Si la longitud del cuerpo de la plantilla supera el límite superior, se recomienda agregar parámetros al cuerpo de la solicitud HTTP POST para evitar fallos en la solicitud causados por URL excesivamente largas. Nota Debe especificar y solo puede especificar uno de los siguientes parámetros: TemplateBody, TemplateURL, TemplateId y TemplateScratchId.	ROSTemplateFormatVersion: '2015-09-01'\nResources:\n vpc:\n Type: ALIYUN::ECS::VPC
ClientToken	string	No	El nombre del parámetro N. Si no especifica el nombre y el valor de un parámetro, ROS utiliza el nombre y el valor predeterminados que se especifican en la plantilla. Valor máximo de N: 200. Ejemplos: Parameters.1.ParameterKey: `Name` Parameters.2.ParameterKey: `Netmode` Nota El parámetro Parameters es opcional. Si desea especificar Parameters, debe especificar tanto Parameters.N.ParameterKey como Parameters.N.ParameterValue.	123e4567-e89b-12d3-a456-42665544****
TemplateId	string	No	El valor del parámetro N. Valor máximo de N: 200. Ejemplos: Parameters.1.ParameterValue: `DemoEip` Parameters.2.ParameterValue: `public` Nota El parámetro Parameters es opcional. Si desea especificar Parameters, debe especificar tanto Parameters.N.ParameterKey como Parameters.N.ParameterValue.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersion	string	No	El ID del escenario. Para obtener más información sobre cómo consultar los ID de los escenarios, consulte ListTemplateScratches. Nota Debe especificar solo uno de los siguientes parámetros: TemplateBody, TemplateURL, TemplateId y TemplateScratchId.	v1
Parameters	array<object>	No	El ID de región del escenario. El valor predeterminado es el mismo que el valor del parámetro RegionId. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
	object	No	La lista de parámetros.
ParameterKey	string	Sí	El ID de la solicitud.	Name
ParameterValue	string	Sí	Los detalles del recurso.	DemoEip
TemplateScratchId	string	No	El ID del escenario.	ts-aa9c62feab844a6b****
TemplateScratchRegionId	string	No	El ID de región del escenario. El valor predeterminado es el mismo que el valor del parámetro RegionId. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
StackId	string	No	El ID de la pila. Este parámetro se utiliza para consultar el precio estimado en un escenario de cambio de configuración. Suponga que la pila especificada contiene solo una instancia de Elastic Compute Service (ECS) y el tipo de instancia es ecs.s6-c1m2.large. Si reduce el tipo de instancia a ecs.s6-c1m1.small y especifica una nueva instancia de ApsaraDB RDS en la plantilla que se utiliza para la consulta de precios, el resultado consultado será la suma del reembolso por reducción de la instancia de ECS y el precio de la nueva instancia de ApsaraDB RDS.	c754d2a4-28f1-46df-b557-9586173a****

Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	6DEA36EF-C97D-5658-A4AC-4F5DB08D1A89
Resources	object	Los detalles del recurso.	{ "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" } ] } } } }

La siguiente tabla describe los parámetros contenidos en Resources.

Parámetro	Tipo	Ejemplo	Descripción
Order			La información sobre el pedido.
- Currency	String	CNY	La unidad monetaria. Valores válidos:CNY: Este valor está disponible solo en el sitio de China (aliyun.com).USD: Este valor está disponible solo en el sitio internacional (alibabacloud.com)
- OriginalAmount	Long	125	El precio original.
- DiscountAmount	Long	15.63	El monto del descuento.
- TradeAmount	Long	109.37	El precio de transacción, que es igual al precio original menos el descuento.
- TaxAmount	Long	0	El monto de impuestos disponible.
- Coupons	Array	{"Coupon": []}	Las promociones disponibles.
- RuleIds	Array	[102204102264****]	Los ID de las reglas de promoción.
InquiryType	String	Buy	El tipo de consulta de precios. Valores válidos:Buy: consulta de precios para nuevos recursosModificationBuy: consulta de precios para cambios en la configuración de recursos
Rules			Las reglas de promoción.
- Rule			La regla de promoción.
- - Name	String	Contract discount_order discount_8.750 discount	El nombre de la regla de promoción.
- - RuleDescId	Long	102204102264****	El ID de la regla de promoción.
OrderSupplement			La información complementaria sobre el pedido.
- AutoRenew	Boolean	false	Especifica si se debe habilitar la renovación automática. Valores válidos:truefalse
- ChargeType	String	PrePaid	El método de facturación.
- Period	Long	1	La duración de la suscripción.
- PeriodUnit	String	Month	La unidad de la duración de la suscripción. Valores válidos:YearMonth
- PriceType	String	Total	El tipo de precio.
- Quantity	Long	1	La cantidad.

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.