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 - ZoneIdJSON格式{ "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" ] } } } }
反馈
- 本页导读 （1）
文档反馈