tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2024-04-20 14:35:58

    AllNodeResourceSpec

    Resource description

    Used by actions: CreateCluster.

    Name Type Required Description
    MasterResourceSpec NodeResourceSpec No The description of master nodes.
    Note: This field may return null, indicating that no valid values can be obtained.
    CoreResourceSpec NodeResourceSpec No The description of core nodes.
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskResourceSpec NodeResourceSpec No The description of task nodes.
    Note: This field may return null, indicating that no valid values can be obtained.
    CommonResourceSpec NodeResourceSpec No The description of common nodes.
    Note: This field may return null, indicating that no valid values can be obtained.
    MasterCount Integer No The number of master nodes.
    Note: This field may return null, indicating that no valid values can be obtained.
    CoreCount Integer No The number of core nodes.
    Note: This field may return null, indicating that no valid values can be obtained.
    TaskCount Integer No The number of task nodes.
    Note: This field may return null, indicating that no valid values can be obtained.
    CommonCount Integer No The number of common nodes.
    Note: This field may return null, indicating that no valid values can be obtained.

    ApplicationStatics

    Yarn application statistics

    Used by actions: DescribeEmrApplicationStatics.

    Name Type Description
    Queue String Queue name
    User String Username
    ApplicationType String Application type
    SumMemorySeconds Integer SumMemorySeconds meaning
    SumVCoreSeconds Integer
    SumHDFSBytesWritten String SumHDFSBytesWritten (with unit)
    SumHDFSBytesRead String SumHDFSBytesRead (with unit)
    CountApps Integer Application count

    AutoScaleRecord

    Elastic Scaling Record

    Used by actions: DescribeAutoScaleRecords.

    Name Type Description
    StrategyName String Name of the scale-in or scale-out rule.
    ScaleAction String "SCALE_OUT" and "SCALE_IN", representing expansion and reduction respectively.
    ActionStatus String The values are "SUCCESS", "FAILED", "PART_SUCCESS", "IN_PROCESS", which indicate success, failure, partial success, and in-progress, respectively.
    ActionTime String Process initiation time.
    ScaleInfo String Description related to auto-scaling.
    ExpectScaleNum Integer Valid only when ScaleAction is SCALE_OUT.
    EndTime String Process termination time.
    StrategyType Integer Policy type. Valid values: 1 (load-based scaling), 2 (time-based scaling).
    SpecInfo String Specification information used during scale-out.
    CompensateFlag Integer Compensatory scale-out. Valid values: 0 (disabled), 1 (enabled).
    Note: This field may return null, indicating that no valid values can be obtained.
    CompensateCount Integer Number of compensations
    Note: This field may return null, indicating that no valid values can be obtained.
    RetryCount Integer
    RetryInfo String

    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.

    ClusterExternalServiceInfo

    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.

    ClusterIDToFlowID

    Mapping of cluster ID and process ID

    Used by actions: ModifyResourcesTags.

    Name Type Description
    ClusterId String Cluster IDNote: This field may return null, indicating that no valid values can be obtained.
    FlowId Integer Process ID
    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.
    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.
    UniqVpcId String The VPC ID string type of the cluster
    Note: This field may return null, indicating that no valid values can be obtained.
    UniqSubnetId String The subnet ID string type of the cluster
    Note: This field may return null, indicating that no valid values can be obtained.
    TopologyInfoList Array of TopologyInfo Node information
    Note: This field may return null, indicating that no valid values can be obtained.
    IsMultiZoneCluster Boolean Multi-AZ cluster
    Note: This field may return null, indicating that no valid values can be obtained.
    IsCvmReplace Boolean Whether the feature of automatic abnormal node replacement is enabled.
    Note: This field may return null, indicating that no valid values can be obtained.

    ComponentBasicRestartInfo

    Target processes

    Used by actions: StartStopServiceOrMonitor.

    Name Type Required Description
    ComponentName String No The process name (required), such as NameNode.
    Note: This field may return null, indicating that no valid values can be obtained.
    IpList Array of String No The target IP list.
    Note: This field may return null, indicating that no valid values can be obtained.

    CustomMetaDBInfo

    The user-created Hive-MetaDB instance information.

    Used by actions: CreateCluster.

    Name Type Required Description
    MetaDataJdbcUrl String No The JDBC URL of the custom metadatabase instance. Example: jdbc:mysql://10.10.10.10:3306/dbname
    MetaDataUser String No The custom metadatabase instance username.
    MetaDataPass String No The custom metadatabase instance password.
    MetaType String No The Hive-shared metadatabase type. Valid values:
  • EMR_DEFAULT_META: The cluster creates one by default.
  • EMR_EXIST_META: The cluster uses the specified EMR metadatabase instance.
  • USER_CUSTOM_META: The cluster uses a custom metadatabase instance.
    		•
    UnifyMetaInstanceId String No The EMR-MetaDB instance.

    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

    CustomServiceDefine

    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

    DependService

    Shared component information

    Used by actions: CreateCluster.

    Name Type Required Description
    ServiceName String Yes The shared component name.
    InstanceId String Yes The cluster to which the shared component belongs.

    DiskSpecInfo

    Node disk information

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    Count Integer Yes The number of disks.
    Note: This field may return null, indicating that no valid values can be obtained.
    DiskType String Yes The system disk type. Valid values:
  • CLOUD_SSD: Cloud SSD
  • CLOUD_PREMIUM: Premium cloud disk
  • CLOUD_BASIC: Cloud HDD
  • LOCAL_BASIC: Local disk
  • LOCAL_SSD: Local SSD


    • The data disk type. Valid values:
  • CLOUD_SSD: Cloud SSD
  • CLOUD_PREMIUM: Premium cloud disk
  • CLOUD_BASIC: Cloud HDD
  • LOCAL_BASIC: Local disk
  • LOCAL_SSD: Local SSD
  • CLOUD_HSSD: Enhanced SSD
  • CLOUD_THROUGHPUT: Throughput HDD
  • CLOUD_TSSD: ulTra SSD

    • Note: This field may return null, indicating that no valid values can be obtained.
    DiskSize Integer Yes The disk capacity in GB.
    Note: This field may return null, indicating that no valid values can be obtained.

    DynamicPodSpec

    Pod floating specification

    Used by actions: ScaleOutCluster, ScaleOutInstance.

    Name Type Required Description
    RequestCpu Float No Minimum number of CPUs
    LimitCpu Float No Maximum number of CPUs
    RequestMemory Float No Minimum memory in MB
    LimitMemory Float No Maximum memory in MB

    EmrListInstance

    Returned cluster list sample

    Used by actions: DescribeInstancesList.

    Name Type Description
    ClusterId String Cluster ID
    StatusDesc String Status description
    Note: This field may return null, indicating that no valid value can be obtained.
    ClusterName String Cluster name
    ZoneId Integer Cluster region
    AppId Integer User APPID
    AddTime String Creation time
    RunTime String Running time
    MasterIp String Cluster IP
    EmrVersion String Cluster version
    ChargeType Integer Cluster billing mode
    Id Integer EMR ID
    ProductId Integer Product ID
    Note: This field may return null, indicating that no valid value can be obtained.
    ProjectId Integer Project ID
    Note: This field may return null, indicating that no valid value can be obtained.
    RegionId Integer Region
    Note: This field may return null, indicating that no valid value can be obtained.
    SubnetId Integer Subnet ID
    Note: This field may return null, indicating that no valid value can be obtained.
    VpcId Integer VPC ID
    Note: This field may return null, indicating that no valid value can be obtained.
    Zone String Region
    Note: This field may return null, indicating that no valid value can be obtained.
    Status Integer Status code
    Note: This field may return null, indicating that no valid value can be obtained.
    Tags Array of Tag Instance tag
    Note: This field may return null, indicating that no valid value can be obtained.
    AlarmInfo String Alarm information
    Note: This field may return null, indicating that no valid value can be obtained.
    IsWoodpeckerCluster Integer Whether it is a Woodpecker cluster
    Note: This field may return null, indicating that no valid value can be obtained.
    VpcName String VPC name
    Note: This field may return null, indicating that no valid value can be obtained.
    SubnetName String Subnet name
    Note: This field may return null, indicating that no valid value can be obtained.
    UniqVpcId String VPC ID string
    Note: This field may return null, indicating that no valid value can be obtained.
    UniqSubnetId String Subnet ID string
    Note: This field may return null, indicating that no valid value can be obtained.
    ClusterClass String Cluster type
    Note: This field may return null, indicating that no valid value can be obtained.
    IsMultiZoneCluster Boolean Whether it is a multi-AZ cluster
    Note: This field may return null, indicating that no valid value can be obtained.
    IsHandsCluster Boolean Whether it is a manually deployed cluster
    Note: This field may return null, indicating that no valid value can be obtained.
    OutSideSoftInfo Array of SoftDependInfo Client component information.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsSupportOutsideCluster Boolean Whether the current cluster supports external clients.
    Note: This field may return null, indicating that no valid values can be obtained.

    EmrPrice

    EMR inquiry description

    Used by actions: InquiryPriceScaleOutInstance.

    Name Type Description
    OriginalCost String The published price.
    Note: This field may return null, indicating that no valid values can be obtained.
    DiscountCost String The discounted price.
    Note: This field may return null, indicating that no valid values can be obtained.
    Unit String The unit of the billable item.
    Note: This field may return null, indicating that no valid values can be obtained.
    PriceSpec PriceResource The queried spec.
    Note: This field may return null, indicating that no valid values can be obtained.
    SupportSpotPaid Boolean Whether spot instances are supported.
    Note: This field may return null, indicating that no valid values can be obtained.

    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.
    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.

    ExternalService

    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

    Filters

    Custom query filter of the EMR cluster instance list

    Used by actions: DescribeInstancesList.

    Name Type Required Description
    Name String Yes Field name
    Values Array of String Yes Filters by the field value

    HiveQuery

    Hive query details

    Used by actions: DescribeHiveQueries.

    Name Type Description
    Statement String Query statementNote: This field may return null, indicating that no valid values can be obtained.
    Duration String Execution Duration
    Note: This field may return null, indicating that no valid values can be obtained.
    StartTime Integer Start Time in Milliseconds
    Note: This field may return null, indicating that no valid values can be obtained.
    EndTime Integer End Time in Milliseconds
    Note: This field may return null, indicating that no valid values can be obtained.
    State String StatusNote: This field may return null, indicating that no valid values can be obtained.
    User String UserNote: This field may return null, indicating that no valid values can be obtained.
    JobIds Array of String AppId List
    Note: This field may return null, indicating that no valid values can be obtained.
    ExecutionEngine String Execution Engine
    Note: This field may return null, indicating that no valid values can be obtained.
    Id String Query ID
    Note: This field may return null, indicating that no valid values can be obtained.

    HostVolumeContext

    Description of HostPath mounting method in the pod

    Used by actions: ScaleOutCluster, ScaleOutInstance.

    Name Type Required Description
    VolumePath String Yes The directory for mounting the host in the pod, which is the mount point of the host in the resource. A 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.

    InstanceChargePrepaid

    The instance prepayment parameter. It applies only when the billing type is PREPAID.

    Used by actions: CreateCluster, ScaleOutCluster.

    Name Type Required Description
    Period Integer Yes The period of monthly subscription, which defaults to 1 and is expressed in month.
    Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60.
    RenewFlag Boolean Yes Whether to enable auto-renewal. Valid values:
  • true: Enable
  • false (default): Disable
    		•

    KeyValue

    Key-value pair, primarily used for filtering

    Used by actions: DescribeAutoScaleRecords.

    Name Type Required Description
    Key String Yes Key
    Note: This field may return null, indicating that no valid values can be obtained.
    Value String Yes ValueNote: This field may return null, indicating that no valid values can be obtained.

    LoginSettings

    Login settings

    Used by actions: CreateCluster, CreateInstance.

    Name Type Required Description
    Password String No The login password of the instance, which contains 8 to 16 uppercase letters, lowercase letters, digits, and special characters (only !@%^*) and cannot start with a special character.
    PublicKeyId String No The key ID. After an instance is associated with a key, you can access it with the private key in the key pair. You can call DescribeKeyPairs to obtain PublicKeyId.

    ModifyResourceTags

    Forcibly Modifying Tags

    Used by actions: ModifyResourcesTags.

    Name Type Required Description
    ResourceId String Yes Cluster ID or CVM ID
    Resource String Yes 6-segment resource expression
    ResourcePrefix String Yes Resource prefix
    ResourceRegion String Yes ap-beijing
    ServiceType String Yes emr
    DeleteTags Array of Tag No List of deleted tags
    AddTags Array of Tag No List of added tags
    ModifyTags Array of Tag No List of modified tags

    MultiDisk

    Multi-cloud disk parameters

    Used by actions: CreateInstance, InquiryPriceCreateInstance, InquiryPriceScaleOutInstance.

    Name Type Required Description
    DiskType String No Disk type
  • CLOUD_SSD: Cloud SSD.
  • CLOUD_PREMIUM: Premium cloud disk.
  • CLOUD_HSSD: Enhanced SSD.

    • Note: This field may return null, indicating that no valid values can be obtained.
    Volume Integer No Cloud disk sizeNote: This field may return null, indicating that no valid values can be obtained.
    Count Integer No Number of cloud disks of this typeNote: This field may return null, indicating that no valid values can be obtained.

    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.

    MultiZoneSetting

    Parameter information of each AZ

    Used by actions: CreateInstance, InquiryPriceCreateInstance.

    Name Type Required Description
    ZoneTag String No "master", "standby", "third-party"
    Note: This field may return null, indicating that no valid value can be obtained.
    VPCSettings VPCSettings No None
    Placement Placement No None
    ResourceSpec NewResourceSpec No None

    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

    NodeDetailPriceResult

    Price details by node, used for creating the cluster price list

    Used by actions: InquiryPriceCreateInstance.

    Name Type Description
    NodeType String The node type. Valid values: master, core, task, common, router, mysql
    Note: This field may return null, indicating that no valid values can be obtained.
    PartDetailPrice Array of PartDetailPriceItem Price details by node part

    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.
    IsDynamicSpec Integer Whether floating specification is used. 1: yes; 0: no
    Note: 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: yes
    Note: this field may return null, indicating that no valid values can be obtained.
    RootStorageType Integer System disk type
    Note: this field may return null, indicating that no valid values can be obtained.
    Zone String AZ information
    Note: this field may return null, indicating that no valid values can be obtained.
    SubnetInfo SubnetInfo Subnet
    Note: This field may return null, indicating that no valid value can be obtained.
    Clients String Client
    Note: This field may return null, indicating that no valid value can be obtained.
    CurrentTime String The current system time.
    Note: This field may return null, indicating that no valid values can be obtained.
    IsFederation Integer Whether it is used in a federation. Valid values: 0 (no), 1 (yes).
    Note: This field may return null, indicating that no valid values can be obtained.
    DeviceName String Device name
    Note: This field may return null, indicating that no valid values can be obtained.
    ServiceClient String Service
    Note: This field may return null, indicating that no valid values can be obtained.
    DisableApiTermination Boolean Enabling instance protection for this instance. Valid values: true (enable) and false (disable).
    Note: This field may return null, indicating that no valid values can be obtained.
    TradeVersion Integer The billing version. Valid values: 0 (original billing) and 1 (new billing)
    Note: This field may return null, indicating that no valid values can be obtained.
    ServicesStatus String Status of each component. Zookeeper: STARTED; ResourceManager: STARTED. STARTED indicates "already in operation"; STOPPED indicates "ceased".
    Note: This field may return null, indicating that no valid values can be obtained.

    NodeResourceSpec

    Resource details

    Used by actions: CreateCluster, ScaleOutCluster.

    Name Type Required Description
    InstanceType String Yes The spec type, such as S2.MEDIUM8.
    Note: This field may return null, indicating that no valid values can be obtained.
    SystemDisk Array of DiskSpecInfo Yes The system disk, which can be up to 1 PCS.
    Note: This field may return null, indicating that no valid values can be obtained.
    Tags Array of Tag No The list of tags to be bound.
    Note: This field may return null, indicating that no valid values can be obtained.
    DataDisk Array of DiskSpecInfo No The cloud data disk, which can be up to 15 PCS.
    Note: This field may return null, indicating that no valid values can be obtained.
    LocalDataDisk Array of DiskSpecInfo No The local data disk.
    Note: This field may return null, indicating that no valid values can be obtained.

    OpScope

    Operation scope

    Used by actions: StartStopServiceOrMonitor.

    Name Type Required Description
    ServiceInfoList Array of ServiceBasicRestartInfo No The information of the services to operate on.
    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.

    PartDetailPriceItem

    Price details by node part, used for creating the cluster price list

    Used by actions: InquiryPriceCreateInstance.

    Name Type Description
    InstanceType String The type. Valid values: node (node); rootDisk (system disk); dataDisk and metaDB (cloud data disk)
    Note: This field may return null, indicating that no valid values can be obtained.
    Price Float Rate (original)
    Note: This field may return null, indicating that no valid values can be obtained.
    RealCost Float Rate (discounted)
    Note: This field may return null, indicating that no valid values can be obtained.
    RealTotalCost Float Total price (discounted)
    Note: This field may return null, indicating that no valid values can be obtained.
    Policy Float Discount
    Note: This field may return null, indicating that no valid values can be obtained.
    GoodsNum Integer Quantity
    Note: This field may return null, indicating that no valid values can be obtained.

    PersistentVolumeContext

    Description of Pod PVC storage method

    Used by actions: ScaleOutCluster, 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 and 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: CreateCluster, CreateInstance, InquiryPriceCreateInstance, InquiryPriceRenewInstance, InquiryPriceUpdateInstance.

    Name Type Required Description
    Zone String Yes The ID of the availability zone where the instance resides, such as ap-guangzhou-1. You can call the DescribeZones API and obtain this ID from the Zone field in the response.
    ProjectId Integer No Project ID of the instance. If no ID is passed in, the default project ID is used.

    PodNewParameter

    The custom pod permission and parameter.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    InstanceId String Yes The TKE or EKS cluster ID.
    Config String Yes Custom permissions
    Examples:
    {
    "apiVersion": "v1",
    "clusters": [
    {
    "cluster": {
    "certificate-authority-data": "xxxxxx==",
    "server": "https://xxxxx.com"
    },
    "name": "cls-xxxxx"
    }
    ],
    "contexts": [
    {
    "context": {
    "cluster": "cls-xxxxx",
    "user": "100014xxxxx"
    },
    "name": "cls-a44yhcxxxxxxxxxx"
    }
    ],
    "current-context": "cls-a4xxxx-context-default",
    "kind": "Config",
    "preferences": {},
    "users": [
    {
    "name": "100014xxxxx",
    "user": {
    "client-certificate-data": "xxxxxx",
    "client-key-data": "xxxxxx"
    }
    }
    ]
    }
    Parameter String Yes Custom parameters
    Examples:
    {
    "apiVersion": "apps/v1",
    "kind": "Deployment",
    "metadata": {
    "name": "test-deployment",
    "labels": {
    "app": "test"
    }
    },
    "spec": {
    "replicas": 3,
    "selector": {
    "matchLabels": {
    "app": "test-app"
    }
    },
    "template": {
    "metadata": {
    "annotations": {
    "your-organization.com/department-v1": "test-example-v1",
    "your-organization.com/department-v2": "test-example-v2"
    },
    "labels": {
    "app": "test-app",
    "environment": "production"
    }
    },
    "spec": {
    "nodeSelector": {
    "your-organization/node-test": "test-node"
    },
    "containers": [
    {
    "name": "nginx",
    "image": "nginx:1.14.2",
    "ports": [
    {
    "containerPort": 80
    }
    ]
    }
    ],
    "affinity": {
    "nodeAffinity": {
    "requiredDuringSchedulingIgnoredDuringExecution": {
    "nodeSelectorTerms": [
    {
    "matchExpressions": [
    {
    "key": "disk-type",
    "operator": "In",
    "values": [
    "ssd",
    "sas"
    ]
    },
    {
    "key": "cpu-num",
    "operator": "Gt",
    "values": [
    "6"
    ]
    }
    ]
    }
    ]
    }
    }
    }
    }
    }
    }
    }

    PodNewSpec

    Resource descriptions for container resource scale-out

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    ResourceProviderIdentifier String Yes The identifier of an external resource provider, such as "cls-a1cd23fa".
    ResourceProviderType String Yes The type of the external resource provider, such as "tke". Currently, only "tke" is supported.
    NodeFlag String Yes The purpose of the resource, which means the node type and can only be "TASK".
    Cpu Integer Yes The number of CPUs.
    Memory Integer Yes The memory size in GB.
    CpuType String No The EKS cluster - CPU type. Valid values: intel and amd.
    PodVolumes Array of PodVolume No The data directory mounting information of the pod node.
    EnableDynamicSpecFlag Boolean No Whether the dynamic spec is used. Valid values:
  • true: Yes
  • false (default): No
    		•
    DynamicPodSpec DynamicPodSpec No The dynamic spec.
    Note: This field may return null, indicating that no valid values can be obtained.
    VpcId String No The unique VPC ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    SubnetId String No The unique VPC subnet ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    PodName String No The pod name.
    Note: This field may return null, indicating that no valid values can be obtained.

    PodParameter

    Custom pod permission and parameter

    Used by actions: ScaleOutInstance.

    Name Type Required Description
    ClusterId String Yes ID of TKE or EKS cluster
    Config String Yes Custom permissions
    Example:
    {
    "apiVersion": "v1",
    "Clusters": [
    {
    "cluster": {
    "certificate-authority-data": "xxxxxx==",
    "server": "https://xxxxx.com"
    },
    "name": "cls-xxxxx"
    }
    ],
    "contexts": [
    {
    "context": {
    "cluster": "cls-xxxxx",
    "user": "100014xxxxx"
    },
    "name": "cls-a44yhcxxxxxxxxxx"
    }
    ],
    "current-context": "cls-a4xxxx-context-default",
    "kind": "Config",
    "preferences": {},
    "users": [
    {
    "name": "100014xxxxx",
    "user": {
    "client-certificate-data": "xxxxxx",
    "client-key-data": "xxxxxx"
    }
    }
    ]
    }
    Parameter String Yes Custom parameters
    Example:
    {
    "apiVersion": "apps/v1",
    "kind": "Deployment",
    "metadata": {
    "name": "test-deployment",
    "labels": {
    "app": "test"
    }
    },
    "spec": {
    "replicas": 3,
    "selector": {
    "matchLabels": {
    "app": "test-app"
    }
    },
    "template": {
    "metadata": {
    "annotations": {
    "your-organization.com/department-v1": "test-example-v1",
    "your-organization.com/department-v2": "test-example-v2"
    },
    "labels": {
    "app": "test-app",
    "environment": "production"
    }
    },
    "spec": {
    "nodeSelector": {
    "your-organization/node-test": "test-node"
    },
    "containers": [
    {
    "name": "nginx",
    "image": "nginx:1.14.2",
    "ports": [
    {
    "containerPort": 80
    }
    ]
    }
    ],
    "affinity": {
    "nodeAffinity": {
    "requiredDuringSchedulingIgnoredDuringExecution": {
    "nodeSelectorTerms": [
    {
    "matchExpressions": [
    {
    "key": "disk-type",
    "operator": "In",
    "values": [
    "ssd",
    "sas"
    ]
    },
    {
    "key": "cpu-num",
    "operator": "Gt",
    "values": [
    "6"
    ]
    }
    ]
    }
    ]
    }
    }
    }
    }
    }
    }
    }

    PodSpec

    Resource description for container resource scale-out

    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, which means the node type and can only be "TASK".
    Cpu Integer Yes Number of CPUs
    Memory Integer Yes Memory size in GB.
    DataVolumes Array of String No Mount point of resources for the host. A 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 and amd.
    PodVolumes Array of PodVolume No Data directory mounting information of the pod node.
    IsDynamicSpec Integer No Whether floating specification is used. 1: Yes; 0: No.
    DynamicPodSpec DynamicPodSpec No Floating specification
    Note: This field may return null, indicating that no valid values can be obtained.
    VpcId String No Unique VPC ID
    Note: This field may return null, indicating that no valid values can be obtained.
    SubnetId String No Unique VPC subnet ID
    Note: This field may return null, indicating that no valid values can be obtained.
    PodName String No pod name
    Note: This field may return null, indicating that no valid values can be obtained.

    PodSpecInfo

    Other pod information.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    PodSpec PodNewSpec No The specified information such as pod spec and source for scale-out with pod resources.
    PodParameter PodNewParameter No The custom pod permission and parameter.

    PodVolume

    Description of Pod storage.

    Used by actions: ScaleOutCluster, ScaleOutInstance.

    Name Type Required Description
    VolumeType String Yes Storage type. Valid values: pvc and 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
    Remark String No Remarks

    PriceDetail

    Pricing details

    Used by actions: InquiryPriceUpdateInstance.

    Name Type Description
    ResourceId String The node ID
    Formula String The price formula
    OriginalCost Float The original price
    DiscountCost Float The discount price

    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 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.
    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, 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:
  • 4: SSD
  • 5: Premium Cloud Storage
  • 6: Enhanced SSD
  • 11: High-Throughput cloud disk
  • 12: Tremendous SSD

    • Note: this field may return null, indicating that no valid values can be obtained.
    DiskType String Yes Disk type
    Valid values:
  • CLOUD_SSD: SSD
  • CLOUD_PREMIUM: Premium Cloud Storage
  • CLOUD_BASIC: HDD

    • 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, 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.

    ScaleOutNodeConfig

    The type and number of nodes to be added.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    NodeFlag String Yes Valid values of node type:
  • MASTER

  • TASK

  • CORE

  • ROUTER
    		•
    NodeCount Integer Yes The number of nodes.

    ScaleOutServiceConfGroupsInfo

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    ServiceComponentName String No
    ConfGroupName String No

    SceneSoftwareConfig

    The configuration of cluster application scenario and supported components.

    Used by actions: CreateCluster.

    Name Type Required Description
    Software Array of String Yes The list of deployed components. The list of component options varies by ProductVersion (EMR version). For more information, see Component Version.
    The instance type, hive or flink.
    SceneName String No The scenario name, which defaults to Hadoop-Default. For more details, see here. Valid values:
    Hadoop-Kudu
    Hadoop-Zookeeper
    Hadoop-Presto
    Hadoop-Hbase
    Hadoop-Default

    ScriptBootstrapActionConfig

    The bootstrap action.

    Used by actions: CreateCluster, ScaleOutCluster.

    Name Type Required Description
    CosFileURI String Yes The COS URL of the script, in the format of https://beijing-111111.cos.ap-beijing.myqcloud.com/data/test.sh. For the COS bucket list, see Bucket List.
    ExecutionMoment String Yes The execution time of the bootstrap action script. Valid values:
  • resourceAfter: After node initialization
  • clusterAfter: After cluster start
  • clusterBefore: Before cluster start
    		•
    Args Array of String No The execution script parameter. The parameter format must comply with standard shell specifications.
    CosFileName String No The script file name.

    SearchItem

    Search field

    Used by actions: DescribeClusterNodes.

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

    ServiceBasicRestartInfo

    The services to operate on

    Used by actions: StartStopServiceOrMonitor.

    Name Type Required Description
    ServiceName String No The service name (required), such as HDFS.
    ComponentInfoList Array of ComponentBasicRestartInfo No If it is left empty, all processes will be operated on.

    ShortNodeInfo

    Node information

    Used by actions: DescribeInstances.

    Name Type Required Description
    NodeType String No Node type: Master/Core/Task/Router/Common
    Note: This field may return null, indicating that no valid value can be obtained.
    NodeSize Integer No Number of nodes
    Note: This field may return null, indicating that no valid value can be obtained.

    SoftDependInfo

    Client component dependencies

    Used by actions: DescribeInstancesList.

    Name Type Description
    SoftName String The component name.
    Required Boolean Whether the component is required.

    StrategyConfig

    Restart, stop, or start of service/monitoring configurations

    Used by actions: StartStopServiceOrMonitor.

    Name Type Required Description
    RollingRestartSwitch Integer No 0: Disable rolling restart
    1: Enable rolling restart
    Note: This field may return null, indicating that no valid values can be obtained.
    BatchSize Integer No The quantity of restarts per batch during a rolling restart, with the maximum number of restarts being 99999
    Note: This field may return null, indicating that no valid values can be obtained.
    TimeWait Integer No The wait time (in seconds) per batch in rolling restart, with a maximum value of 5 minutes.
    Note: This field may return null, indicating that no valid values can be obtained.
    DealOnFail Integer No The failure handling policy. Valid values: 0 (blocks the process) and 1 (skips).
    Note: This field may return null, indicating that no valid values can be obtained.

    SubnetInfo

    Subnet information

    Used by actions: DescribeClusterNodes, DescribeInstances.

    Name Type Required Description
    SubnetName String No Subnet information (name)
    Note: This field may return null, indicating that no valid value can be obtained.
    SubnetId String No Subnet information (ID)
    Note: This field may return null, indicating that no valid value can be obtained.

    Tag

    Tag

    Used by actions: CreateCluster, CreateInstance, DescribeClusterNodes, DescribeInstances, DescribeInstancesList, InquiryPriceCreateInstance, InquiryPriceScaleOutInstance, ModifyResourcesTags, ScaleOutCluster, ScaleOutInstance.

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

    TopologyInfo

    Cluster node topology information

    Used by actions: DescribeInstances.

    Name Type Required Description
    ZoneId Integer No AZ ID
    Note: This field may return null, indicating that no valid value can be obtained.
    Zone String No AZ information
    Note: This field may return null, indicating that no valid value can be obtained.
    SubnetInfoList Array of SubnetInfo No Subnet information
    Note: This field may return null, indicating that no valid value can be obtained.
    NodeInfoList Array of ShortNodeInfo No Node information
    Note: This field may return null, indicating that no valid value can be obtained.

    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

    UserInfoForUserManager

    Added user information list

    Used by actions: AddUsersForUserManager.

    Name Type Required Description
    UserName String Yes Username
    UserGroup String Yes The group to which the user belongs
    PassWord String Yes
    ReMark String No

    UserManagerFilter

    User management list filter

    Used by actions: DescribeUsersForUserManager.

    Name Type Required Description
    UserName String No Username
    Note: This field may return null, indicating that no valid value can be obtained.

    UserManagerUserBriefInfo

    Brief user information in user management

    Used by actions: DescribeUsersForUserManager.

    Name Type Description
    UserName String Username
    UserGroup String The group to which the user belongs
    UserType String Manager represents an admin, and NormalUser represents a general user.
    CreateTime String Account creation time
    Note: This field may return null, indicating that no valid value can be obtained.
    SupportDownLoadKeyTab Boolean Whether the corresponding Keytab file of the user is available for download. This parameter applies only to a Kerberos-enabled cluster.
    DownLoadKeyTabUrl String Download link of the Keytab file
    Note: This field may return null, indicating that no valid value can be obtained.

    VPCSettings

    VPC parameters

    Used by actions: CreateInstance, InquiryPriceCreateInstance.

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

    VirtualPrivateCloud

    VPC parameters

    Used by actions: CreateCluster.

    Name Type Required Description
    VpcId String Yes The VPC ID.
    SubnetId String Yes The subnet ID.

    ZoneDetailPriceResult

    Price details by AZ, used for creating the cluster price list

    Used by actions: InquiryPriceCreateInstance.

    Name Type Description
    ZoneId String AZ ID
    Note: This field may return null, indicating that no valid values can be obtained.
    NodeDetailPrice Array of NodeDetailPriceResult Price details by node

    ZoneResourceConfiguration

    AZ configurations

    Used by actions: CreateCluster.

    Name Type Required Description
    VirtualPrivateCloud VirtualPrivateCloud No The VPC configuration information. This parameter is used to specify the VPC ID, subnet ID and other information.
    Note: This field may return null, indicating that no valid values can be obtained.
    Placement Placement No The instance location. This parameter is used to specify the AZ, project, and other attributes of the instance.
    Note: This field may return null, indicating that no valid values can be obtained.
    AllNodeResourceSpec AllNodeResourceSpec No The specs of all nodes.
    Note: This field may return null, indicating that no valid values can be obtained.
    ZoneTag String No For a single AZ, ZoneTag can be left out. For a double-AZ mode, ZoneTag is set to master and standby for the first and second AZs, respectively. If there are three AZs, ZoneTag is set to master, standby, and third-party for the first, second, and third AZs, respectively. Valid values:
  • master

  • standby

  • third-party

    • Note: This field may return null, indicating that no valid values can be obtained.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy