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 |
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. |
Relationship between shared components and the current cluster
Used by actions: DescribeInstances.
Name | Type | Description |
---|---|---|
DependType | Integer | Dependency. 0 : Other clusters depend on the current cluster. 1 : The current cluster depends on other clusters.Note: This field may return null , indicating that no valid values can be obtained. |
Service | String | Shared component Note: This field may return null , indicating that no valid values can be obtained. |
ClusterId | String | Sharing cluster Note: This field may return null , indicating that no valid values can be obtained. |
ClusterStatus | Integer | Sharing cluster status Note: This field may return null , indicating that no valid values can be obtained. |
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: 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. |
Zone | String | Availability zone Note: this field may return null , indicating that no valid value can be obtained. |
SceneName | String | Scenario name Note: This field may return null , indicating that no valid value was found. |
SceneServiceClass | String | Scenario-based cluster type Note: This field may return null , indicating that no valid value was found. |
SceneEmrVersion | String | Scenario-based EMR version Note: This field may return null , indicating that no valid value was found. |
DisplayName | String | Scenario-based cluster type Note: This field may return null , indicating that no valid value was found. |
VpcName | String | VPC name Note: This field may return null , indicating that no valid value was found. |
SubnetName | String | Subnet name Note: This field may return null , indicating that no valid value was found. |
ClusterExternalServiceInfo | Array of ClusterExternalServiceInfo | Cluster dependency Note: This field may return null , indicating that no valid value was found. |
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 |
Shared self-built component parameters
Used by actions: CreateInstance, InquiryPriceCreateInstance.
Name | Type | Required | Description |
---|---|---|---|
Name | String | No | Custom parameter key |
Value | String | No | Custom parameter value |
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. |
ApplicationRole | String | Custom application role Note: this field may return null , indicating that no valid value can be obtained. |
SecurityGroups | Array of String | Security groups Note: this field may return null , indicating that no valid value can be obtained. |
PublicKeyId | String | SSH key ID Note: This field may return null , indicating that no valid values can be obtained. |
Shared component information
Used by actions: CreateInstance, InquiryPriceCreateInstance.
Name | Type | Required | Description |
---|---|---|---|
ShareType | String | Yes | Shared component type, which can be EMR or CUSTOM |
CustomServiceDefineList | Array of CustomServiceDefine | Yes | Custom parameters |
Service | String | Yes | Shared component name |
InstanceId | String | Yes | Shared component cluster |
Login settings
Used by actions: CreateInstance.
Name | Type | Required | Description |
---|---|---|---|
Password | String | No | Password |
PublicKeyId | String | No | Public Key |
Multi-cloud disk parameters
Used by actions: CreateInstance, InquiryPriceCreateInstance.
Name | Type | Required | Description |
---|---|---|---|
DiskType | String | No | Cloud disk typeCLOUD_SSD : SSDCLOUD_PREMIUM : Premium Cloud StorageCLOUD_HSSD : Enhanced SSD |
Volume | Integer | No | Cloud disk size |
Count | Integer | No | Number of cloud disks of this type |
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. |
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 |
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. |
IsDynamicSpec | Integer | Whether floating specification is used. 1 : yes; 0 : noNote: this field may return null , indicating that no valid values can be obtained. |
DynamicPodSpec | String | Floating specification in JSON string Note: this field may return null , indicating that no valid values can be obtained. |
SupportModifyPayMode | Integer | Whether to support billing mode change. 0 : no; 1 : yesNote: this field may return null , indicating that no valid values can be obtained. |
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. |
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. |
Pre-execution script configuration
Used by actions: CreateInstance.
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 |
Resource details
Used by actions: CreateInstance, InquiryPriceCreateInstance.
Name | Type | Required | Description |
---|---|---|---|
Spec | String | Yes | Node specification description, such as CVM.SA2 Note: this field may return null , indicating that no valid values can be obtained. |
StorageType | Integer | Yes | Storage type Valid values: Note: this field may return null , indicating that no valid values can be obtained. |
DiskType | String | Yes | Disk type Valid values: CLOUD_SSD : SSDCLOUD_PREMIUM : Premium Cloud StorageCLOUD_BASIC : HDDNote: 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 partNote: 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, such as S2.MEDIUM8 Note: this field may return null , indicating that no valid values can be obtained. |
LocalDiskNum | Integer | No | Number of local disks. This field has been disused. Note: this field may return null , indicating that no valid values can be obtained. |
DiskNum | Integer | No | Number of local disks, such as 2 Note: this field may return null , indicating that no valid values can be obtained. |
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.
Name | Type | Required | Description |
---|---|---|---|
TagKey | String | No | Tag key |
TagValue | String | No | Tag value |
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 |
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?