调用ALIYUN::TSDB::HiTSDBInstance创建时间序列数据库TSDB实例

ALIYUN::TSDB::HiTSDBInstance类型用于创建时间序列数据库TSDB (Time Series Database)实例。

重要

TSDB实例停止售卖，如有需求，可购买云原生多模数据库Lindorm实例（下文简称Lindorm实例）。更多内容，请参见【通知】TSDB实例停止售卖说明。

语法

{
  "Type": "ALIYUN::TSDB::HiTSDBInstance",
  "Properties": {
    "InstanceStorage": Integer,
    "ZoneId": String,
    "VPCId": String,
    "InstanceAlias": String,
    "PricingCycle": String,
    "SecurityIpList": List,
    "VSwitchId": String,
    "InstanceClass": String,
    "Duration": Integer,
    "PayType": String,
    "DiskCategory": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
ZoneId	String	是	否	可用区ID。	无
VPCId	String	是	否	专有网络ID。	无
InstanceAlias	String	否	是	实例的别名。	无
SecurityIpList	List	否	是	实例的白名单列表。	无
VSwitchId	String	是	否	交换机ID。	无
InstanceClass	String	是	否	实例的规格。	取值： influxdata.n1.xlarge influxdata.n1.2xlarge influxdata.n1.4xlarge influxdata.n1.8xlarge influxdata.n1.16xlarge influxdata.n1.mxlarge influxdata.n1.xlarge_ha influxdata.n1.2xlarge_ha influxdata.n1.4xlarge_ha influxdata.n1.8xlarge_ha influxdata.n1.16xlarge_ha influxdata.n1.mxlarge_ha tsdb.1x.basic tsdb.3x.basic tsdb.4x.basic tsdb.12x.standard tsdb.24x.standard tsdb.48x.large tsdb.96x.large tsdb.iot.1x.small
InstanceStorage	Integer	是	否	存储空间。	取值范围：基础版和标准版：40~6000。旗舰版：320~32,000。单位：GB。
PayType	String	否	否	付费类型。	取值： POSTPAY：后付费（按量付费）。 PREPAY：预付费（包年包月）。
PricingCycle	String	否	否	预付费时长单位。	当PayType取值为PREPAY时，该参数有效。取值： Month（默认值）：月。 Year：年。
Duration	Integer	否	否	购买时长。	取值范围：当PricingCycle取值为Month时：1~9。当PricingCycle取值为Year时：1~3。
DiskCategory	String	否	否	TSDB for InfluxDB®️的磁盘类型。	取值： cloud_efficiency：高效云盘。 cloud_ssd：SSD云盘。 cloud_essd：ESSD云盘。

返回值

Fn::GetAtt

InstanceId：实例ID。
ReverseVpcPort：实例反向专有网络端口。
ReverseVpcIp：实例反向专有网络IP地址。
PublicConnectionString：实例公网连接地址。
EngineType：引擎类型。
OrderId：订单ID。
ConnectionString：数据库连接地址。

示例

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceStorage": {
      "Type": "Number",
      "Description": "The storage capacity of the instance. Unit: GB. For example, the value 50 indicates 50 GB.",
      "MinValue": 40,
      "MaxValue": 6000,
      "Default": 50
    },
    "ZoneId": {
      "Type": "String",
      "Description": "The zone ID of the instance.",
      "Default": "cn-hangzhou-i"
    },
    "VPCId": {
      "Type": "String",
      "Description": "The ID of the virtual private cloud (VPC) that is connected to the instance.",
      "Default": "vpc-wz9ydz3vg93s1ozsd****"
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "The ID of the VSwitch in the specified VPC.",
      "Default": "vsw-wz9kv78f9cp47yadu****"
    },
    "InstanceClass": {
      "Type": "String",
      "Description": "The type of the instance. For more information, see Instance types:\ntsdb.1x.basic: Basic Edition I\ntsdb.3x.basic: Basic Edition II\ntsdb.4x.basic: Basic Edition III\ntsdb.12x.standard: Standard Edition I\ntsdb.24x.standard: Standard Edition II\ntsdb.48x.large: Ultimate Edition I\ntsdb.96x.large: Ultimate Edition II and so on.",
      "Default": "tsdb.1x.basic"
    }
  },
  "Resources": {
    "HiTSDBInstance": {
      "Type": "ALIYUN::TSDB::HiTSDBInstance",
      "Properties": {
        "InstanceStorage": {
          "Ref": "InstanceStorage"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VPCId": {
          "Ref": "VPCId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "InstanceClass": {
          "Ref": "InstanceClass"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "The ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "HiTSDBInstance",
          "InstanceId"
        ]
      }
    },
    "ReverseVpcPort": {
      "Description": "Reverse vpc port of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "HiTSDBInstance",
          "ReverseVpcPort"
        ]
      }
    },
    "ReverseVpcIp": {
      "Description": "Reverse vpc ip of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "HiTSDBInstance",
          "ReverseVpcIp"
        ]
      }
    },
    "PublicConnectionString": {
      "Description": "Public connection string of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "HiTSDBInstance",
          "PublicConnectionString"
        ]
      }
    },
    "EngineType": {
      "Description": "Engine type of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "HiTSDBInstance",
          "EngineType"
        ]
      }
    },
    "OrderId": {
      "Description": "Order id of created instance.",
      "Value": {
        "Fn::GetAtt": [
          "HiTSDBInstance",
          "OrderId"
        ]
      }
    },
    "ConnectionString": {
      "Description": "Connection string of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "HiTSDBInstance",
          "ConnectionString"
        ]
      }
    }
  }
}