Documentation | Tencent Cloud

Data Types

Last updated: 2020-10-16 18:35:56

COSSettings

COS-related configuration

Used by actions: CreateInstance.

Name	Type	Required	Description
CosSecretId	String	Yes	COS `SecretId`
CosSecretKey	String	Yes	COS `SecrectKey`
LogOnCosPath	String	No	COS path to log

CdbInfo

Output parameters

Used by actions: DescribeClusterNodes.

Name	Type	Description
InstanceName	String	Database instance Note: this field may return null, indicating that no valid values can be obtained.
Ip	String	Database IP Note: this field may return null, indicating that no valid values can be obtained.
Port	Integer	Database port Note: this field may return null, indicating that no valid values can be obtained.
MemSize	Integer	Database memory specification Note: this field may return null, indicating that no valid values can be obtained.
Volume	Integer	Database disk specification Note: this field may return null, indicating that no valid values can be obtained.
Service	String	Service flag 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.
ApplyTime	String	Application time Note: this field may return null, indicating that no valid values can be obtained.
PayType	Integer	Payment type Note: this field may return null, indicating that no valid values can be obtained.
ExpireFlag	Boolean	Expiration flag Note: this field may return null, indicating that no valid values can be obtained.
Status	Integer	Database status Note: this field may return null, indicating that no valid values can be obtained.
IsAutoRenew	Integer	Renewal flag Note: this field may return null, indicating that no valid values can be obtained.
SerialNo	String	Database string Note: this field may return null, indicating that no valid values can be obtained.
ZoneId	Integer	ZoneId Note: this field may return null, indicating that no valid values can be obtained.
RegionId	Integer	RegionId Note: this field may return null, indicating that no valid values can be obtained.

ClusterInstancesInfo

Cluster instance information

Used by actions: DescribeInstances.

Name	Type	Description
Id	Integer	ID Note: this field may return null, indicating that no valid values can be obtained.
ClusterId	String	Cluster ID Note: this field may return null, indicating that no valid values can be obtained.
Ftitle	String	Title Note: this field may return null, indicating that no valid values can be obtained.
ClusterName	String	Cluster name 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	Region ID Note: this field may return null, indicating that no valid values can be obtained.
AppId	Integer	User APPID Note: this field may return null, indicating that no valid values can be obtained.
Uin	String	User UIN Note: this field may return null, indicating that no valid values can be obtained.
ProjectId	Integer	Project ID Note: this field may return null, indicating that no valid values can be obtained.
VpcId	Integer	Cluster `VPCID` Note: this field may return null, indicating that no valid values can be obtained.
SubnetId	Integer	Subnet ID Note: this field may return null, indicating that no valid values can be obtained.
Status	Integer	Instance status code. Value range: 2: cluster running 3: creating cluster. 4: scaling out cluster. 5: adding router node in cluster. 6: installing component in cluster. 7: cluster executing command. 8: restarting service. 9: entering maintenance. 10: suspending service. 11: exiting maintenance. 12: exiting suspension. 13: delivering configuration. 14: terminating cluster. 15: terminating core node. 16: terminating task node. 17: terminating router node. 18: changing webproxy password. 19: isolating cluster. 20: resuming cluster. 21: repossessing cluster. 22: waiting for configuration adjustment. 23: cluster isolated. 24: removing node. 33: waiting for refund. 34: refunded. 301: creation failed. 302: scale-out failed. Note: this field may return null, indicating that no valid values can be obtained.
AddTime	String	Creation time Note: this field may return null, indicating that no valid values can be obtained.
RunTime	String	Execution duration Note: this field may return null, indicating that no valid values can be obtained.
Config	EmrProductConfigOutter	Cluster product configuration information Note: this field may return null, indicating that no valid values can be obtained.
MasterIp	String	Public IP of master node Note: this field may return null, indicating that no valid values can be obtained.
EmrVersion	String	EMR version Note: this field may return null, indicating that no valid values can be obtained.
ChargeType	Integer	Billing mode Note: this field may return null, indicating that no valid values can be obtained.
TradeVersion	Integer	Transaction version Note: this field may return null, indicating that no valid values can be obtained.
ResourceOrderId	Integer	Resource order ID Note: this field may return null, indicating that no valid values can be obtained.
IsTradeCluster	Integer	Whether this is a paid cluster Note: this field may return null, indicating that no valid values can be obtained.
AlarmInfo	String	Alarm information for cluster error Note: this field may return null, indicating that no valid values can be obtained.
IsWoodpeckerCluster	Integer	Whether the new architecture is used Note: this field may return null, indicating that no valid values can be obtained.
MetaDb	String	Metadatabase information Note: this field may return null, indicating that no valid values can be obtained.
Tags	Array of Tag	Tag information Note: this field may return null, indicating that no valid values can be obtained.
HiveMetaDb	String	Hive metadata Note: this field may return null, indicating that no valid values can be obtained.
ServiceClass	String	Cluster type: EMR, CLICKHOUSE, DRUID Note: this field may return null, indicating that no valid values can be obtained.
AliasInfo	String	Alias serialization of all nodes in cluster Note: this field may return null, indicating that no valid values can be obtained.
ProductId	Integer	Cluster version ID Note: this field may return null, indicating that no valid values can be obtained.

