tencent cloud

All product documents
Tencent Cloud TCHouse-P
Data Types
Last updated: 2025-03-04 16:52:00
Data Types
Last updated: 2025-03-04 16:52:00

AccessInfo

Access information.

Used by actions: DescribeInstance, DescribeInstances.

Name Type Description
Address String Address.
Note: This field may return null, indicating that no valid values can be obtained.
Protocol String Protocol.
Note: This field may return null, indicating that no valid values can be obtained.

CBSSpec

Disk specifications.

Used by actions: CreateInstanceByApi.

Name Type Required Description
DiskType String Yes Disk type.
DiskSize Integer Yes Size.
DiskCount Integer Yes Number.

CBSSpecInfo

Disk information.

Used by actions: DescribeInstanceInfo.

Name Type Required Description
DiskType String Yes Disk type.Note: This field may return null, indicating that no valid values can be obtained.
DiskSize Integer Yes Size.
Note: This field may return null, indicating that no valid values can be obtained.
DiskCount Integer Yes Number.Note: This field may return null, indicating that no valid values can be obtained.

ChargeProperties

Billing time parameter.

Used by actions: CreateInstanceByApi, DescribeInstanceInfo.

Name Type Required Description
RenewFlag Integer Yes 1: requires auto-renewal.
Note: This field may return null, indicating that no valid values can be obtained.
TimeSpan Integer Yes Order time range.
Note: This field may return null, indicating that no valid values can be obtained.
TimeUnit String Yes Time unit. Valid values: h and m.
Note: This field may return null, indicating that no valid values can be obtained.
PayMode Integer No Billing type: 0 indicates pay-as-you-go and 1 indicates monthly subscription.
Note: This field may return null, indicating that no valid values can be obtained.
ChargeType String No PREPAID and POSTPAID_BY_HOUR
Note: This field may return null, indicating that no valid values can be obtained.

DiskSpecPlus

Disk specifications.

Used by actions: DescribeInstance, DescribeInstances.

Name Type Required Description
DiskCount Integer No Disk Count
Note: This field may return null, indicating that no valid values can be obtained.
MaxDiskSize Integer No Max Disk Size
Note: This field may return null, indicating that no valid values can be obtained.
MinDiskSize Integer No Min Disk Size
Note: This field may return null, indicating that no valid values can be obtained.
DiskType String No Disk Type
Note: This field may return null, indicating that no valid values can be obtained.
DiskDesc String No Disk Description
Note: This field may return null, indicating that no valid values can be obtained.
CvmClass String No Cvm Class
Note: This field may return null, indicating that no valid values can be obtained.

InstanceInfo

instance information.

Used by actions: DescribeInstance, DescribeInstances.

Name Type Description
ID Integer Instance ID
Note: This field may return null, indicating that no valid values can be obtained.
InstanceType String cn/dn or others.Note: This field may return null, indicating that no valid values can be obtained.
InstanceName String Instance Name
.Note: This field may return null, indicating that no valid values can be obtained.
Status String Instance Status ,such as 2
Note: This field may return null, indicating that no valid values can be obtained.
StatusDesc String Instance Status Description ,such as Running.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceStateInfo InstanceStateInfo Instance State Infomation
Note: This field may return null, indicating that no valid values can be obtained.
InstanceID String Instance ID
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String CreateTime ,such as 2022-09-05 20:00:01
Note: This field may return null, indicating that no valid values can be obtained.
Region String Region ,such as ap-chongqing.Note: This field may return null, indicating that no valid values can be obtained.
Zone String Zone : This field may return null, indicating that no valid values can be obtained.
RegionDesc String Region.Note: This field may return null, indicating that no valid values can be obtained.
ZoneDesc String Zone.Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Tag.Note: This field may return null, indicating that no valid values can be obtained.
Version String Version.Note: This field may return null, indicating that no valid values can be obtained.
Charset String Character set.
Note: This field may return null, indicating that no valid values can be obtained.
CNNodes Array of InstanceNodeGroup CN node list.
Note: This field may return null, indicating that no valid values can be obtained.
DNNodes Array of InstanceNodeGroup DN node list.
Note: This field may return null, indicating that no valid values can be obtained.
RegionId Integer Region Id
Note: This field may return null, indicating that no valid values can be obtained.
ZoneId Integer Zone Id
Note: This field may return null, indicating that no valid values can be obtained.
VpcId String Vpc Id
Note: This field may return null, indicating that no valid values can be obtained.
SubnetId String Subnet Id
Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime String Expire Time
Note: This field may return null, indicating that no valid values can be obtained.
PayMode String Pay Mode
Note: This field may return null, indicating that no valid values can be obtained.
RenewFlag Boolean Renew Flag
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String Instance Id
Note: This field may return null, indicating that no valid values can be obtained.
AccessDetails Array of AccessInfo Access information.
Note: This field may return null, indicating that no valid values can be obtained.

InstanceNodeGroup

Instance node information.

Used by actions: DescribeInstance, DescribeInstances.

Name Type Description
SpecName String Spec Name
Note: This field may return null, indicating that no valid values can be obtained.
DataDisk DiskSpecPlus Data Disk
Note: This field may return null, indicating that no valid values can be obtained.
CvmCount Integer Cvm Count
Note: This field may return null, indicating that no valid values can be obtained.

