Creates a Time Series Database (TSDB) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No CreateHiTSDBInstance

The operation that you want to perform. Set the value to CreateDedicatedHostAccount.

InstanceClass String Yes tsdb.1x.basic

The instance type of the instance.

InstanceStorage String Yes 50

The storage of the instance. Unit: GB.

PayType String Yes PREPAY

The billing method of the instance. Valid values:

  • PREPAY: subscription
  • POSTPAY: pay-as-you-go
RegionId String Yes cn-shanghai

The ID of the region.

VPCId String Yes vpc-wz9ydz3vg93s1ozsd****

The ID of the virtual private cloud (VPC).

VSwitchId String Yes vsw-wz9kv78f9cp47yadu****

The ID of the vSwitch.

ZoneId String Yes cn-shanghai-b

The ID of the zone.

AppKey String No None

A hidden parameter.

InstanceAlias String No tsdb_test

The name of the instance.

PricingCycle String No Month

The unit of the subscription duration. Valid values:

  • Month
  • Year
Duration String No 1

The subscription duration.

  • When PricingCycle is set to Month, the value range is 1 to 9.
  • When PricingCycle is set to Year, the value range is 1 to 3.
DiskCategory String No cloud_ssd

The type of disks. Valid values:

  • cloud_efficiency: ultra disks
  • cloud_ssd: standard SSDs
  • cloud_essd: enhanced SSDs (ESSDs)

Response parameters

Parameter Type Example Description
InstanceId String ts-wz99vz6u8jg39****

The ID of the instance.

OrderId Long 211110656240000

The ID of the order.

RequestId String 587BCA54-50DA-4885-ADE9-80A848339151

The ID of the request.

Examples

Sample requests

http(s)://hitsdb.aliyuncs.com/?Action=CreateHiTSDBInstance
&InstanceClass=tsdb.1x.basic
&InstanceStorage=50
&PayType=PREPAY
&RegionId=cn-shanghai
&VPCId=vpc-wz9ydz3vg93s1ozsd****
&VSwitchId=vsw-wz9kv78f9cp47yadu****
&ZoneId=cn-shanghai-b
&<Common request parameters>|

Sample success responses

XML format 

<CreateHiTSDBInstance>
  <RequestId>587BCA54-50DA-4885-ADE9-80A848339151</RequestId>
  <InstanceId>ts-wz99vz6u8jg39****</InstanceId>
  <OrderId>211110656240000</OrderId>
</CreateHiTSDBInstance>

JSON format 

{
    "RequestId": "587BCA54-50DA-4885-ADE9-80A848339151",
    "InstanceId": "ts-wz99vz6u8jg39****",
    "OrderId": 211110656240000
}

Error codes

HttpCode Error code Error message Description
411 TSDB.Errorcode.InstanceClassAndEngineTypeMismatch The engine type and instance class parameters do not match. Instance class will take precedence. The error message returned because the engine type and the instance type do not match and the instance type prevails.
404 TSDB.Errorcode.InstanceNotFound The instance is not found The error message returned because the specified instance does not exist.
412 TSDB.Errorcode.InstanceStorageInvalid The parameter of instance storage is invalid. The error message returned because the InstanceStorage parameter is invalid.
400 TSDB.Errorcode.ParameterInvaild The parameter is invalid. The error message returned because the specified parameters are invalid.

For a list of error codes, visit the API Error Center.