Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

Data Types

Last updated: 2024-07-16 14:12:50

AttachCBSSpec

Specifications of nodes in the cluster and disk specifications description

Used by actions: DescribeInstance, DescribeInstances.

Name	Type	Required	Description
DiskType	String	No	Node disk type, such as CLOUD_SSD""CLOUD_PREMIUM
DiskSize	Integer	No	Disk capacity, in GB
DiskCount	Integer	No	Total number of disks
DiskDesc	String	No	Description

ChargeProperties

Cluster billing-related information

Used by actions: CreateInstanceNew.

Name	Type	Required	Description
ChargeType	String	No	Billing type: PREPAID for prepayment, and POSTPAID_BY_HOUR for postpayment. Note: This field may return null, indicating that no valid values can be obtained.
RenewFlag	Integer	No	Whether to automatically renew. 1 means automatic renewal is enabled. Note: This field may return null, indicating that no valid values can be obtained.
TimeSpan	Integer	No	Billing duration Note: This field may return null, indicating that no valid values can be obtained.
TimeUnit	String	No	Billing time unit, and "m" means month, etc. Note: This field may return null, indicating that no valid values can be obtained.

ClusterConfigsInfoFromEMR

It is used to return configuration files and content in XML format, as well as other information related to the configuration files.

Used by actions: DescribeClusterConfigs.

Name	Type	Description
FileName	String	Configuration file's name
FileConf	String	Related attribute information corresponding to the configuration files
KeyConf	String	Other attribute information corresponding to the configuration files
OriParam	String	Contents of the configuration files, base64 encoded
NeedRestart	Integer	This is used to indicate whether the current configuration file has been modified without a restart, and reminds the user that a restart is needed.
FilePath	String	Configuration file path Note: This field may return null, indicating that no valid values can be obtained.
FileKeyValuesNew	Array of ConfigKeyValue	kv value of a configuration file Note: This field may return null, indicating that no valid values can be obtained.

ConfigKeyValue

Return the configuration file content (key-value)

Used by actions: DescribeClusterConfigs.

Name	Type	Description
KeyName	String	key Note: This field may return null, indicating that no valid values can be obtained.
Value	String	Value Note: This field may return null, indicating that no valid values can be obtained.
Message	String	Notes Note: This field may return null, indicating that no valid values can be obtained.
Display	Integer	1 indicates read-only, 2 indicates editable but undeletable, and 3 indicates deletable. Note: This field may return null, indicating that no valid values can be obtained.
SupportHotUpdate	Integer	0 means not supported, and 1 means hot update is supported. Note: This field may return null, indicating that no valid values can be obtained.

CreateInstanceSpec

Cluster specifications

Used by actions: CreateInstanceNew.

Name	Type	Required	Description
SpecName	String	Yes	Specification name
Count	Integer	Yes	Quantities
DiskSize	Integer	Yes	Cloud disk size

DataBaseAuditRecord

Database audit

Used by actions: DescribeDatabaseAuditRecords.

Name	Type	Description
OsUser	String	Query user Note: This field may return null, indicating that no valid values can be obtained.
InitialQueryId	String	Query ID Note: This field may return null, indicating that no valid values can be obtained.
Sql	String	SQL statement Note: This field may return null, indicating that no valid values can be obtained.
QueryStartTime	String	Start time Note: This field may return null, indicating that no valid values can be obtained.
DurationMs	Integer	Execution duration Note: This field may return null, indicating that no valid values can be obtained.
ReadRows	Integer	The number of read rows Note: This field may return null, indicating that no valid values can be obtained.
ResultRows	Integer	Total number of read bytes Note: This field may return null, indicating that no valid values can be obtained.
ResultBytes	Integer	Result bytes Note: This field may return null, indicating that no valid values can be obtained.
MemoryUsage	Integer	Memory Note: This field may return null, indicating that no valid values can be obtained.
InitialAddress	String	Initial query IP Note: This field may return null, indicating that no valid values can be obtained.
DbName	String	Database Note: This field may return null, indicating that no valid values can be obtained.
SqlType	String	SQL type Note: This field may return null, indicating that no valid values can be obtained.
Catalog	String	Catalog name Note: This field may return null, indicating that no valid values can be obtained.

InstanceInfo

Instance description information

Used by actions: DescribeInstance, DescribeInstances.

