ALIYUN::Hologram::Instance類型用于創建Hologres實例。
語法
{
"Type": "ALIYUN::Hologram::Instance",
"Properties": {
"ColdStorageSize": Integer,
"ResourceGroupId": String,
"ZoneId": String,
"ProductCode": String,
"PricingCycle": String,
"ScaleType": String,
"StorageSize": Integer,
"Cpu": Integer,
"Duration": Integer,
"AutoPay": Boolean,
"Endpoints": List,
"InstanceName": String,
"GatewayCount": Integer,
"PaymentType": String,
"InstanceType": String,
"Tags": List,
"LeaderInstanceId": String,
"InitialDatabases": String
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
ColdStorageSize | Integer | 否 | 是 | 實例低頻存儲空間。 | 單位:GB。 說明 按量付費(PostPaid)實例會忽略此參數。 |
ResourceGroupId | String | 否 | 是 | 資源組ID。 | 若為空,則為賬號默認資源組。 |
ZoneId | String | 是 | 否 | 可用區ID。 | 更多信息,請參見接口說明。 |
ProductCode | String | 否 | 否 | 產品code。 | 取值:
|
PricingCycle | String | 否 | 否 | 計費周期。 | 取值:
|
ScaleType | String | 否 | 否 | 更改匹配類型。 | 取值:
|
StorageSize | Integer | 否 | 是 | 實例標準存儲空間。 | 單位:GB。 說明 按量付費實例(PostPaid)會忽略此參數。 |
Cpu | Integer | 否 | 是 | 實例規格。 | 取值:
說明 填寫核數即可。 購買1024以上規格實例請提交工單申請。 Shared實例類型無需指定規格。 8核32GB(計算節點數量:1)的規格僅用于體驗使用,不可用于生產。 |
Duration | Integer | 否 | 否 | 購買周期。 | 如果支付類型是PostPaid,則不需要指定該參數。 取值范圍:1、2、3、4、5、6、7、8、9、12、24、36、60。 |
AutoPay | Boolean | 否 | 否 | 是否自動支付。 | 取值:
說明 如果您的支付方式余額不足,可以將參數AutoPay設置為false,此時會生成未支付訂單,您可以登錄費用與成本自行支付。 |
Endpoints | List | 是 | 是 | 域名列表。 | 更多信息,請參見Endpoints屬性。 |
InstanceName | String | 是 | 是 | 實例名稱。 | 長度限制為2-64個字符。 |
GatewayCount | Integer | 否 | 是 | 網關數量。 | 取值范圍:2、50。 說明 只有Warehouse類型需要指定該參數。 |
PaymentType | String | 是 | 否 | 付費類型。 | 取值:
|
InstanceType | String | 是 | 否 | 實例類型。 | 取值:
|
Tags | List | 否 | 是 | 實例標簽。 | 最多支持20個標簽,更新信息,請參見Tags屬性。 |
LeaderInstanceId | String | 否 | 否 | 主實例ID。 | 無 |
InitialDatabases | String | 否 | 否 | 初始化數據庫并拆分為多個數據庫名稱 。 | 以逗號“,”拆分。 |
Endpoints語法
"Endpoints": [
{
"Type": String,
"Endpoint": String,
"VpcId": String,
"VSwitchId": String,
"Enabled": Boolean,
"VpcInstanceId": String,
"AlternativeEndpoints": String
}
]
Endpoints屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Type | String | 否 | 是 | 網絡類型。 | 取值:
|
Endpoint | String | 否 | 否 | 域名。 | 例如: |
VpcId | String | 否 | 是 | VPC ID。 | 例如: |
VSwitchId | String | 否 | 是 | 虛擬交換機的ID。 | 無 |
Enabled | Boolean | 否 | 否 | 是否啟用endpoint。 | 取值:
|
VpcInstanceId | String | 否 | 否 | VPC實例ID。 | 例如: |
AlternativeEndpoints | String | 否 | 否 | 選擇端點。 | 部分舊實例同時啟用了AnyTunnel和SingleTunnel。 當從AnyTunnel切換到SingleTunnel時,兩者的端點都被保留。 因此,還需要一個字段來存儲端點。 |
Tags語法
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Value | String | 否 | 否 | 標簽值。 | 無 |
Key | String | 是 | 否 | 標簽鍵。 | 無 |
返回值
Fn::GetAtt
ColdStorageSize:實例低頻存儲空間。
ResourceGroupId:資源組ID。
SuspendReason:暫停原因。
ZoneId:可用區ID。
InstanceId:實例ID。
Memory:內存。
InstanceOwner:實例所有者。
CreateTime:資源的創建時間。
Cpu:CPU核數。
StorageSize:實例的標準存儲空間。
EnableHiveAccess:是否啟用數據湖加速。
ExpirationTime:到期時間。 按量付費類型沒有到期時間。
GatewayCpu:網關CPU資源。
Endpoints:域名列表。
InstanceName:實例名稱。
ComputeNodeCount:計算節點數量。
GatewayCount:網關節點數量。
AutoRenewal:是否開啟了自動續費。
Version:實例版本。
CommodityCode:商品code。
GatewayMemory:網關內存資源。
PaymentType:資源的支付類型。
InstanceType:實例類型。
Tags:實例標簽。
示例
YAML
格式ROSTemplateFormatVersion: '2015-09-01' Parameters: AutoPay: Description: en: 'Whether to pay automatically. The default value is true. Value: - true: automatic payment - false: only generate orders, not pay > The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself.' Type: Boolean ColdStorageSize: Description: en: 'Instance low-frequency storage space. Unit: GB. > Pay-As-You-Go (PostPaid) instances ignore this parameter.' Type: Number Cpu: Description: en: 'Instance specifications. Value: - 8 cores 32 GB (number of compute nodes: 1) - 16 cores 64 GB (number of compute nodes: 1) - 32 core 128 GB (number of compute nodes: 2) - 64 core 256 GB (number of compute nodes: 4) - 96 core 384 GB (number of computing nodes: 6) - 128 core 512 GB (number of compute nodes: 8) - Wait >> >- just fill in the audit number. >- Please submit a work order application for purchasing 1024 or above specifications. >- Shared instance types do not need to specify specifications. > The specification of -8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production.' Type: Number Duration: AllowedValues: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 12 - 24 - 36 - 60 Description: en: 'The buying cycle. Buy for 2 months. > If the Payment type is PostPaid, you do not need to specify it.' Type: Number Endpoints: AssociationProperty: List[Parameter] AssociationPropertyMetadata: Parameter: AssociationPropertyMetadata: Parameters: AlternativeEndpoints: Description: en: Some old instances have both AnyTunnel and SingleTunnel enabled. When switching from AnyTunnel to SingleTunnel, the endpoints of both are retained. Therefore, one more field is required to store the Endpoint. Type: String Enabled: Description: en: Whether to turn on the network. Type: Boolean Endpoint: Description: en: Domain name. Type: String Type: Description: en: The network type. Type: String VSwitchId: AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId AssociationPropertyMetadata: VpcId: ${.VpcId} ZoneId: ${.ZoneId} Description: en: The ID of the virtual switch. Type: String VpcId: AssociationProperty: ALIYUN::ECS::VPC::VPCId Description: en: VPC primary key. Type: String VpcInstanceId: Description: en: The vpc instance ID. Type: String Description: en: List of domain names. Type: Json Description: en: List of domain names. Type: Json GatewayCount: Description: en: Number of gateway nodes. Type: Number InstanceName: Description: en: The name of the resource. Type: String InstanceType: AllowedValues: - Standard - Follower - Warehouse - Shared Description: en: 'The instance type. Value: - Standard: Universal. - Follower: Read-only slave instance. - Warehouse: calculation group type. - Shared: Shared.' Type: String PaymentType: AllowedValues: - PayAsYouGo - PostPaid - PayOnDemand - Postpaid - PostPay - POSTPAY - Subscription - PrePaid - PrePay - Prepaid - PREPAY Description: en: The payment type of the resource. Type: String PricingCycle: AllowedValues: - Month - Hour Description: en: 'Billing cycle. Value: - Month: monthly billing - Hour: hourly billing >> > - PrePaid only supports Month > - PostPaid only supports Hour >- The Shared type is automatically set to Hour without specifying it.' Type: String ProductCode: Description: en: product code. Type: String ResourceGroupId: Description: en: The ID of the resource group. Type: String ScaleType: AllowedValues: - DOWNGRADE - UPGRADE Description: en: 'Change matching type. Value: - UPGRADE: UPGRADE - DOWNGRADE: Downgrading >> >- The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification. >- The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification.' Type: String StorageSize: Description: en: 'The standard storage space of the instance. Unit: GB. > Pay-As-You-Go instances (PostPaid) ignore this parameter.' Type: Number Tags: AssociationProperty: List[Parameter] AssociationPropertyMetadata: Parameter: AssociationPropertyMetadata: Parameters: Key: Type: String Value: Type: String Type: Json Description: en: Tags of instance. MaxLength: 20 Type: Json ZoneId: AssociationProperty: ZoneId Description: en: The zone Id. Type: String Resources: ExtensionResource: Properties: AutoPay: Ref: AutoPay ColdStorageSize: Ref: ColdStorageSize Cpu: Ref: Cpu Duration: Ref: Duration Endpoints: Ref: Endpoints GatewayCount: Ref: GatewayCount InstanceName: Ref: InstanceName InstanceType: Ref: InstanceType PaymentType: Ref: PaymentType PricingCycle: Ref: PricingCycle ProductCode: Ref: ProductCode ResourceGroupId: Ref: ResourceGroupId ScaleType: Ref: ScaleType StorageSize: Ref: StorageSize Tags: Ref: Tags ZoneId: Ref: ZoneId Type: ALIYUN::Hologram::Instance Outputs: AutoRenewal: Description: Whether automatic renewal is enabled. Value: Fn::GetAtt: - ExtensionResource - AutoRenewal ColdStorageSize: Description: 'Instance low-frequency storage space. Unit: GB.' Value: Fn::GetAtt: - ExtensionResource - ColdStorageSize CommodityCode: Description: The commodity code. Value: Fn::GetAtt: - ExtensionResource - CommodityCode ComputeNodeCount: Description: Number of compute nodes. Value: Fn::GetAtt: - ExtensionResource - ComputeNodeCount Cpu: Description: Instance specifications. Value: Fn::GetAtt: - ExtensionResource - Cpu CreateTime: Description: The creation time of the resource. Value: Fn::GetAtt: - ExtensionResource - CreateTime EnableHiveAccess: Description: Whether data Lake acceleration is enabled. Value: Fn::GetAtt: - ExtensionResource - EnableHiveAccess Endpoints: Description: List of domain names. Value: Fn::GetAtt: - ExtensionResource - Endpoints ExpirationTime: Description: Expiration time. Value: Fn::GetAtt: - ExtensionResource - ExpirationTime GatewayCount: Description: Number of gateway nodes. Value: Fn::GetAtt: - ExtensionResource - GatewayCount GatewayCpu: Description: Cpu resources of the Gateway. Value: Fn::GetAtt: - ExtensionResource - GatewayCpu GatewayMemory: Description: Gateway memory resources. Value: Fn::GetAtt: - ExtensionResource - GatewayMemory InstanceId: Description: Resource attribute fields that represent the resource's primary key. Value: Fn::GetAtt: - ExtensionResource - InstanceId InstanceName: Description: The name of the resource. Value: Fn::GetAtt: - ExtensionResource - InstanceName InstanceOwner: Description: The instance owner. Value: Fn::GetAtt: - ExtensionResource - InstanceOwner InstanceType: Description: The instance type. Value: Fn::GetAtt: - ExtensionResource - InstanceType Memory: Description: Memory. Value: Fn::GetAtt: - ExtensionResource - Memory PaymentType: Description: The payment type of the resource. Value: Fn::GetAtt: - ExtensionResource - PaymentType ResourceGroupId: Description: The ID of the resource group. Value: Fn::GetAtt: - ExtensionResource - ResourceGroupId StorageSize: Description: 'The standard storage space of the instance. Unit: GB.' Value: Fn::GetAtt: - ExtensionResource - StorageSize SuspendReason: Description: Reason for suspension. Value: Fn::GetAtt: - ExtensionResource - SuspendReason Tags: Description: Instance tag. Value: Fn::GetAtt: - ExtensionResource - Tags Version: Description: The instance version. Value: Fn::GetAtt: - ExtensionResource - Version ZoneId: Description: The zone Id. Value: Fn::GetAtt: - ExtensionResource - ZoneId
JSON
格式{ "ROSTemplateFormatVersion": "2015-09-01", "Parameters": { "ColdStorageSize": { "Type": "Number", "Description": { "en": "Instance low-frequency storage space. Unit: GB.\n> Pay-As-You-Go (PostPaid) instances ignore this parameter." } }, "ResourceGroupId": { "Type": "String", "Description": { "en": "The ID of the resource group." } }, "ZoneId": { "AssociationProperty": "ZoneId", "Type": "String", "Description": { "en": "The zone Id." } }, "ProductCode": { "Type": "String", "Description": { "en": "product code." } }, "PricingCycle": { "Type": "String", "Description": { "en": "Billing cycle. Value:\n- Month: monthly billing\n- Hour: hourly billing\n>>\n> - PrePaid only supports Month\n> - PostPaid only supports Hour\n>- The Shared type is automatically set to Hour without specifying it." }, "AllowedValues": [ "Month", "Hour" ] }, "ScaleType": { "Type": "String", "Description": { "en": "Change matching type. Value:\n- UPGRADE: UPGRADE\n- DOWNGRADE: Downgrading\n>>\n>- The upgrade specification cannot be less than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is larger than the original specification.\n>- The downgrading specification cannot be greater than the original specification. A blank field indicates that the original specification remains unchanged. On this basis, at least one specification is smaller than the original specification." }, "AllowedValues": [ "DOWNGRADE", "UPGRADE" ] }, "Cpu": { "Type": "Number", "Description": { "en": "Instance specifications. Value:\n- 8 cores 32 GB (number of compute nodes: 1)\n- 16 cores 64 GB (number of compute nodes: 1)\n- 32 core 128 GB (number of compute nodes: 2)\n- 64 core 256 GB (number of compute nodes: 4)\n- 96 core 384 GB (number of computing nodes: 6)\n- 128 core 512 GB (number of compute nodes: 8)\n- Wait\n>>\n>- just fill in the audit number.\n>- Please submit a work order application for purchasing 1024 or above specifications.\n>- Shared instance types do not need to specify specifications.\n> The specification of -8 core 32GB (number of computing nodes: 1) is only for experience use and cannot be used for production." } }, "StorageSize": { "Type": "Number", "Description": { "en": "The standard storage space of the instance. Unit: GB.\n> Pay-As-You-Go instances (PostPaid) ignore this parameter." } }, "Duration": { "Type": "Number", "Description": { "en": "The buying cycle. Buy for 2 months.\n> If the Payment type is PostPaid, you do not need to specify it." }, "AllowedValues": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 60 ] }, "AutoPay": { "Type": "Boolean", "Description": { "en": "Whether to pay automatically. The default value is true. Value:\n- true: automatic payment\n- false: only generate orders, not pay\n> The default value is true. If the balance of your payment method is insufficient, you can set the parameter AutoPay to false, and an unpaid order will be generated. You can log in to the user Center to pay by yourself." } }, "Endpoints": { "AssociationPropertyMetadata": { "Parameter": { "AssociationPropertyMetadata": { "Parameters": { "Type": { "Type": "String", "Description": { "en": "The network type." } }, "Endpoint": { "Type": "String", "Description": { "en": "Domain name." } }, "VpcId": { "AssociationProperty": "ALIYUN::ECS::VPC::VPCId", "Type": "String", "Description": { "en": "VPC primary key." } }, "VSwitchId": { "AssociationPropertyMetadata": { "VpcId": "${.VpcId}", "ZoneId": "${.ZoneId}" }, "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId", "Type": "String", "Description": { "en": "The ID of the virtual switch." } }, "Enabled": { "Type": "Boolean", "Description": { "en": "Whether to turn on the network." } }, "VpcInstanceId": { "Type": "String", "Description": { "en": "The vpc instance ID." } }, "AlternativeEndpoints": { "Type": "String", "Description": { "en": "Some old instances have both AnyTunnel and SingleTunnel enabled. When switching from AnyTunnel to SingleTunnel, the endpoints of both are retained. Therefore, one more field is required to store the Endpoint." } } } }, "Type": "Json", "Description": { "en": "List of domain names." } } }, "AssociationProperty": "List[Parameter]", "Type": "Json", "Description": { "en": "List of domain names." } }, "InstanceName": { "Type": "String", "Description": { "en": "The name of the resource." } }, "GatewayCount": { "Type": "Number", "Description": { "en": "Number of gateway nodes." } }, "PaymentType": { "Type": "String", "Description": { "en": "The payment type of the resource." }, "AllowedValues": [ "PayAsYouGo", "PostPaid", "PayOnDemand", "Postpaid", "PostPay", "POSTPAY", "Subscription", "PrePaid", "PrePay", "Prepaid", "PREPAY" ] }, "InstanceType": { "Type": "String", "Description": { "en": "The instance type. Value:\n- Standard: Universal.\n- Follower: Read-only slave instance.\n- Warehouse: calculation group type.\n- Shared: Shared." }, "AllowedValues": [ "Standard", "Follower", "Warehouse", "Shared" ] }, "Tags": { "AssociationPropertyMetadata": { "Parameter": { "AssociationPropertyMetadata": { "Parameters": { "Value": { "Type": "String" }, "Key": { "Type": "String" } } }, "Type": "Json" } }, "AssociationProperty": "List[Parameter]", "Type": "Json", "Description": { "en": "Tags of instance." }, "MaxLength": 20 } }, "Resources": { "ExtensionResource": { "Type": "ALIYUN::Hologram::Instance", "Properties": { "ColdStorageSize": { "Ref": "ColdStorageSize" }, "ResourceGroupId": { "Ref": "ResourceGroupId" }, "ZoneId": { "Ref": "ZoneId" }, "ProductCode": { "Ref": "ProductCode" }, "PricingCycle": { "Ref": "PricingCycle" }, "ScaleType": { "Ref": "ScaleType" }, "Cpu": { "Ref": "Cpu" }, "StorageSize": { "Ref": "StorageSize" }, "Duration": { "Ref": "Duration" }, "AutoPay": { "Ref": "AutoPay" }, "Endpoints": { "Ref": "Endpoints" }, "InstanceName": { "Ref": "InstanceName" }, "GatewayCount": { "Ref": "GatewayCount" }, "PaymentType": { "Ref": "PaymentType" }, "InstanceType": { "Ref": "InstanceType" }, "Tags": { "Ref": "Tags" } } } }, "Outputs": { "ColdStorageSize": { "Description": "Instance low-frequency storage space. Unit: GB.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "ColdStorageSize" ] } }, "ResourceGroupId": { "Description": "The ID of the resource group.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "ResourceGroupId" ] } }, "SuspendReason": { "Description": "Reason for suspension.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "SuspendReason" ] } }, "ZoneId": { "Description": "The zone Id.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "ZoneId" ] } }, "InstanceId": { "Description": "Resource attribute fields that represent the resource's primary key.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "InstanceId" ] } }, "Memory": { "Description": "Memory.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "Memory" ] } }, "InstanceOwner": { "Description": "The instance owner.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "InstanceOwner" ] } }, "CreateTime": { "Description": "The creation time of the resource.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "CreateTime" ] } }, "Cpu": { "Description": "Instance specifications.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "Cpu" ] } }, "StorageSize": { "Description": "The standard storage space of the instance. Unit: GB.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "StorageSize" ] } }, "EnableHiveAccess": { "Description": "Whether data Lake acceleration is enabled.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "EnableHiveAccess" ] } }, "ExpirationTime": { "Description": "Expiration time.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "ExpirationTime" ] } }, "GatewayCpu": { "Description": "Cpu resources of the Gateway.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "GatewayCpu" ] } }, "Endpoints": { "Description": "List of domain names.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "Endpoints" ] } }, "InstanceName": { "Description": "The name of the resource.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "InstanceName" ] } }, "ComputeNodeCount": { "Description": "Number of compute nodes.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "ComputeNodeCount" ] } }, "GatewayCount": { "Description": "Number of gateway nodes.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "GatewayCount" ] } }, "AutoRenewal": { "Description": "Whether automatic renewal is enabled.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "AutoRenewal" ] } }, "Version": { "Description": "The instance version.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "Version" ] } }, "CommodityCode": { "Description": "The commodity code.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "CommodityCode" ] } }, "GatewayMemory": { "Description": "Gateway memory resources.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "GatewayMemory" ] } }, "PaymentType": { "Description": "The payment type of the resource.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "PaymentType" ] } }, "InstanceType": { "Description": "The instance type.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "InstanceType" ] } }, "Tags": { "Description": "Instance tag.", "Value": { "Fn::GetAtt": [ "ExtensionResource", "Tags" ] } } } }