Use ALIYUN::TSDB::HiTSDBInstance to create a Time Series Database (TSDB) instance-Resource Orchestration Service(ROS)-阿里云帮助中心

ALIYUN::TSDB::HiTSDBInstance is used to create a Time Series Database (TSDB) instance.

Important

TSDB instances are no longer available for purchase. If you require a time series database, purchase a Lindorm instance. For more information, see Notice on the discontinuation of TSDB instance sales.

Syntax

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

Properties

Property Name	Type	Required	Updatable	Description	Constraints
ZoneId	String	Yes	No	The zone ID.	None
VPCId	String	Yes	No	The virtual private cloud (VPC) ID.	None
InstanceAlias	String	No	Yes	The instance alias.	None
SecurityIpList	List	No	Yes	The IP address whitelist of the instance.	None
VSwitchId	String	Yes	No	The vSwitch ID.	None
InstanceClass	String	Yes	No	The instance type.	Valid values: 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	Yes	No	The storage capacity of the instance.	Valid values: Basic and Standard editions: 40 to 6000. Ultimate editions: 320 to 32,000. Unit: GB.
PayType	String	No	No	The billing method.	Valid values: POSTPAY: pay-as-you-go. PREPAY: subscription.
PricingCycle	String	No	No	The unit of the subscription duration.	This parameter is valid only when PayType is set to PREPAY. Valid values: Month: month (default value). Year.
Duration	Integer	No	No	The subscription duration.	Valid values: If PricingCycle is set to Month: 1 to 9. If PricingCycle is set to Year: 1 to 3.
DiskCategory	String	No	No	The disk type for TSDB for InfluxDB®.	Valid values: cloud_efficiency: ultra disk. cloud_ssd: Standard SSD. cloud_essd: enterprise SSD (ESSD).

Return value

Fn::GetAtt

InstanceId: The instance ID.
ReverseVpcPort: The reverse VPC port of the instance.
ReverseVpcIp: The reverse VPC IP address of the instance.
PublicConnectionString: The public endpoint of the instance.
EngineType: The engine type of the instance.
OrderId: The ID of the order.
ConnectionString: The database endpoint.

Examples

JSON format

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