InstanceSimpleInfoNew

Simplified instance information.

Used by actions: DescribeSimpleInstances.

Name Type Description
ID Integer ID
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String Instance Id
Note: This field may return null, indicating that no valid values can be obtained.
InstanceName String Instance Name
Note: This field may return null, indicating that no valid values can be obtained.
Version String Version
Note: This field may return null, indicating that no valid values can be obtained.
Region String Region
Note: This field may return null, indicating that no valid values can be obtained.
RegionId Integer Region Id
Note: This field may return null, indicating that no valid values can be obtained.
RegionDesc String Region Desc
Note: This field may return null, indicating that no valid values can be obtained.
Zone String Zone
Note: This field may return null, indicating that no valid values can be obtained.
ZoneId Integer Zone Id
Note: This field may return null, indicating that no valid values can be obtained.
ZoneDesc String Zone Desc
Note: This field may return null, indicating that no valid values can be obtained.
VpcId String Vpc Id
Note: This field may return null, indicating that no valid values can be obtained.
SubnetId String Subnet Id
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String CreateTime
Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime String ExpireTime
Note: This field may return null, indicating that no valid values can be obtained.
AccessInfo String Access Infomation
Note: This field may return null, indicating that no valid values can be obtained.
PayMode String Pay Mode
Note: This field may return null, indicating that no valid values can be obtained.
RenewFlag Boolean Renew Flag
Note: This field may return null, indicating that no valid values can be obtained.

InstanceStateInfo

Instance State Information

Used by actions: DescribeInstance, DescribeInstances.

Name Type Description
InstanceState String Instance status. Example: serving.
Note: This field may return null, indicating that no valid values can be obtained.
FlowCreateTime String Creation time of instance operation.
Note: This field may return null, indicating that no valid values can be obtained.
FlowName String Instance operation name.
Note: This field may return null, indicating that no valid values can be obtained.
FlowProgress Integer Instance operation progress.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceStateDesc String Instance status description. Example: running.
Note: This field may return null, indicating that no valid values can be obtained.
FlowMsg String Instance process error messages. Example: "Creation failed, insufficient resources."
Note: This field may return null, indicating that no valid values can be obtained.
ProcessName String The name of the current step. Example: "Purchasing resources."
Note: This field may return null, indicating that no valid values can be obtained.
BackupStatus Integer Indicates whether there is a backup task in the instance. 1 indicates yes and 0 indicates no.
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String Request Id
Note: This field may return null, indicating that no valid values can be obtained.
BackupOpenStatus Integer Backup Open Status
Note: This field may return null, indicating that no valid values can be obtained.

ResourceInfo

Resource information.

Used by actions: DescribeInstanceInfo.

Name Type Required Description
SpecName String Yes Resource name.
Note: This field may return null, indicating that no valid values can be obtained.
Count Integer Yes Resource count.
Note: This field may return null, indicating that no valid values can be obtained.
DiskSpec CBSSpecInfo Yes Disk information.
Note: This field may return null, indicating that no valid values can be obtained.
Type String Yes Resource type.
Note: This field may return null, indicating that no valid values can be obtained.

ResourceSpecNew

Resource specifications.

Used by actions: CreateInstanceByApi.

Name Type Required Description
SpecName String Yes Resource name.
Count Integer Yes Resource count.
DiskSpec CBSSpec Yes Disk information.
Type String Yes Resource type, DATA.

SearchTags

List of tags searched on the list page.

Used by actions: DescribeInstances.

Name Type Required Description
TagKey String No Tag key.
TagValue String No Tag value.
AllValue Integer No 1 means only the Tag key is entered without a value, and 0 means both the key and the value are entered.

SimpleInstanceInfo

Cluster information.

Used by actions: DescribeInstanceInfo.

Name Type Required Description
ID Integer No ID
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String No Instance Id
Note: This field may return null, indicating that no valid values can be obtained.
InstanceName String No Instance Name
Note: This field may return null, indicating that no valid values can be obtained.
Version String No Version
Note: This field may return null, indicating that no valid values can be obtained.
Region String No Region
Note: This field may return null, indicating that no valid values can be obtained.
Zone String No Zone
Note: This field may return null, indicating that no valid values can be obtained.
UserVPCID String No User VPC ID
Note: This field may return null, indicating that no valid values can be obtained.
UserSubnetID String No User Subnet ID
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String No CreateTime
Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime String No ExpireTime
Note: This field may return null, indicating that no valid values can be obtained.
AccessInfo String No Access Infomation
Note: This field may return null, indicating that no valid values can be obtained.
RenewFlag Integer No Renew Flag
Note: This field may return null, indicating that no valid values can be obtained.
ChargeProperties ChargeProperties No Charge Properties
Note: This field may return null, indicating that no valid values can be obtained.
Resources Array of ResourceInfo No Resources
Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of Tag No Tags
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer No Status
Note: This field may return null, indicating that no valid values can be obtained.

Tag

Tag description.

Used by actions: CreateInstanceByApi, DescribeInstance, DescribeInstanceInfo, DescribeInstances.

Name Type Required Description
TagKey String Yes Tag key.
TagValue String Yes Tag value.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support