Name	Type	Description
InstanceId	String	Cluster instance ID, "cdw-xxxx" string type Note: This field may return null, indicating that no valid values can be obtained.
InstanceName	String	Cluster instance name Note: This field may return null, indicating that no valid values can be obtained.
Status	String	Status, Init is being created. Serving is running. Deleted indicates the cluster has been terminated. Deleting indicates the cluster is being terminated. Modify indicates the cluster is being changed. 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, ap-guangzhou Note: This field may return null, indicating that no valid values can be obtained.
Zone	String	Availability zone, ap-guangzhou-3 Note: This field may return null, indicating that no valid values can be obtained.
VpcId	String	VPC name Note: This field may return null, indicating that no valid values can be obtained.
SubnetId	String	Subnet name Note: This field may return null, indicating that no valid values can be obtained.
PayMode	String	Payment type: hour and prepay Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Creation time Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime	String	Expiration time Note: This field may return null, indicating that no valid values can be obtained.
MasterSummary	NodesSummary	Data node description information Note: This field may return null, indicating that no valid values can be obtained.
CoreSummary	NodesSummary	Zookeeper node description information Note: This field may return null, indicating that no valid values can be obtained.
HA	String	High availability, being true or false Note: This field may return null, indicating that no valid values can be obtained.
HaType	Integer	High availability type: 0: non-high availability 1: read high availability 2: read-write high availability Note: This field may return null, indicating that no valid values can be obtained.
AccessInfo	String	Access address. Example: 10.0.0.1:9000 Note: This field may return null, indicating that no valid values can be obtained.
Id	Integer	Record ID, in numerical type Note: This field may return null, indicating that no valid values can be obtained.
RegionId	Integer	Region ID, indicating the region Note: This field may return null, indicating that no valid values can be obtained.
ZoneDesc	String	Note about availability zone, such as Guangzhou Zone 2 Note: This field may return null, indicating that no valid values can be obtained.
FlowMsg	String	Error process description information Note: This field may return null, indicating that no valid values can be obtained.
StatusDesc	String	Status description, such as "running" Note: This field may return null, indicating that no valid values can be obtained.
RenewFlag	Boolean	Automatic renewal marker Note: This field may return null, indicating that no valid values can be obtained.
Tags	Array of Tag	Tag list Note: This field may return null, indicating that no valid values can be obtained.
Monitor	String	Monitoring Information Note: This field may return null, indicating that no valid values can be obtained.
HasClsTopic	Boolean	Whether to enable logs. Note: This field may return null, indicating that no valid values can be obtained.
ClsTopicId	String	Log Topic ID Note: This field may return null, indicating that no valid values can be obtained.
ClsLogSetId	String	Logset ID Note: This field may return null, indicating that no valid values can be obtained.
EnableXMLConfig	Integer	Whether to support XML configuration management. Note: 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.
Eip	String	Elastic network interface address Note: This field may return null, indicating that no valid values can be obtained.
CosMoveFactor	Integer	Cold and hot stratification coefficient Note: This field may return null, indicating that no valid values can be obtained.
Kind	String	external/local/yunti Note: This field may return null, indicating that no valid values can be obtained.
CosBucketName	String	COS bucket Note: This field may return null, indicating that no valid values can be obtained.
CanAttachCbs	Boolean	cbs Note: This field may return null, indicating that no valid values can be obtained.
BuildVersion	String	Minor versions Note: This field may return null, indicating that no valid values can be obtained.
Components	String	Component Information Note: The return type here is map[string]struct, not the string type displayed. You can refer to "Sample Value" to parse the data. Note: This field may return null, indicating that no valid values can be obtained.
Characteristic	Array of String	Page features, used to block some page entrances on the front end. Note: This field may return null, indicating that no valid values can be obtained.
RestartTimeout	String	Timeout period, in seconds Note: This field may return null, indicating that no valid values can be obtained.
GraceShutdownWaitSeconds	String	The timeout time for the graceful restart of the kernel. If it is -1, it means it is not set. Note: This field may return null, indicating that no valid values can be obtained.
CaseSensitive	Integer	Whether the table name is case sensitive, 0 refers to sensitive, 1 refers to insensitive, compared in lowercase; 2 refers to insensitive, and the table name is changed to lowercase for storage. Note: This field may return null, indicating that no valid values can be obtained.
IsWhiteSGs	Boolean	Whether users can bind security groups. Note: This field may return null, indicating that no valid values can be obtained.
BindSGs	Array of String	Bound security group information Note: This field may return null, indicating that no valid values can be obtained.
EnableMultiZones	Boolean	Whether it is a multi-AZ. Note: This field may return null, indicating that no valid values can be obtained.
UserNetworkInfos	String	User availability zone and subnet information Note: This field may return null, indicating that no valid values can be obtained.
EnableCoolDown	Integer	Whether to enable hot and cold stratification. 0 refers to disabled, and 1 refers to enabled. Note: This field may return null, indicating that no valid values can be obtained.
CoolDownBucket	String	COS buckets are used for hot and cold stratification Note: This field may return null, indicating that no valid values can be obtained.

InstanceNode

Instance node description information

Used by actions: DescribeInstanceNodes.