CustomMetaInfo

User-created Hive-MetaDB instance information

Used by actions: CreateInstance, InquiryPriceCreateInstance.

Name	Type	Required	Description
MetaDataJdbcUrl	String	No	JDBC connection to custom MetaDB instance beginning with `jdbc:mysql://`
MetaDataUser	String	No	Custom MetaDB instance username
MetaDataPass	String	No	Custom MetaDB instance password

EmrProductConfigOutter

EMR product configuration

Used by actions: DescribeInstances.

Name	Type	Description
SoftInfo	Array of String	Software information Note: this field may return null, indicating that no valid values can be obtained.
MasterNodeSize	Integer	Number of master nodes Note: this field may return null, indicating that no valid values can be obtained.
CoreNodeSize	Integer	Number of core nodes Note: this field may return null, indicating that no valid values can be obtained.
TaskNodeSize	Integer	Number of task nodes Note: this field may return null, indicating that no valid values can be obtained.
ComNodeSize	Integer	Number of common nodes Note: this field may return null, indicating that no valid values can be obtained.
MasterResource	OutterResource	Master node resource Note: this field may return null, indicating that no valid values can be obtained.
CoreResource	OutterResource	Core node resource Note: this field may return null, indicating that no valid values can be obtained.
TaskResource	OutterResource	Task node resource Note: this field may return null, indicating that no valid values can be obtained.
ComResource	OutterResource	Common node resource Note: this field may return null, indicating that no valid values can be obtained.
OnCos	Boolean	Whether COS is used Note: this field may return null, indicating that no valid values can be obtained.
ChargeType	Integer	Billing mode Note: this field may return null, indicating that no valid values can be obtained.
RouterNodeSize	Integer	Number of router nodes Note: this field may return null, indicating that no valid values can be obtained.
SupportHA	Boolean	Whether HA is supported Note: this field may return null, indicating that no valid values can be obtained.
SecurityOn	Boolean	Whether secure mode is supported Note: this field may return null, indicating that no valid values can be obtained.
SecurityGroup	String	Security group name Note: this field may return null, indicating that no valid values can be obtained.
CbsEncrypt	Integer	Whether to enable CBS encryption Note: this field may return null, indicating that no valid values can be obtained.

HostVolumeContext

Pod HostPath mounting method description

Used by actions: ScaleOutInstance.

Name	Type	Required	Description
VolumePath	String	Yes	Directory in the pod for mounting the host, which is the mount point of resources for the host. The specified mount point corresponds to the host path and is used as the data storage directory in the pod. Note: this field may return null, indicating that no valid values can be obtained.

LoginSettings

Used by actions: CreateInstance.

Name	Type	Required	Description
Password	String	No	Password
PublicKeyId	String	No	Public Key

MultiDisk

Multi-cloud disk parameters

Used by actions: CreateInstance, InquiryPriceCreateInstance, InquiryPriceScaleOutInstance.

Name	Type	Required	Description
DiskType	String	No	Cloud disk type. Valid values: CLOUD_PREMIUM, CLOUD_SSD, CLOUD_BASIC
Volume	Integer	No	Cloud disk size
Count	Integer	No	Number of cloud disks of this type

MultiDiskMC

Multi-cloud disk parameters

Used by actions: DescribeClusterNodes.

Name	Type	Required	Description
Count	Integer	Yes	Number of cloud disks in this type Note: this field may return null, indicating that no valid values can be obtained.
Type	Integer	No	Disk type Note: this field may return null, indicating that no valid values can be obtained.
Volume	Integer	No	Cloud disk size Note: this field may return null, indicating that no valid values can be obtained.

NewResourceSpec

Resource description

Used by actions: CreateInstance, InquiryPriceCreateInstance.