Name	Type	Description
Ip	String	IP address
Spec	String	Model, such as S1
Core	Integer	Number of CPU cores
Memory	Integer	Memory size
DiskType	String	Disk type
DiskSize	Integer	Disk size
Role	String	The name of the clickhouse cluster to which it belongs.
Status	String	Status Note: This field may return null, indicating that no valid values can be obtained.
Rip	String	rip Note: This field may return null, indicating that no valid values can be obtained.
FeRole	String	FE node role Note: This field may return null, indicating that no valid values can be obtained.
UUID	String	UUID Note: This field may return null, indicating that no valid values can be obtained.

NetworkInfo

Network information

Used by actions: CreateInstanceNew.

Name	Type	Required	Description
Zone	String	No	Availability zone Note: This field may return null, indicating that no valid values can be obtained.
SubnetId	String	No	Subnet ID Note: This field may return null, indicating that no valid values can be obtained.
SubnetIpNum	Integer	No	The number of available IP addresses in the current subnet Note: This field may return null, indicating that no valid values can be obtained.

NodeInfo

Used by actions: DescribeInstanceNodesInfo.

Name	Type	Description
Ip	String	User IP Note: This field may return null, indicating that no valid values can be obtained.
Status	Integer	Node status Note: This field may return null, indicating that no valid values can be obtained.
NodeName	String	Node role name Note: This field may return null, indicating that no valid values can be obtained.
ComponentName	String	Component name Note: This field may return null, indicating that no valid values can be obtained.
NodeRole	String	Node role Note: This field may return null, indicating that no valid values can be obtained.
LastRestartTime	String	The time when the node was last restarted Note: This field may return null, indicating that no valid values can be obtained.
Zone	String	The availability zone where the node is located Note: This field may return null, indicating that no valid values can be obtained.

NodesSummary

Node role description information

Used by actions: DescribeInstance, DescribeInstances.

Name	Type	Description
Spec	String	Model, such as S1
NodeSize	Integer	Number of nodes
Core	Integer	Number of CPU cores, in counts
Memory	Integer	Memory size, in GB
Disk	Integer	Disk size, in GB
DiskType	String	Disk type
DiskDesc	String	Disk description
AttachCBSSpec	AttachCBSSpec	Information of mounted cloud disks Note: This field may return null, indicating that no valid values can be obtained.
SubProductType	String	Sub-product name Note: This field may return null, indicating that no valid values can be obtained.
SpecCore	Integer	Specified cores Note: This field may return null, indicating that no valid values can be obtained.
SpecMemory	Integer	Specified memory Note: This field may return null, indicating that no valid values can be obtained.
DiskCount	Integer	Disk size Note: This field may return null, indicating that no valid values can be obtained.
Encrypt	Integer	Whether it is encrypted. Note: This field may return null, indicating that no valid values can be obtained.
MaxDiskSize	Integer	Maximum disk Note: This field may return null, indicating that no valid values can be obtained.

SearchTags

The searched marker list 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.

SlowQueryRecord

Slow log records

Used by actions: DescribeSlowQueryRecords.

Name	Type	Description
OsUser	String	User query
InitialQueryId	String	ID query
Sql	String	SQL statement
QueryStartTime	String	Start time
DurationMs	Integer	Execution duration
ReadRows	Integer	The number of read rows
ResultRows	Integer	Total number of read bytes
ResultBytes	Integer	Result bytes
MemoryUsage	Integer	Memory
InitialAddress	String	Initial query IP
DbName	String	Database name Note: This field may return null, indicating that no valid values can be obtained.
IsQuery	Integer	Whether it is a query. 0 indicates no, and 1 indicates query statement. Note: This field may return null, indicating that no valid values can be obtained.
ResultBytesMB	Float	MB format of ResultBytes Note: This field may return null, indicating that no valid values can be obtained.
MemoryUsageMB	Float	MemoryUsage, in MB Note: This field may return null, indicating that no valid values can be obtained.
DurationSec	Float	DurationMs, in seconds Note: This field may return null, indicating that no valid values can be obtained.

Tag

Tag description

Used by actions: CreateInstanceNew, DescribeInstance, DescribeInstances.

Name	Type	Required	Description
TagKey	String	Yes	Tag key
TagValue	String	Yes	Tag value

tencent cloud

Recent Pages

Data Types

AttachCBSSpec

ChargeProperties

ClusterConfigsInfoFromEMR

ConfigKeyValue

CreateInstanceSpec

DataBaseAuditRecord

InstanceInfo

InstanceNode

NetworkInfo

NodeInfo

NodesSummary

SearchTags

SlowQueryRecord

Tag

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

Data Types

AttachCBSSpec

ChargeProperties

ClusterConfigsInfoFromEMR

ConfigKeyValue

CreateInstanceSpec

DataBaseAuditRecord

InstanceInfo

InstanceNode

NetworkInfo

NodeInfo

NodesSummary

SearchTags

SlowQueryRecord

Tag

Was this page helpful?

Was this page helpful?