Name	Type	Required	Description
MasterResourceSpec	Resource	No	Describes master node resource
CoreResourceSpec	Resource	No	Describes core node resource
TaskResourceSpec	Resource	No	Describes task node resource
MasterCount	Integer	No	Number of master nodes
CoreCount	Integer	No	Number of core nodes
TaskCount	Integer	No	Number of task nodes
CommonResourceSpec	Resource	No	Describes common node resource
CommonCount	Integer	No	Number of common nodes

NodeHardwareInfo

Node hardware information

Used by actions: DescribeClusterNodes.

Name	Type	Description
AppId	Integer	User `APPID` Note: this field may return null, indicating that no valid values can be obtained.
SerialNo	String	Serial number Note: this field may return null, indicating that no valid values can be obtained.
OrderNo	String	Machine instance ID Note: this field may return null, indicating that no valid values can be obtained.
WanIp	String	Public IP bound to master node Note: this field may return null, indicating that no valid values can be obtained.
Flag	Integer	Node type. 0: common node; 1: master node; 2: core node; 3: task node Note: this field may return null, indicating that no valid values can be obtained.
Spec	String	Node specification Note: this field may return null, indicating that no valid values can be obtained.
CpuNum	Integer	Number of node cores Note: this field may return null, indicating that no valid values can be obtained.
MemSize	Integer	Node memory size Note: this field may return null, indicating that no valid values can be obtained.
MemDesc	String	Node memory description Note: this field may return null, indicating that no valid values can be obtained.
RegionId	Integer	Node region Note: this field may return null, indicating that no valid values can be obtained.
ZoneId	Integer	Node AZ Note: this field may return null, indicating that no valid values can be obtained.
ApplyTime	String	Application time Note: this field may return null, indicating that no valid values can be obtained.
FreeTime	String	Release time Note: this field may return null, indicating that no valid values can be obtained.
DiskSize	String	Disk size Note: this field may return null, indicating that no valid values can be obtained.
NameTag	String	Node description Note: this field may return null, indicating that no valid values can be obtained.
Services	String	Services deployed on node Note: this field may return null, indicating that no valid values can be obtained.
StorageType	Integer	Disk type Note: this field may return null, indicating that no valid values can be obtained.
RootSize	Integer	System disk size Note: this field may return null, indicating that no valid values can be obtained.
ChargeType	Integer	Payment type Note: this field may return null, indicating that no valid values can be obtained.
CdbIp	String	Database IP Note: this field may return null, indicating that no valid values can be obtained.
CdbPort	Integer	Database port Note: this field may return null, indicating that no valid values can be obtained.
HwDiskSize	Integer	Disk capacity Note: this field may return null, indicating that no valid values can be obtained.
HwDiskSizeDesc	String	Disk capacity description Note: this field may return null, indicating that no valid values can be obtained.
HwMemSize	Integer	Memory capacity Note: this field may return null, indicating that no valid values can be obtained.
HwMemSizeDesc	String	Memory capacity description 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.
EmrResourceId	String	Node resource ID Note: this field may return null, indicating that no valid values can be obtained.
IsAutoRenew	Integer	Renewal flag Note: this field may return null, indicating that no valid values can be obtained.
DeviceClass	String	Device flag Note: this field may return null, indicating that no valid values can be obtained.
Mutable	Integer	Support for configuration adjustment Note: this field may return null, indicating that no valid values can be obtained.
MCMultiDisk	Array of MultiDiskMC	Multi-cloud disk Note: this field may return null, indicating that no valid values can be obtained.
CdbNodeInfo	CdbInfo	Database information Note: this field may return null, indicating that no valid values can be obtained.
Ip	String	Private IP Note: this field may return null, indicating that no valid values can be obtained.
Destroyable	Integer	Whether this node can be terminated. 1: yes, 0: no Note: this field may return null, indicating that no valid values can be obtained.
Tags	Array of Tag	Tags bound to node Note: this field may return null, indicating that no valid values can be obtained.
AutoFlag	Integer	Wether the node is auto-scaling. 0 means common node. 1 means auto-scaling node.
HardwareResourceType	String	Resource type. Valid values: host, pod Note: this field may return null, indicating that no valid values can be obtained.

OutterResource

Resource details

Used by actions: DescribeInstances.

Name	Type	Description
Spec	String	Specification Note: this field may return null, indicating that no valid values can be obtained.
SpecName	String	Specification name Note: this field may return null, indicating that no valid values can be obtained.
StorageType	Integer	Disk type Note: this field may return null, indicating that no valid values can be obtained.
DiskType	String	Disk type Note: this field may return null, indicating that no valid values can be obtained.
RootSize	Integer	System disk size Note: this field may return null, indicating that no valid values can be obtained.
MemSize	Integer	Memory size Note: this field may return null, indicating that no valid values can be obtained.
Cpu	Integer	Number of CPUs Note: this field may return null, indicating that no valid values can be obtained.
DiskSize	Integer	Disk size Note: this field may return null, indicating that no valid values can be obtained.
InstanceType	String	Specification Note: this field may return null, indicating that no valid values can be obtained.

PersistentVolumeContext

Pod PVC storage method description

Used by actions: ScaleOutInstance.

Name	Type	Required	Description
DiskSize	Integer	No	Disk size in GB Note: this field may return null, indicating that no valid values can be obtained.
DiskType	String	No	Disk type. Valid values: CLOUD_PREMIUM, CLOUD_SSD Note: this field may return null, indicating that no valid values can be obtained.
DiskNum	Integer	No	Number of disks Note: this field may return null, indicating that no valid values can be obtained.

Placement

Location information of cluster instance

Used by actions: CreateInstance, InquiryPriceCreateInstance, InquiryPriceRenewInstance, InquiryPriceUpdateInstance.

Name	Type	Required	Description
ProjectId	Integer	Yes	ID of the project to which the instance belongs. This parameter can be obtained from the `projectId` field in the return value of the `DescribeProject` API. If 0 is entered, the default project will be used.
Zone	String	Yes	AZ where the instance resides, such as ap-guangzhou-1. You can call the `DescribeZones` API and see the `Zone` field to get the value of this parameter.

PodSpec

Resource description for container resource expansion

Used by actions: ScaleOutInstance.

Name	Type	Required	Description
ResourceProviderIdentifier	String	Yes	Identifier of external resource provider, such as "cls-a1cd23fa".
ResourceProviderType	String	Yes	Type of external resource provider, such as "tke". Currently, only "tke" is supported.
NodeType	String	Yes	Purpose of the resource, i.e., node type, which currently can only be "TASK".
Cpu	Integer	Yes	Number of CPU cores.
Memory	Integer	Yes	Memory size in GB.
DataVolumes	Array of String	No	Mount point of resources for the host. The specified mount point corresponds to the host path and is used as the data storage directory in the pod. (This parameter has been disused)
CpuType	String	No	EKS cluster - CPU type. Valid values: "intel", "amd"
PodVolumes	Array of PodVolume	No	Pod node data directory mounting information.

PodVolume

Pod storage device description.

Used by actions: ScaleOutInstance.

Name	Type	Required	Description
VolumeType	String	Yes	Storage type. Valid values: "pvc", "hostpath". Note: this field may return null, indicating that no valid values can be obtained.
PVCVolume	PersistentVolumeContext	No	This field will take effect if `VolumeType` is `pvc`. Note: this field may return null, indicating that no valid values can be obtained.
HostVolume	HostVolumeContext	No	This field will take effect if `VolumeType` is `hostpath`. Note: this field may return null, indicating that no valid values can be obtained.

PreExecuteFileSettings

Pre-execution script configuration

Used by actions: CreateInstance, ScaleOutInstance.

Name	Type	Required	Description
Path	String	No	COS path to script, which has been disused
Args	Array of String	No	Execution script parameter
Bucket	String	No	COS bucket name, which has been disused
Region	String	No	COS region name, which has been disused
Domain	String	No	COS domain data, which has been disused
RunOrder	Integer	No	Execution sequence
WhenRun	String	No	`resourceAfter` or `clusterAfter`
CosFileName	String	No	Script name, which has been disused
CosFileURI	String	No	COS address of script
CosSecretId	String	No	COS `SecretId`
CosSecretKey	String	No	COS `SecretKey`
AppId	String	No	COS `appid`, which has been disused

PriceResource

Resource queried for price

Used by actions: InquiryPriceScaleOutInstance.

Name	Type	Description
Spec	String	Target specification Note: this field may return null, indicating that no valid values can be obtained.
StorageType	Integer	Disk type Note: this field may return null, indicating that no valid values can be obtained.
DiskType	String	Disk type Note: this field may return null, indicating that no valid values can be obtained.
RootSize	Integer	System disk size Note: this field may return null, indicating that no valid values can be obtained.
MemSize	Integer	Memory size Note: this field may return null, indicating that no valid values can be obtained.
Cpu	Integer	Number of cores Note: this field may return null, indicating that no valid values can be obtained.
DiskSize	Integer	Disk size Note: this field may return null, indicating that no valid values can be obtained.
MultiDisks	Array of MultiDisk	List of cloud disks Note: this field may return null, indicating that no valid values can be obtained.
DiskCnt	Integer	Number of disks Note: this field may return null, indicating that no valid values can be obtained.
InstanceType	String	Specification 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.
DiskNum	Integer	Number of disks Note: this field may return null, indicating that no valid values can be obtained.
LocalDiskNum	Integer	Number of local disks Note: this field may return null, indicating that no valid values can be obtained.

Resource

Resource details

Used by actions: CreateInstance, InquiryPriceCreateInstance.

Name	Type	Required	Description
Spec	String	Yes	Node specification description Note: this field may return null, indicating that no valid values can be obtained.
StorageType	Integer	Yes	Storage class Note: this field may return null, indicating that no valid values can be obtained.
DiskType	String	Yes	Disk type Note: this field may return null, indicating that no valid values can be obtained.
MemSize	Integer	Yes	Memory capacity in MB Note: this field may return null, indicating that no valid values can be obtained.
Cpu	Integer	Yes	Number of CPU cores Note: this field may return null, indicating that no valid values can be obtained.
DiskSize	Integer	Yes	Data disk capacity Note: this field may return null, indicating that no valid values can be obtained.
RootSize	Integer	No	System disk capacity Note: this field may return null, indicating that no valid values can be obtained.
MultiDisks	Array of MultiDisk	No	List of cloud disks. When the data disk is a cloud disk, `DiskType` and `DiskSize` are used directly; `MultiDisks` will be used for the excessive part Note: this field may return null, indicating that no valid values can be obtained.
Tags	Array of Tag	No	List of tags to be bound Note: this field may return null, indicating that no valid values can be obtained.
InstanceType	String	No	Specification type Note: this field may return null, indicating that no valid values can be obtained.
LocalDiskNum	Integer	No	Number of local disks Note: this field may return null, indicating that no valid values can be obtained.
DiskNum	Integer	No	Number of disks Note: this field may return null, indicating that no valid values can be obtained.

SearchItem

Search field

Used by actions: DescribeClusterNodes.

Name	Type	Required	Description
SearchType	String	Yes	Searchable type
SearchValue	String	Yes	Searchable value

Tag

Used by actions: CreateInstance, DescribeClusterNodes, DescribeInstances, InquiryPriceCreateInstance, InquiryPriceScaleOutInstance, ScaleOutInstance.

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

UpdateInstanceSettings

Target resource specification

Used by actions: InquiryPriceUpdateInstance.

Name	Type	Required	Description
Memory	Integer	Yes	Memory capacity in GB
CPUCores	Integer	Yes	Number of CPU cores
ResourceId	String	Yes	Machine resource ID (EMR resource identifier)
InstanceType	String	No	Target machine specification

VPCSettings

VPC parameters

Used by actions: CreateInstance, InquiryPriceCreateInstance.

Name	Type	Required	Description
VpcId	String	Yes	VPC ID
SubnetId	String	Yes	Subnet ID

Was this page helpful?

Confirm

Recent Pages

Data Types

COSSettings

CdbInfo

ClusterInstancesInfo

CustomMetaInfo

EmrProductConfigOutter

HostVolumeContext

LoginSettings

MultiDisk

MultiDiskMC

NewResourceSpec

NodeHardwareInfo

OutterResource

PersistentVolumeContext

Placement

PodSpec

PodVolume

PreExecuteFileSettings

PriceResource

Resource

SearchItem

Tag

UpdateInstanceSettings

VPCSettings

Was this page helpful?

Was this page helpful?

About Tencent Cloud

Help & Support

User Center

Resources

7x24 Hotline

Sign Up

Log in

Recent Pages

Data Types

COSSettings

CdbInfo

ClusterInstancesInfo

CustomMetaInfo

EmrProductConfigOutter

HostVolumeContext

LoginSettings

MultiDisk

MultiDiskMC

NewResourceSpec

NodeHardwareInfo

OutterResource

PersistentVolumeContext

Placement

PodSpec

PodVolume

PreExecuteFileSettings

PriceResource

Resource

SearchItem

Tag

UpdateInstanceSettings

VPCSettings

Was this page helpful?

Was this page helpful?

About Tencent Cloud

Help & Support

User Center

Resources

7x24 Hotline