tencent cloud

Data Types
最后更新时间：2025-11-13 20:49:21
Data Types
最后更新时间： 2025-11-13 20:49:21

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 Number of Master nodes.
CoreCount Integer No Number of core nodes.
TaskCount Integer No Number of task nodes.
CommonCount Integer No Number of common nodes.

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

Arg

General parameters

Used by actions: StartStopServiceOrMonitor.

Name Type Required Description
Key String No key
Values Array of String No Value List

Note: This field may return null, indicating that no valid values can be obtained.

AutoScaleGroupAdvanceAttrs

Advanced settings of the auto-scaling group.

Used by actions: DescribeAutoScaleGroupGlobalConf.

Name Type Required Description
ComputeResourceAdvanceParams ComputeResourceAdvanceParams No Advanced settings of computing resources.

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. 0: disable, 1: enable.
CompensateCount Integer Number of compensations.
RetryCount Integer Number of retries.
RetryInfo String Retry information.
RetryEnReason String Retry description in English.
RetryReason String Retry description.

AutoScaleResourceConf

Elastic scaling specification configuration

Used by actions: DescribeAutoScaleGroupGlobalConf.

Name Type Required Description
Id Integer No Configuration ID.
ClusterId Integer No Cluster instance ID.
ScaleLowerBound Integer No Minimum number of instances retained for automatic scaling
ScaleUpperBound Integer No Maximum number of instances for auto scaling
StrategyType Integer No Scale-out rule type. 1: load-based scale-out rule, 2: time-based scale-out rule
NextTimeCanScale Integer No Next scale-out time.
GraceDownFlag Boolean No Graceful scale-in switch.
HardwareType String No "CVM" indicates that the CVM type is used for all specifications, and "Pod" indicates that the container type is used for specifications. The default value is "CVM".
PayMode String No "POSTPAY" indicates the sole adoption of pay-as-you-go, and "SPOT_FIRST" indicates spot instance first, which is only supported when HardwareType is "HOST". "Pod" only supports pay-as-you-go.
PostPayPercentMin Integer No The minimum percentage of pay-as-you-go resources in scenarios with spot instance first. It is an integer.
ChangeToPod Integer No When resource type is preset to HOST: Supports enabling/disabling "Fallback to pod when resources are insufficient"; Default state: 0 (disabled), Toggle state: 1 (enabled).
GroupName String No Scaling group name.
YarnNodeLabel String No Tag.
GroupStatus Integer No Scaling group status.
Parallel Integer No Parallel scaling. 0: disabled; 1: enabled.
EnableMNode Integer No Whether MNode is supported.
ExtraAdvanceAttrs AutoScaleGroupAdvanceAttrs No More scaling group settings.

CBSInstance

CBS instance information.

Used by actions: DescribeNodeDataDisks.

Name Type Description
DiskId String Cloud disk ID.
DiskUsage String Cloud disk type.
DiskName String Cloud disk name.
DiskSize Integer Cloud disk size.
DiskType String Cloud disk media type.
DeleteWithInstance Boolean Whether to delete it with the instance.
DiskChargeType String Cloud disk billing type.
DiskState String Cloud disk running status.
RenewFlag String Whether to perform auto-renewal.
DeadlineTime String Expiration time.
Attached Boolean Whether the cloud disk is mounted on the cloud host.
DifferDaysOfDeadline Integer Days remaining until disk expiration.
InstanceIdList Array of String InstanceId of the CVM instance to which this cloud disk is currently mounted.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String ID of the cloud host to which the Cloud disk is mounted.
Shareable Boolean Whether the cloud disk is a shared cloud disk.
EmrResourceId String EMR node ID.
UnderwriteExpiredTime String Committed use expiration time.

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

CapacityGlobalConfig

Global configurations of the capacity scheduler under Resource Scheduling.

Used by actions: DescribeGlobalConfig.

Name Type Description
EnableLabel Boolean Whether label-based scheduling is enabled.
LabelDir String Path for tag information storage if label-based scheduling is enabled.
Note: This field may return null, indicating that no valid values can be obtained.
QueueMappingOverride Boolean Whether to overwrite the user-specified queue, wherein true indicates overwrite.
Note: This field may return null, indicating that no valid values can be obtained.
DefaultSettings Array of DefaultSetting Advanced settings.
Note: This field may return null, indicating that no valid values can be obtained.

CdbInfo

Output parameters

Used by actions: DescribeClusterNodes.

Name Type Description
InstanceName String Database instance.
Ip String Database IP address.
Port Integer Database port.
MemSize Integer Database memory specifications.
Volume Integer Database disk specifications.
Service String Service identifier.
ExpireTime String Expiration time.
ApplyTime String Application time.
PayType Integer Billing type.
ExpireFlag Boolean Expiration flag.
Status Integer Database status.
IsAutoRenew Integer Renewal flag.
SerialNo String Database string.
ZoneId Integer ZoneId
RegionId Integer RegionId

ClusterExternalServiceInfo

Relationship between shared components and the current cluster

Used by actions: DescribeInstances.

Name Type Description
DependType Integer Dependency relationship. 0: being depended on by other clusters, 1: depending on other clusters.
Service String Shared component.
ClusterId String Shared cluster.
ClusterStatus Integer Shared cluster status.

ClusterIDToFlowID

Mapping of cluster ID and process ID

Used by actions: ModifyResourcesTags.

Name Type Description
ClusterId String Cluster ID.
FlowId Integer Flow ID.

ClusterInstancesInfo

Cluster instance information

Used by actions: DescribeInstances.

Name Type Description
Id Integer ID.
ClusterId String Cluster ID.
ClusterName String Cluster name.
RegionId Integer Region ID.
ZoneId Integer Region ID.
AppId Integer User AppID.
Uin String User UIN.
ProjectId Integer Project ID.
VpcId Integer Cluster VPCID.
SubnetId Integer Subnet ID.
Status Integer Instance status code. Valid range:
  • 2: the cluster is running.
  • 3: the cluster is being created.
  • 4: the cluster is being scaled out.
  • 5: Router nodes are being added to the cluster.
  • 6: components are being installed in the cluster.
  • 7: commands are being executed in the cluster.
  • 8: the service is being restarted.
  • 9: maintenance is in progress.
  • 10: the service is being suspended.
  • 11: the cluster is exiting maintenance.
  • 12: the cluster is exiting suspension.
  • 13: the configuration is being distributed.
  • 14: the cluster is being terminated.
  • 15: the Core node is being destroyed.
  • 16: the Task node is being destroyed.
  • 17: the Router node is being destroyed.
  • 18: the web proxy password is being changed.
  • 19: the cluster is being isolated.
  • 20: the cluster is undergoing a reversal transaction.
  • 21: the cluster is being recycled.
  • 22: the instance is waiting for resizing.
  • 23: the cluster has been isolated.
  • 24: the number of nodes is being reduced.
  • 33: the cluster is waiting for a refund.
  • 34: the cluster has received a refund.
  • 301: creation failed.
  • 302: scale-out failed.
    		•
    AddTime String Adding time.
    RunTime String Runtime.
    MasterIp String Public network IP address of the primary node.
    EmrVersion String EMR version.
    ChargeType Integer Charge type.
    TradeVersion Integer Transaction version.
    ResourceOrderId Integer Resource order ID.
    IsTradeCluster Integer Whether it is a billing cluster.
    AlarmInfo String Alarm information of cluster error status.
    IsWoodpeckerCluster Integer Whether to adopt new architecture.
    MetaDb String Metadatabase information.
    Tags Array of Tag Tag information
    Note: this field may return null, indicating that no valid values can be obtained.
    HiveMetaDb String Hive metadata information.
    ServiceClass String Cluster type: EMR,CLICKHOUSE,DRUID.
    AliasInfo String Alias serialization of all nodes in the cluster.
    ProductId Integer Cluster version ID.
    Zone String Region ID.
    SceneName String Scenario name.
    SceneServiceClass String Scenario-based cluster type.
    SceneEmrVersion String Scenario-based EMR version.
    DisplayName String Scenario-based cluster type.
    VpcName String vpc name
    SubnetName String subnet name
    ClusterExternalServiceInfo Array of ClusterExternalServiceInfo Cluster dependency
    Note: This field may return null, indicating that no valid value was found.
    UniqVpcId String Cluster vpcid string type.
    UniqSubnetId String Subnet ID string type.
    TopologyInfoList Array of TopologyInfo Node information
    Note: This field may return null, indicating that no valid values can be obtained.
    IsMultiZoneCluster Boolean Whether it is a cross-AZ cluster.
    IsCvmReplace Boolean Whether to enable automatic compensation for abnormal nodes.
    ClusterTitle String Title.
    ConfigDetail EmrProductConfigDetail Cluster product configuration information

    Note: This field may return null, indicating that no valid values can be obtained.
    BindFileSystemNum Integer Number of file systems bound to a cluster.
    ClusterRelationInfoList Array of ClusterRelationMeta Bound list of the RSS cluster.
    Note: This field may return null, indicating that no valid values can be obtained.
    RedisId String Redis information.

    ClusterRelationMeta

    Inter-cluster binding and usage information.

    Used by actions: DescribeInstances.

    Name Type Required Description
    ClusterType String No Cluster type.
    ClusterIdList Array of String No Cluster ID list.
    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 Process name which is required, such as NameNode.
    IpList Array of String No The target IP list.
    Note: This field may return null, indicating that no valid values can be obtained.

    ComputeResourceAdvanceParams

    Advanced settings of computing resources.

    Used by actions: DescribeAutoScaleGroupGlobalConf, ScaleOutInstance.

    Name Type Required Description
    Labels Array of TkeLabel No Node label array.
    Taints Array of Taint No Node taint.
    PreStartUserScript String No Base64-encoded user script: executed before node initializing.
    UserScript String No Base64-encoded user script. This script executes after Kubernetes components initialize. Users should ensure script reentrancy and implement retry logic. Both the script and its generated log files are accessible at the node path: /data/ccs_userscript/.

    ConfigModifyInfoV2

    Resource scheduling - Queue modification information

    Used by actions: ModifyYarnQueueV2.

    Name Type Required Description
    OpType Integer Yes Operation type. Valid values:

    - 0: create a queue.
    - 1: edit - full overwrite.
    - 2: create a sub-queue.
    - 3: delete.
    - 4: clone. It is the same as sub-queue creation. Especially, for fair, a sub-queue can be copied to a new queue.
    - 6: edit - incremental update.
    Name String No Queue name. It cannot be modified.
    ParentId String No Create root queue: Pass "myId of root"; Create sub-queue: Pass "myId of the selected queue"; Clone queue: Pass "parentId of the selected queue".
    MyId String No Edit or delete operations: Require passing "myId of the selected queue". Passing is required for cloning only when the scheduler is fair in order to copy a sub-queue to a new queue.
    BasicParams ItemSeq No Basic configuration. The value of key is consistent with the field returned by DescribeYarnQueue.###### Fair scheduler
    Values of key are as follows:

    - type: parent queue. Value: parent or null.
    - aclSubmitApps: submission ACL. Value: JSON string of the AclForYarnQueue type or null.
    - aclAdministerApps: administration ACL. Value: JSON string of the AclForYarnQueue type or null.
    - minSharePreemptionTimeout: timeout of minimum share before preemption. Value: numeric string or null.
    - fairSharePreemptionTimeout: timeout of fair share before preemption. Value: numeric string or null.
    - fairSharePreemptionThreshold: fair share preemption threshold. Value: numeric string or null. Numeric string range: (0,1].
    - allowPreemptionFrom: preemption mode. Value: Boolean string or null.
    - schedulingPolicy: scheduling policy. Value: drf, fair, fifo, or null.

    <br/>type AclForYarnQueue struct {<br/> User *string `json:"user"` // Username<br/> Group *string `json:"group"`// Group name<br/>}<br/>
    ###### Capacity scheduler
    Values of key are as follows:

    - state: queue status. Value: STOPPED or RUNNING.
    - default-node-label-expression: default tag expression. Value: tag or null.
    - acl_submit_applications: submission ACL. Value: JSON string of the AclForYarnQueue type or null.
    - acl_administer_queue: administration ACL. Value: JSON string of the AclForYarnQueue type or null.
    - maximum-allocation-mb: maximum memory allocated to each container. Value: numeric string or null.
    - maximum-allocation-vcores: maximum number of virtual cores allocated to each container. Value: numeric string or null.
    <br/>type AclForYarnQueue struct {<br/> User *string `json:"user"` // Username<br/> Group *string `json:"group"`// Group name<br/>}<br/>
    Note: This field may return null, indicating that no valid values can be obtained.
    ConfigSetParams Array of ConfigSetInfo No Configuration set information. For the values, see the parameter description of ConfigSetInfo. Configuration set is the representation of the plan mode in the queue, containing different configuration item values for different time periods. The configuration set names of all queues are the same. For a single queue, the tags and parameters in each configuration set are the same, but the parameter values are different.
    Note: This field may return null, indicating that no valid values can be obtained.
    DeleteLables Array of String No This parameter is specific for capacity scheduling and is valid only when OpType is set to 6. It indicates tags to be deleted from the queue. This parameter has a higher priority than LabelParams in ConfigSetParams.
    Note: This field may return null, indicating that no valid values can be obtained.

    ConfigSetInfo

    Resource scheduling - configuration set information.

    Used by actions: ModifyYarnQueueV2.

    Name Type Required Description
    ConfigSet String Yes Configuration set name.
    LabelParams Array of ItemSeq No The capacity scheduler will use it, where tag-related configuration is set. The key values are consistent with the fields returned by DescribeYarnQueue.
    The key values are as follows:
    - labelName: Tag name, that is, tags in tag management.
    - capacity: Capacity. The value is a numeric string.
    - maximum-capacity: Maximum capacity. The value is a numeric string.
    Note: This field may return null, indicating that no valid values can be obtained.
    BasicParams Array of Item No Set parameters related to the configuration set. The key values are consistent with the fields returned by DescribeYarnQueue.
    ###### Fair scheduler.
    The key values are as follows:
    - minResources: Minimum resource amount. The value is a JSON string of the YarnResource type or null.
    - maxResources: Maximum resource amount. The value is a JSON string of the YarnResource type or null.
    - maxChildResources: Maximum resource amount for undeclared subqueues. The value is a numeric string or null.
    - maxRunningApps: Maximum number of apps that can run concurrently. The value is a numeric string or null.
    - weight: weight. The value is a numeric string or null.
    - maxAMShare: Maximum App Master share. The value is a numeric string or null, where the number range is [0,1] or -1.

    <br/>type YarnResource struct {<br/> Vcores *int `json:"vcores"`<br/> Memory *int `json:"memory"`<br/> Type *string `json:"type"` // The value can be percent or null. When the value is percent, it indicates the percentage used; otherwise, the absolute value used is indicated. The value can be percent only for maxResources and maxChildResources.<br/>}<br/>

    ###### Capacity scheduler.
    The key values are as follows:
    - minimum-user-limit-percent: Minimum user capacity. The value is a JSON string of the YarnResource type or null, where the number range is [0,100].
    - user-limit-factor: User resource factor. The value is a JSON string of the YarnResource type or null.
    - maximum-applications: Maximum number of applications, that is, Max-Applications. The value is a numeric string or null, where the numbers must be positive integers.
    - maximum-am-resource-percent: maximum AM percent. The value is a numeric string or null, where the number range is [0,1] or -1.
    - default-application-priority: Resource pool priority. The value is a numeric string or null, where the numbers must be positive integers.
    Note: This field may return null, indicating that no valid values can be obtained.

    ConfigurationItem

    Configuration item (configuration management page).

    Used by actions: DescribeServiceConfGroupInfos.

    Name Type Required Description
    Name String Yes Configuration item name.
    Value String Yes Configuration item value.
    InFile String No Name of the configuration file where the configuration item is located.

    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

    DAGInfo

    DAG information.

    Used by actions: DescribeDAGInfo.

    Name Type Required Description
    ID String No Query ID.
    Type String No DAG type. Only StarRocks is supported currently.
    Content String No Returned JSON string of the DAG.

    DayRepeatStrategy

    Description of daily repeated tasks for elastic scaling

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    ExecuteAtTimeOfDay String Yes Specific time for repetition task execution, such as 01:02:00.
    Step Integer Yes Executing every Step days.

    DefaultSetting

    Default configurations of resource scheduling.

    Used by actions: DescribeGlobalConfig.

    Name Type Description
    Name String Name: the key for input parameters.
    Desc String Description.
    Prompt String Prompt.
    Key String Key: display the configuration item in the configuration file.
    Value String Name 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.

    DescribeNodeSpec

    Node specifications.

    Used by actions: DescribeNodeSpec.

    Name Type Required Description
    NodeType String Yes Node type.
    NodeName String Yes Node type name.
    Types Array of NodeSpecType No Types array.
    Note: This field may return null, indicating that no valid values can be obtained.
    CmnTypes Array of NodeSpecType No Cloud Managed Node (M Node) model specifications list.
    Note: This field may return null, indicating that no valid values can be obtained.

    DescribeResourceConfig

    Output parameters of the DescribeResourceConfig API.

    Used by actions: DescribeNodeResourceConfigFast.

    Name Type Description
    ResourceType String Specification management type.
    ResourceData Array of NodeResource Specification management data.

    DiffDetail

    Dynamically generated change details.

    Used by actions: DescribeResourceScheduleDiffDetail.

    Name Type Description
    Name String Tab page header.
    Count Integer Number of change items.
    Rows Array of DiffDetailItem Detailed data to be rendered.
    Note: This field may return null, indicating that no valid values can be obtained.
    Header Array of DiffHeader Header information to be rendered.
    Note: This field may return null, indicating that no valid values can be obtained.

    DiffDetailItem

    Dynamically generated change detail entries.

    Used by actions: DescribeResourceScheduleDiffDetail.

    Name Type Description
    Attribute String Attribute.
    InEffect String Currently effective.
    PendingEffectiveness String To be effective.
    Operation String Operation.
    Queue String Queue.
    ConfigSet String Configuration set.
    LabelName String Tag.
    InEffectIndex String Current position.
    PendingEffectIndex String Position to be effective.
    PlanName String Plan mode name.
    Label String Tag.
    RuleName String Placement rule.
    UserName String Username.

    DiffHeader

    Dynamically generated change details.

    Used by actions: DescribeResourceScheduleDiffDetail.

    Name Type Description
    Name String Name
    Id String ID, which is used by the front end.

    DiskSpecInfo

    Node disk information

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    Count Integer Yes Number of disks.
    DiskType String Yes Valid values of the system disk type:
  • CLOUD_SSD: Cloud SSD.
  • CLOUD_PREMIUM: Premium Cloud Disk.
  • CLOUD_BASIC: Cloud Disk.
  • LOCAL_BASIC: Local Disk.
  • LOCAL_SSD: Local SSD.


    • Valid values of the data disk type.
  • CLOUD_SSD: Cloud SSD.
  • CLOUD_PREMIUM: Premium Cloud Disk.
  • CLOUD_BASIC: Cloud Disk.
  • LOCAL_BASIC: Local Disk.
  • LOCAL_SSD: Local SSD.
  • CLOUD_HSSD: Enhanced SSD.
  • CLOUD_THROUGHPUT: Throughput HDD.
  • CLOUD_TSSD: Tremendous SSD.
  • CLOUD_BIGDATA: Big Data Cloud Disk.
  • CLOUD_HIGHIO: High IO Cloud Disk.
  • CLOUD_BSSD: Balanced SSD.
  • REMOTE_SSD: Remote SSD.

    		•
    DiskSize Integer Yes Data capacity in GB.
    ExtraPerformance Integer No Additional performance.

    Dps

    Sampling sequence.

    Used by actions: DescribeHDFSStorageInfo.

    Name Type Required Description
    Timestamp String No Timestamp.
    Value String No Sampling value.

    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 Common status: cluster in production, cluster running, cluster creating, cluster closed, and cluster deleted.
    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.
    ProjectId Integer Project ID.
    RegionId Integer Region.
    SubnetId Integer Subnet ID.
    VpcId Integer Network ID.
    Zone String Region.
    Status Integer Status code. Valid values: -2 (cluster deleted), -1 (cluster closed), 0 (cluster in production), 2 (cluster running), 3 (cluster creating).
    Tags Array of Tag Instance tag
    Note: This field may return null, indicating that no valid value can be obtained.
    AlarmInfo String Alarm information.
    IsWoodpeckerCluster Integer Whether it is a Woodpecker cluster.
    VpcName String VPC name in Chinese.
    SubnetName String Subnet in Chinese.
    UniqVpcId String String VpcId.
    UniqSubnetId String String subnet.
    ClusterClass String Cluster type.
    IsMultiZoneCluster Boolean Whether it is a cross-AZ cluster.
    IsHandsCluster Boolean Whether it is a cluster created by a cluster CVM.
    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's scenarios support external clients.
    IsDedicatedCluster Boolean Whether the cluster is used in a dedicated cluster scenario.
    IsSupportClone Boolean Cluster supports for cloning.

    EmrPrice

    EMR inquiry description

    Used by actions: InquiryPriceScaleOutInstance.

    Name Type Description
    OriginalCost String List price.
    DiscountCost String Discounted price.
    Unit String Unit.
    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.

    EmrProductConfigDetail

    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.
    CoreNodeSize Integer Number of Core nodes.
    TaskNodeSize Integer Number of Task nodes.
    ComNodeSize Integer Number of Common nodes.
    MasterResource ResourceDetail Primary node resources

    Note: This field may return null, indicating that no valid values can be obtained.
    CoreResource ResourceDetail Core node resources

    Note: This field may return null, indicating that no valid values can be obtained.
    TaskResource ResourceDetail Task node resources

    Note: This field may return null, indicating that no valid values can be obtained.
    ComResource ResourceDetail Common node resources

    Note: This field may return null, indicating that no valid values can be obtained.
    OnCos Boolean Whether to use COS.
    ChargeType Integer Charge type.
    RouterNodeSize Integer Number of Router nodes.
    SupportHA Boolean Whether HA is supported.
    SecurityOn Boolean Whether security mode is supported.
    SecurityGroup String Security group name.
    CbsEncrypt Integer Whether to enable CBS encryption.
    ApplicationRole String Custom application role.
    SecurityGroups Array of String Security group.
    Note: This field may return null, indicating that no valid values can be obtained.
    PublicKeyId String SSH key ID.

    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

    FairGlobalConfig

    Global configurations of the fair scheduler under Resource Scheduling.

    Used by actions: DescribeGlobalConfig.

    Name Type Description
    UserMaxAppsDefault Integer Corresponds to

    Program Upper Limit

    of the page.
    Note: This field may return null, indicating that no valid values can be obtained.

    Filter

    A key-value pair filter used for condition filtering and queries.

    Used by actions: DescribeGroupsSTD.

    Name Type Required Description
    Name String No Fields that need to be filtered.
    Values Array of String No Filter value of the field.

    Filters

    Custom query filter of the EMR cluster instance list

    Used by actions: DescribeInstancesList, DescribeNodeDataDisks, DescribeSLInstanceList.

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

    FlowExtraDetail

    Additional process information.

    Used by actions: DescribeClusterFlowStatusDetail.

    Name Type Description
    Title String Additional information title.
    Detail Array of FlowParamsDesc Additional information.
    Note: This field may return null, indicating that no valid values can be obtained.

    FlowParam

    FlowParam process parameters.

    Used by actions: DescribeClusterFlowStatusDetail.

    Name Type Required Description
    FKey String Yes Process parameter key.
    TraceId: Query by TraceId.
    FlowId: Query by FlowId.
    FValue String Yes Parameter value

    FlowParamsDesc

    Task parameter description

    Used by actions: DescribeClusterFlowStatusDetail.

    Name Type Description
    PKey String Parameter key
    PValue String Parameter value.

    GroupGlobalConfs

    Global parameter information of all scaling groups in the cluster.

    Used by actions: DescribeAutoScaleGroupGlobalConf.

    Name Type Required Description
    GroupGlobalConf AutoScaleResourceConf No Scaling group information.
    Note: This field may return null, indicating that no valid values can be obtained.
    CurrentNodes Integer No Number of nodes scaled out in the current scaling group.
    CurrentPostPaidNodes Integer No Number of postpaid nodes scaled out in the current scaling group.
    CurrentSpotPaidNodes Integer No Number of spot instance nodes scaled out in the current scaling group.

    GroupInfo

    User group information.

    Used by actions: CreateGroupsSTD.

    Name Type Required Description
    GroupName String No Group name.
    Description String No Remarks.
    Users Array of String No User list.

    GroupInfos

    User group information.

    Used by actions: DescribeGroupsSTD.

    Name Type Required Description
    GroupName String No User group name.
    Users Array of String No User name list.
    Description String No Remarks.
    CreateTime String No Creation time.
    GroupType Integer No User group type.
    GroupTypeDesc String No User group type description.

    HealthStatus

    Process health status

    Used by actions: DescribeServiceNodeInfos.

    Name Type Description
    Code Integer Running normally.
    Text String Running normally.
    Desc String Running normally.

    HiveQuery

    Hive query details

    Used by actions: DescribeHiveQueries.

    Name Type Description
    Statement String Query statement.
    Duration String Execution duration.
    StartTime Integer Start time in milliseconds.
    EndTime Integer End time in milliseconds.
    State String Status.
    User String User.
    JobIds Array of String AppId List
    Note: This field may return null, indicating that no valid values can be obtained.
    ExecutionEngine String Execution engine.
    Id String Query ID.

    HostVolumeContext

    Description of HostPath mounting method in the pod

    Used by actions: ScaleOutInstance.

    Name Type Required Description
    VolumePath String Yes Directory for mounting the host in the pod. As 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.

    InsightResult

    Insight result item.

    Used by actions: DescribeInsightList.

    Name Type Required Description
    ID String No When Type is HIVE, the value is Hive query ID; when Type is MAPREDUCE, SPARK or TEZ, the value is YarnAppID.
    Type String No Insight application type. Value values: HIVE, SPARK, MAPREDUCE, and TEZ.
    RuleID String No Insight rule ID.
    HIVE-ScanManyMeta: too much scanned metadata.
    HIVE-ScanManyPartition: large table scanning.
    HIVE-SlowCompile: compilation duration too long.
    HIVE-UnSuitableConfig: improper parameter.
    MAPREDUCE-MapperDataSkew: Map data skew.
    MAPREDUCE-MapperMemWaste: MapMemory resource waste.
    MAPREDUCE-MapperSlowTask: slow map task.
    MAPREDUCE-MapperTaskGC:MapperTaskGC
    MAPREDUCE-MemExceeded: peak memory exceeded.
    MAPREDUCE-ReducerDataSkew: Reduce data skew.
    MAPREDUCE-ReducerMemWaste: ReduceMemory resource waste.
    MAPREDUCE-ReducerSlowTask: slow reduce task.
    MAPREDUCE-ReducerTaskGC:ReducerTaskGC
    MAPREDUCE-SchedulingDelay: scheduling delay.
    SPARK-CpuWaste: CPU resource waste.
    SPARK-DataSkew: data skew.
    SPARK-ExecutorGC:ExecutorGC
    SPARK-MemExceeded: peak memory exceeded.
    SPARK-MemWaste: Memory resource waste.
    SPARK-ScheduleOverhead:ScheduleOverhead
    SPARK-ScheduleSkew: scheduling skew.
    SPARK-SlowTask: slow task.
    TEZ-DataSkew: data skew.
    TEZ-MapperDataSkew: Map data skew.
    TEZ-ReducerDataSkew: Reduce data skew.
    TEZ-TezMemWaste: Memory resource waste.
    TEZ-TezSlowTask: slow task.
    TEZ-TezTaskGC:TasksGC
    RuleName String No Insight rule name. Refer to the description of RuleID.
    RuleExplain String No Insight rules interpretation.
    Detail String No Details.
    Suggestion String No Recommended message.
    Value Integer No Anomaly metrics measure insight severity. Higher values indicate greater severity within the same insight category. Metrics across different insight types cannot be meaningfully compared.
    ScheduleTaskExecID String No Scheduling task execution ID.
    ScheduleFlowName String No Scheduling flow, DAG.
    ScheduleTaskName String No A Task node in the scheduling flow.
    JobConf String No Core configurations for Yarn tasks.
    Context String No Insight structure information.
    Note: This field may return null, indicating that no valid values can be obtained.

    InspectionTaskSettings

    Setting inspection task configurations.

    Used by actions: ModifyInspectionSettings.

    Name Type Required Description
    TaskType String Yes Unique identifier for inspection tasks.
    Group String No Inspection task group name.
    Name String No Inspection task name.
    TaskSettings Array of TaskSettings No Inspection task parameter settings.
    Selected String No Whether it is selected, with the valid values of "true" and "false".
    Enable String No Whether monitoring is enabled.
    SettingsJson String No Event JSON template.

    InstanceChargePrepaid

    Instance prepayment parameter. This parameter is valid only when the payment 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
    		•

    Item

    A key-value structure

    Used by actions: ModifyGlobalConfig, ModifyYarnQueueV2.

    Name Type Required Description
    Key String Yes Key value.
    Value String Yes Value.

    ItemSeq

    List of key-value pairs

    Used by actions: ModifyYarnQueueV2.

    Name Type Required Description
    Items Array of Item Yes Tag name.
    Note: This field may return null, indicating that no valid values can be obtained.

    KeyValue

    Key-value pair, primarily used for filtering

    Used by actions: DescribeAutoScaleRecords.

    Name Type Required Description
    Key String Yes Key.
    Value String Yes Value.

    KyuubiQueryInfo

    Kyuubi query information.

    Used by actions: DescribeKyuubiQueryInfo.

    Name Type Description
    ClientIP String Submitter IP address.
    Duration Integer Execution duration.
    EndTime Integer End time.
    EngineID String Engine Id
    EngineType String Computing engine.
    Id String ID
    SessionID String Session Id
    BeginTime Integer Start time.
    ExecutionState String Execution status.
    ExecutionStatement String Execution statement.
    StatementID String Statement Id
    User String User who submits requests.

    LoadAutoScaleStrategy

    Automatic scaling rule based on load metrics

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    StrategyId Integer No Rule ID.
    StrategyName String No Rule name.
    CalmDownTime Integer No Cooling time for a rule to take effect.
    ScaleAction Integer No Scaling action. 1: scale-out, 2: scale-in.
    ScaleNum Integer No Scaling amount each time the rule takes effect.
    ProcessMethod Integer No Metric processing method. 1: MAX, 2: MIN, 3: AVG.
    Priority Integer No Rule priority, which is not applicable during adding. The default is auto-increment.
    StrategyStatus Integer No Rule status. 1: enabled, 3: disabled.
    YarnNodeLabel String No Specified Yarn Node Label for rule scale-out.
    PeriodValid String No Effective time of the rule
    GraceDownFlag Boolean No Graceful scale-in switch
    GraceDownTime Integer No Graceful scale-in wait time
    Tags Array of Tag No Bound tag list

    Note: This field may return null, indicating that no valid values can be obtained.
    ConfigGroupAssigned String No Preset configuration group.
    MeasureMethod String No Calculation method of scale-out resources:"DEFAULT","INSTANCE", "CPU", "MEMORYGB".
    "DEFAULT" indicates the default method, which is the same as "INSTANCE".
    "INSTANCE" indicates calculation based on nodes (default mode).
    "CPU" indicates calculation based on the quantity of cores of the machine.
    "MEMORYGB" indicates calculation based on the memory size of the machine.
    SoftDeployDesc Array of String No Node deployment service list, such as ["HDFS-3.1.2","YARN-3.1.2"].
    Note: This field may return null, indicating that no valid values can be obtained.
    ServiceNodeDesc String No Startup process list, such as ["NodeManager"].
    ServiceNodeInfo Array of Integer No Startup process list.
    Note: This field may return null, indicating that no valid values can be obtained.
    SoftDeployInfo Array of Integer No Node deployment service list. Only HDFS and YARN should be specified in the deployment service list. For details, see Mapping Table for Component Names.
    Note: This field may return null, indicating that no valid values can be obtained.
    LoadMetricsConditions LoadMetricsConditions No Multi-metric trigger condition.
    Note: This field may return null, indicating that no valid values can be obtained.
    GroupId Integer No Scaling group ID.
    Soft String No Soft (for example, YARN).

    LoadMetricsCondition

    Load metric condition.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    StatisticPeriod Integer No Rule statistics cycle. Options include 1 min, 3 min, and 5 min.
    TriggerThreshold Integer No Trigger count. Scaling begins only after it has been triggered continuously more than TriggerThreshold times.
    LoadMetrics String No Scaling load metric.
    MetricId Integer No Rule metadata record ID.
    Conditions Array of TriggerCondition No Trigger condition.
    Note: This field may return null, indicating that no valid values can be obtained.

    LoadMetricsConditions

    Load metric.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    LoadMetrics Array of LoadMetricsCondition No Trigger rule condition.
    Note: This field may return null, indicating that no valid values can be obtained.
    Match Integer No 0: all conditions should be met.
    1: any one of the conditions is met.

    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.

    MetricTags

    Metric tag.

    Used by actions: DescribeEmrOverviewMetrics.

    Name Type Required Description
    Unit String No Metric Unit.
    Type String No Metric type.

    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

    MonthRepeatStrategy

    Scheduled scaling of monthly recurring task policy

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    ExecuteAtTimeOfDay String Yes Specific time for repetition task execution, such as 01:02:00.
    DaysOfMonthRange Array of Integer Yes Description of time period in days of the month. The length must be 2. For example, [2,10] indicates from the 2nd day to the 10th day every month.

    Note: This field may return null, indicating that no valid values can be obtained.

    MultiDisk

    Multi-cloud disk parameters

    Used by actions: AddNodeResourceConfig, InquiryPriceScaleOutInstance.

    Name Type Required Description
    DiskType String No Cloud disk type.
  • CLOUD_SSD: Cloud SSD.
  • CLOUD_PREMIUM: Premium Cloud Disk.
  • CLOUD_HSSD: Enhanced SSD.
    		•
    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 of this type.
    Type Integer No Disk type.
    1: Local Disk.
    2: Cloud Disk.
    3: Local SSD.
    4: Cloud SSD.
    5: Premium Cloud Disk.
    6: Enhanced SSD.
    11: Throughput HDD.
    12: Tremendous SSD.
    13: Balanced SSD.
    14: Big Data Cloud Disk.
    15: High IO Cloud Disk.
    16: Remote SSD.
    Size String No Disk size.
    Volume Integer No Cloud disk size (bytes).

    MultiZoneSetting

    Parameter information of each AZ

    Used by actions: CreateInstance, InquiryPriceCreateInstance.

    Name Type Required Description
    ZoneTag String No "master", "standby" or "third-party".
    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 Node type: Master, Core, Task, Common, Router, and MySQL.
    PartDetailPrice Array of PartDetailPriceItem Price details by node part

    NodeHardwareInfo

    Node hardware information

    Used by actions: DescribeClusterNodes.

    Name Type Description
    AppId Integer User AppID.
    SerialNo String Serial number.
    OrderNo String Machine instance ID.
    WanIp String Public network IP address bound for the Master node.
    Flag Integer Node type. 0: Common node; 1: Master node.
    2: Core node; 3: Task node.
    Spec String Node specifications.
    CpuNum Integer Number of node cores.
    MemSize Integer Node memory (bytes).
    MemDesc String Node memory (GB).
    RegionId Integer The region where the node is located.
    ZoneId Integer The zone where the node is located.
    ApplyTime String Application time.
    FreeTime String Release time.
    DiskSize String Hard disk size.
    NameTag String Node description.
    Services String Node deployment service.
    StorageType Integer Disk type. Valid values: 1 (Local Disk), 2 (Cloud Disk), 3 (Local SSD), 4 (Cloud SSD), 5 (Premium Cloud Disk), 6 (Enhanced SSD), 11 (Throughput SSD), 12 (Tremendous SSD), 13 (Balanced SSD), 14 (Big Data Cloud Disk), 15 (High IO Cloud Disk), and 16 (Remote SSD).
    RootSize Integer System disk size (GB).
    ChargeType Integer Payment type. Valid values: 0 (pay-as-you-go); 1 (yearly/monthly subscription).
    CdbIp String Database IP address.
    CdbPort Integer Database port.
    HwDiskSize Integer Hard disk capacity (bytes).
    HwDiskSizeDesc String Hard disk capacity description.
    HwMemSize Integer Memory capacity (bytes).
    HwMemSizeDesc String Memory capacity description.
    ExpireTime String Expiration time.
    EmrResourceId String Node resource ID.
    IsAutoRenew Integer Renewal flag.
    DeviceClass String Device identification.
    Mutable Integer Supporting resizing.
    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 network IP address.
    Destroyable Integer Whether this node can be terminated. 1: Yes, 0: No.
    Tags Array of Tag Tags bound to node
    Note: this field may return null, indicating that no valid values can be obtained.
    AutoFlag Integer Whether it is an automatic scaling node. 0: common node, 1: automatic scaling node.
    HardwareResourceType String Resource type, with the valid values of "host" and "pod".
    IsDynamicSpec Integer Whether it is a floating specification. 1: Yes, 0: No.
    DynamicPodSpec String Floating specification value in the JSON string format.
    SupportModifyPayMode Integer Whether the billing type can be changed. 1: Yes, 0: No.
    RootStorageType Integer System disk type. Valid values: 1 (Local Disk), 2 (Cloud Disk), 3 (Local SSD), 4 (Cloud SSD), 5 (Premium Cloud Disk), 6 (Enhanced SSD), 11 (Throughput HDD), 12 (Tremendous SSD), 13 (Balanced SSD), 14 (Big Data Cloud Disk), 15 (High IO Cloud Disk), and 16 (Remote SSD).
    Zone String Availability information.
    SubnetInfo SubnetInfo Subnet
    Note: This field may return null, indicating that no valid value can be obtained.
    Clients String Client.
    CurrentTime String Current system time.
    IsFederation Integer Indicates whether it is for federation. 1: Yes, 0: No.
    DeviceName String Device name.
    ServiceClient String Service.
    DisableApiTermination Boolean Whether instance protection is enabled. True: enabled, false: disabled.
    TradeVersion Integer 0: old billing, 1: new billing.
    ServicesStatus String Component status. ZooKeeper: STARTED, ResourceManager: STARTED, STARTED: Component is running, STOPPED: Component is halted.
    Remark String Remarks.
    SharedClusterId String Shared cluster ID.
    SharedClusterIdDesc String Shared cluster ID description.
    TimingResource Boolean Whether the resource is set for scheduled termination.
    TkeClusterId String Corresponding TKE cluster ID in the case that the resource type (HardwareResourceType) is pod.
    ConfigurableServices Array of String Name list of services that can be configured when a new disk is mounted.
    NodeMark String Node labeling information: currently used only in the Terraform.
    UnderwriteSetAutoRenew Boolean Whether auto-renewal is available for committed use resources.
    GpuDesc String GPU information.

    NodeMark

    Node tag information.

    Used by actions: CreateCluster, CreateInstance, ScaleOutCluster, ScaleOutInstance.

    Name Type Required Description
    NodeType String No Node type: master, core, task, router.
    NodeNames Array of String No Node tag information: currently used only in the Terraform. It serves as an input parameter to differentiate information of nodes with the same type.
    Zone String No Availability zone name.

    NodeRenewPriceDetail

    Node renewal pricing details.

    Used by actions: InquiryPriceRenewInstance.

    Name Type Description
    ChargeType Integer Billing type (1: monthly subscription, 3: committed use).
    EmrResourceId String EMR resource ID.
    NodeType String Node type.
    Ip String Node private network IP.
    ExpireTime String Current expiration time.
    OriginalCost Float Original price.
    DiscountCost Float Discount price.
    RenewPriceDetails Array of RenewPriceDetail Node component renewal pricing list.

    NodeResource

    Specifications management, which includes specifications type descriptions.

    Used by actions: DescribeNodeResourceConfigFast.

    Name Type Description
    ResourceConfigId Integer Configuration ID.
    Resource Resource Resource
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime String Creation time.
    UpdateTime String Update time.
    IsDefault String Whether default configuration applies, DEFAULT or BACKUP.
    MaxResourceNum Integer Remaining of this type.
    PrepaidUnderwritePeriods Array of Integer Supported committed use duration.
    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 specifications type, such as S2.MEDIUM8.
    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.

    NodeSpecDisk

    Node disk type.

    Used by actions: DescribeNodeSpec.

    Name Type Required Description
    Count Integer No Quantity.
    Name String No Name.
    DiskType String No Disk type.
    DefaultDiskSize Integer No Specified disk size.

    NodeSpecDiskV2

    Node disk type.

    Used by actions: AttachDisks.

    Name Type Required Description
    Count Integer No Quantity.
    Name String No Name.
    DiskType String No Disk type.
    DefaultDiskSize Integer No Specified disk size.

    NodeSpecFamily

    Node model list.

    Used by actions: DescribeNodeSpec.

    Name Type Required Description
    InstanceFamily String Yes Model.
    FamilyName String Yes Model name.
    Order Integer No Order.
    InstanceTypes Array of NodeSpecInstanceType No InstanceType List.
    Note: This field may return null, indicating that no valid values can be obtained.

    NodeSpecInstanceType

    Node specifications type.

    Used by actions: DescribeNodeSpec.

    Name Type Required Description
    InstanceType String Yes Specifications.
    Cpu Integer Yes 4
    Memory Integer Yes 8, in GB.
    Order Integer No Order, with the smaller coming first.
    Num Integer No Quantity.
    SellOutReason String No Reasons for running out of stock.
    SystemDisk Array of NodeSpecDisk No System disk.
    Note: This field may return null, indicating that no valid values can be obtained.
    DataDisk Array of NodeSpecDisk No Data disk.
    Note: This field may return null, indicating that no valid values can be obtained.
    LocalDataDisk Array of NodeSpecDisk No Local data disk.
    Note: This field may return null, indicating that no valid values can be obtained.
    SoldOutReason String No Reasons for running out of stock.
    InstanceFamily String No Model category.
    NodeName String No Node name.
    NodeType String No Node type.
    Type String No Category.
    TypeName String No Category name.
    FamilyName String No Category classification.
    CpuType String No CPU type.
    Remark String No RunOut (denoting running out of stock), Less (denoting low inventory), and Enough (denoting sufficient).
    OriginPrice Float No Original price.
    PrepaidUnderwritePeriods Array of Integer No Supported purchase terms for committed use billing models.
    Note: This field may return null, indicating that no valid values can be obtained.
    GpuDesc String No GPU information.

    NodeSpecType

    Node model type.

    Used by actions: DescribeNodeSpec.

    Name Type Required Description
    Type String Yes Model series.
    TypeName String Yes Model series name.
    Order Integer No Order.
    InstanceFamilies Array of NodeSpecFamily No InstanceFamily array.
    Note: This field may return null, indicating that no valid values can be obtained.

    NotRepeatStrategy

    Context of the rule for executing elastic scaling once

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    ExecuteAt String Yes The specific complete time when the task was executed, in the format of "2020-07-13 00:00:00".

    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.

    Order

    Description order, which is used for sorting.

    Used by actions: DescribeGroupsSTD.

    Name Type Required Description
    Name String No Order field.
    Direction String No Desc or Asc.

    OverviewMetricData

    Overview data.

    Used by actions: DescribeEmrOverviewMetrics.

    Name Type Required Description
    Metric String No Metric name.
    First Integer No First data timestamp.
    Last Integer No Last data timestamp.
    Interval Integer No Sampling point time interval.
    DataPoints Array of String No Sampling point data.
    Note: This field may return null, indicating that no valid values can be obtained.
    Tags MetricTags No Metric tags.
    Note: This field may return null, indicating that no valid values can be obtained.

    OverviewRow

    Return of HBase TableMetric overview

    Used by actions: DescribeHBaseTableOverview.

    Name Type Description
    Table String Table name
    ReadRequestCount Float Number of read requests
    WriteRequestCount Float Number of write requests
    MemstoreSize Float Current memstore size
    StoreFileSize Float Size of StoreFile in the current region
    Operation String Regions. Click to jump.
    StoreFileNum Float StoreFile quantity.

    PartDetailPriceItem

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

    Used by actions: InquiryPriceCreateInstance.

    Name Type Description
    InstanceType String Types, including node: node (denoting node), rootDisk (denoting system disk), dataDisk (denoting cloud data disk), and metaDB.
    Price Float Unit price (original price).
    RealCost Float Unit price (discounted price).
    RealTotalCost Float Total price (discounted price).
    Policy Float Discount.
    GoodsNum Integer Quantity.

    Period

    Serverless HBase monthly subscription duration

    Used by actions: CreateSLInstance.

    Name Type Required Description
    TimeSpan Integer Yes Time span.
    TimeUnit String No Time unit, "m" stands for month.

    PersistentVolumeContext

    Description of Pod PVC storage method

    Used by actions: ScaleOutInstance.

    Name Type Required Description
    DiskSize Integer No Disk size in GB.
    DiskType String No Disk type, CLOUD_PREMIUM or CLOUD_SSD.
    DiskNum Integer No Number of disks.
    ExtraPerformance Integer No Additional performance of cloud disks.

    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 Unique ID of VPC network.
    SubnetId String No Unique ID of a VPC subnet.
    PodName String No pod name

    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 ID of VPC network.
    SubnetId String No Unique ID of a VPC subnet.
    PodName String No pod name

    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, which can be "pvc" or "hostpath".
    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

    PrePaySetting

    Serverless HBase prepaid settings

    Used by actions: CreateSLInstance.

    Name Type Required Description
    Period Period Yes Time.
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoRenewFlag Integer Yes Auto-renewal flag. 0: notify before expiration but do not auto-renew; 1: notify before expiration and auto-renew; and 2: do not notify before expiration and do not auto-renew.

    PriceDetail

    Pricing details

    Used by actions: InquiryPriceRenewInstance, 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 Required specifications.
    StorageType Integer Hard disk type.
    DiskType String Hard disk type.
    RootSize Integer System disk size.
    MemSize Integer Memory size.
    Cpu Integer Number of cores.
    DiskSize Integer Hard disk size.
    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.
    InstanceType String Specifications.
    Tags Array of Tag Tag
    Note: This field may return null, indicating that no valid values can be obtained.
    DiskNum Integer Number of disks.
    LocalDiskNum Integer Number of local disks.
    GpuDesc String GPU information.

    PriceResult

    Inquiry results

    Used by actions: InquiryPriceUpdateInstance.

    Name Type Required Description
    OriginalCost Float No Original price.
    DiscountCost Float No Discount price.

    RenewPriceDetail

    Node component renewal pricing details.

    Used by actions: InquiryPriceRenewInstance.

    Name Type Description
    BillingName String Billing item name.
    Policy Float Discount.
    Quantity Integer Quantity.
    OriginalCost Float Original price.
    DiscountCost Float Discount price.

    RepeatStrategy

    Scheduled scaling task policy

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    RepeatType String Yes The valid values DAY, DOW, DOM, and NONE respectively indicate repetition by day, repetition by week, repetition by month, and one-time execution. This parameter is required.
    DayRepeat DayRepeatStrategy No Daily repetition rule, which is effective when RepeatType is set to DAY

    Note: This field may return null, indicating that no valid values can be obtained.
    WeekRepeat WeekRepeatStrategy No Weekly repetition rule, effective when RepeatType is DOW

    Note: This field may return null, indicating that no valid values can be obtained.
    MonthRepeat MonthRepeatStrategy No Monthly repetition rule, valid when RepeatType is DOM

    Note: This field may return null, indicating that no valid values can be obtained.
    NotRepeat NotRepeatStrategy No One-time execution rule, valid when RepeatType is NONE

    Note: This field may return null, indicating that no valid values can be obtained.
    Expire String No Rule expiration time. After this time is due, the rule will be automatically set to the status "suspended". The format is "2020-07-23 00:00:00". It is required.
    StartTime String No Periodic rule start time.

    Resource

    Resource details

    Used by actions: AddNodeResourceConfig, CreateInstance, DescribeNodeResourceConfigFast, InquiryPriceCreateInstance.

    Name Type Required Description
    Spec String Yes Node specifications description, such as CVM.SA2.
    StorageType Integer Yes Storage type.
    Valid values:
  • 4: Cloud SSD.
  • 5: Premium Cloud Disk.
  • 6: Enhanced SSD.
  • 11: Throughput HDD.
  • 12: Tremendous SSD.
    • : this type is invalid upon creation, and automatic judgment will be conducted based on data disk type and node type.
    DiskType String Yes Disk type.
    Valid values.
  • CLOUD_SSD: Cloud SSD.
  • CLOUD_PREMIUM: Premium Cloud Disk.
  • CLOUD_BASIC: Cloud Disk.
    		•
    MemSize Integer Yes Memory capacity, in MB.
    Cpu Integer Yes Number of CPU cores.
    DiskSize Integer Yes Data disk capacity.
    RootSize Integer No System disk capacity.
    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 Specifications type, such as S2.MEDIUM8.
    LocalDiskNum Integer No Number of local disks. This field is deprecated.
    DiskNum Integer No Number of local disks, such as 2.
    GpuDesc String No GPU information.

    ResourceDetail

    Resource details.

    Used by actions: DescribeInstances.

    Name Type Description
    Spec String Specifications.
    SpecName String Specifications name.
    StorageType Integer Hard disk type.
    DiskType String Hard disk type.
    RootSize Integer System disk size.
    MemSize Integer Memory size.
    Cpu Integer Number of CPUs.
    DiskSize Integer Hard disk size.
    InstanceType String Specifications.

    RestartPolicy

    Component restart policy

    Used by actions: DescribeServiceNodeInfos.

    Name Type Description
    Name String Restart policy name
    DisplayName String Policy display name
    Describe String Policy description
    BatchSizeRange Array of Integer Optional range for the number of batch restarted nodes
    IsDefault String Whether it is the default policy

    ResultItem

    Output results of user groups.

    Used by actions: CreateGroupsSTD, DeleteGroupsSTD.

    Name Type Required Description
    Item String No User group name.
    Result Boolean No Whether the user group is created successfully.
    Reason String No Specify the reason for the failure in the case of creation failure.

    SLInstance

    Serverless Instance

    Used by actions: DescribeSLInstance.

    Name Type Description
    InstanceId String EMR Instance Id
    ClusterId Integer EMR Numeric Instance Id
    InstanceName String Instance Name
    RegionId Integer Region id
    Zone String Zone Name
    PayMode Integer Pay Mode
    DiskType String Disk Type
    DiskSize Integer Disk Size
    NodeType String Node Type
    NodeNum Integer Node Number
    ExpireTime String Expire Time
    IsolateTime String Isolate Time
    CreateTime String Create Time
    AutoRenewFlag Integer Auto Renew Flag
    Status Integer EMR Numeric Instance Status
    ZoneSettings Array of ZoneSetting Zone Setting
    Tags Array of Tag Bound Tags
    DeployRole String Deploy Role

    SLInstanceInfo

    Serverless HBase instance information

    Used by actions: DescribeSLInstanceList.

    Name Type Description
    ClusterId String Instance string ID.
    Id Integer Instance numeric ID
    StatusDesc String Status description.
    HealthStatus String Health status.
    ClusterName String Instance name
    RegionId Integer Region ID
    ZoneId Integer Primary AZ ID.
    Zone String Primary AZ.
    AppId Integer User APP ID.
    VpcId Integer Primary AZ VPC ID.
    SubnetId Integer Primary AZ subnet ID.
    Status Integer Status code
    AddTime String Creation time.
    PayMode Integer Cluster billing type. 0 indicates pay-as-you-go. 1 indicates monthly subscription.
    ZoneSettings Array of ZoneSetting Multi-AZ information.
    Note: This field may return null, indicating that no valid values can be obtained.
    Tags Array of Tag Instance tag.
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoRenewFlag Integer Auto-renewal flag. 0: notify before expiration but do not auto-renew; 1: notify before expiration and auto-renew; and 2: do not notify before expiration and do not auto-renew. If the business does not support renewal, the value is set to 0.
    IsolateTime String Isolation time. For instances that are not isolated, the API returns 0000-00-00 00:00:00.
    ExpireTime String Expiration time. For post-paid instances, the API returns 0000-00-00 00:00:00.

    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

    Configuration group specified for scale-out.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    ServiceComponentName String No Component version name, for example, HDFS-2.8.5.
    ConfGroupName String No Configuration group name, for example, hdfs-core-defaultGroup. If the ConfGroupName parameter is passed in, the configuration group dimension is used.
    If the ConfGroupName parameter is not passed in, the cluster dimension is used.

    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

    SchedulerTaskDetail

    Scheduling task details

    Used by actions: DescribeYarnScheduleHistory.

    Name Type Description
    Step String Steps.
    Progress String Progress.
    FailReason String Failure information.
    JobId Integer ID used to obtain details.

    SchedulerTaskInfo

    Yarn resource scheduling history

    Used by actions: DescribeYarnScheduleHistory.

    Name Type Description
    SchedulerName String Scheduler type
    OperatorName String Operation type
    CreateTime String Start time.
    EndTime String End time.
    State Integer Status.
    Details Array of SchedulerTaskDetail Details.
    Note: This field may return null, indicating that no valid values can be obtained.

    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.
    Remark String No Remarks.

    SearchItem

    Search field

    Used by actions: DescribeClusterNodes, DescribeServiceNodeInfos.

    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.

    ServiceNodeDetailInfo

    Service process information.

    Used by actions: DescribeServiceNodeInfos.

    Name Type Description
    Ip String Process node IP
    NodeType Integer Process type.
    NodeName String Process name
    ServiceStatus Integer Service component status
    MonitorStatus Integer Process monitoring status
    Status Integer Service component status
    PortsInfo String Process port information
    LastRestartTime String Last restart time.
    Flag Integer Node type.
    ConfGroupId Integer Configuration group ID.
    ConfGroupName String Configuration group name.
    ConfStatus Integer Whether the node needs to be restarted
    ServiceDetectionInfo Array of ServiceProcessFunctionInfo Process detection information

    Note: This field may return null, indicating that no valid values can be obtained.
    NodeFlagFilter String Node type.
    HealthStatus HealthStatus Process health status

    Note: This field may return null, indicating that no valid values can be obtained.
    IsSupportRoleMonitor Boolean Whether the role supports monitoring.
    StopPolicies Array of RestartPolicy Suspension policy

    Note: This field may return null, indicating that no valid values can be obtained.
    HAState String Strong validation of the API in a test environment. This strong validation doesn't exist on the current network, but it does exist in the data returned by the emrcc interface. If it’s not applied, an error will be reported. Omitting it will result in an error.
    NameService String NameService name.
    IsFederation Boolean Whether the federation is supported.
    DataNodeMaintenanceState Integer Whether the DataNode is in maintenance status.

    ServiceProcessFunctionInfo

    Process detection information

    Used by actions: DescribeServiceNodeInfos.

    Name Type Description
    DetectAlert String Detection alarm level.
    DetectFunctionKey String Detection feature description.
    DetectFunctionValue String Detection feature result.
    DetectTime String Detection result.

    ShortNodeInfo

    Node information

    Used by actions: DescribeInstances.

    Name Type Required Description
    NodeType String No Node type: Master/Core/Task/Router/Common.
    NodeSize Integer No Number of nodes.

    SoftDependInfo

    Client component dependencies

    Used by actions: DescribeInstancesList.

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

    SparkApplicationsList

    Spark task list.

    Used by actions: DescribeSparkApplications.

    Name Type Description
    ID String Application ID.
    Name String Application name.
    User String User.
    StartTime Integer Start time.
    EndTime Integer End time.
    Duration Integer Duration.
    State String Status.
    ApplicationType String Type.
    CoreSeconds Integer Number of cores multiplied by seconds.
    MemorySeconds String Memory MB multiplied by seconds.
    Insight String Insight result.

    SparkQuery

    Spark query details.

    Used by actions: DescribeSparkQueries.

    Name Type Description
    Statement String Execution statement.
    Duration Integer Execution duration (ms).
    Status String Execution status.
    Id String Query ID.
    ScanPartitionNum Integer Number of scanned partitions.
    ScanRowNum Integer Total number of scanned rows.
    ScanFileNum Integer Total number of scanned files.
    ScanTotalData Integer Total data volume scanned by query (bytes).
    ApplicationId Array of String Application ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    OutputRowNum Integer Total number of output rows.
    OutputFileNum Integer Total number of output files.
    OutputPartitionNum Integer Number of output partitions.
    OutputTotalData Integer Total output data volume (bytes).
    BeginTime Integer Start time.
    EndTime Integer End time.

    StageInfoDetail

    Task step details

    Used by actions: DescribeClusterFlowStatusDetail.

    Name Type Description
    Stage String Steps.
    Name String Step name.
    IsShow Boolean Indicates whether to display
    IsSubFlow Boolean Whether it is a subprocess
    SubFlowFlag String Subprocess tag.
    Status Integer Step execution status. 0: not started, 1: in progress, 2: completed, 3: partially completed, -1: failed
    Desc String Step running status description.
    Progress Float Running progress.
    Starttime Timestamp Start time

    Note: This field may return null, indicating that no valid values can be obtained.
    Endtime Timestamp End time

    Note: This field may return null, indicating that no valid values can be obtained.
    HadWoodDetail Boolean Whether details are included.
    WoodJobId Integer Wood subprocess ID.
    LanguageKey String Multi-language version key.
    FailedReason String Reason for stage failure.
    TimeConsuming String Step duration.
    Id Integer

    StarRocksQueryInfo

    StarRocks query information.

    Used by actions: DescribeStarRocksQueryInfo.

    Name Type Description
    ClientIP String Submission IP address.
    CPUCost Integer Total CPU time (ns).
    DefaultDB String Default DB.
    EndTime Integer End time.
    ExecutionIP String Execution IP address.
    QueryID String Query ID.
    QueryType String Query type.
    MemCost Integer Total memory consumed (bytes).
    PlanCpuCosts Integer CPU usage (ns) at the plan stage.
    PlanMemCosts Integer Memory usage (bytes) at the plan stage.
    QueryTime Integer Execution duration.
    ResourceGroup String Resource group.
    ReturnRows Integer Number of rows obtained.
    ScanBytes Integer Scanned data volume (bytes).
    ScanRows Integer Number of scanned rows.
    BeginTime Integer Start time.
    ExecutionState String Execution status.
    ExecutionStatement String Execution statement.
    User String User.

    StopParams

    Parameters used for stopping services.

    Used by actions: StartStopServiceOrMonitor.

    Name Type Required Description
    StopPolicy String No Security mode: safe.
    Default mode: default.
    ThreadCount Integer No Thread Count

    StorageSummaryDistribution

    HDFS Cloud File Storage (CFS) details.

    Used by actions: DescribeHDFSStorageInfo.

    Name Type Required Description
    MetricItem String No Data item.
    MetricName String No Data item description.
    Dps Array of Dps No Sampling value.
    Note: This field may return null, indicating that no valid values can be obtained.

    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 start.
    BatchSize Integer No Rolling restart quantity per batch, which is up to 99999.
    TimeWait Integer No Stop and wait time for rolling restart per batch, with the maximum interval of 5 minutes and the unit of seconds.
    DealOnFail Integer No Operation failure processing policy. 0: Block upon failure, 1: Automatically skipping failure.
    Args Array of Arg No Parameters required in the instruction.
    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).
    SubnetId String No Subnet information (ID).

    TableSchemaItem

    Table schema information

    Used by actions: DescribeHBaseTableOverview.

    Name Type Description
    Name String Column identifier
    Sortable Boolean Whether it is sortable by this column
    WithFilter Boolean Whether it is filterable
    Candidates Array of String Filtered candidate set

    Note: This field may return null, indicating that no valid values can be obtained.
    Clickable Boolean Whether it is clickable.
    Title String Display name.

    Tag

    Tag

    Used by actions: AddMetricScaleStrategy, AddNodeResourceConfig, CreateCluster, CreateInstance, CreateSLInstance, DescribeAutoScaleStrategies, DescribeClusterNodes, DescribeInstances, DescribeInstancesList, DescribeSLInstance, DescribeSLInstanceList, InquiryPriceScaleOutInstance, ModifyAutoScaleStrategy, ModifyResourcesTags, ScaleOutCluster, ScaleOutInstance.

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

    Taint

    Kubernetes Taint

    Used by actions: ScaleOutInstance.

    Name Type Required Description
    Key String No Taint Key
    Value String No Taint Value
    Effect String No Taint Effect

    TaskSettings

    Inspection task parameter.

    Used by actions: ModifyInspectionSettings.

    Name Type Required Description
    Name String No Parameter name.
    Value String No Parameter value.
    Key String No Unique parameter identifier.
    Editable String No Whether it is editable, "true" or "false".

    TimeAutoScaleStrategy

    Rule for time-based scaling

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    StrategyName String Yes Policy name, which is unique within one cluster.
    IntervalTime Integer Yes Cooling time after policy trigger, during which auto scaling cannot be triggered.
    ScaleAction Integer Yes Scaling action. 1: scale-out, 2: scale-in.
    ScaleNum Integer Yes Scaling amount.
    StrategyStatus Integer Yes Rule status. 1: valid; 2: invalid; 3: suspended. This field is required.
    Priority Integer Yes Rule priority. The smaller value indicates the higher priority.
    RetryValidTime Integer Yes When multiple rules are triggered at the same time and some are not really executed, retries will be performed within this time range.
    RepeatStrategy RepeatStrategy Yes Time scaling repetition policy

    Note: This field may return null, indicating that no valid values can be obtained.
    StrategyId Integer No Unique policy ID.
    GraceDownFlag Boolean No Graceful scale-in switch.
    GraceDownTime Integer No Graceful scale-in wait time.
    Tags Array of Tag No Bound tag list

    Note: This field may return null, indicating that no valid values can be obtained.
    ConfigGroupAssigned String No Preset configuration group.
    MeasureMethod String No Calculation method of scale-out resources. Valid values: "DEFAULT","INSTANCE", "CPU" and "MEMORYGB".
    "DEFAULT" indicates the default method, which is the same as "INSTANCE".
    "INSTANCE" indicates calculation based on nodes (default mode).
    "CPU" indicates calculation based on the quantity of cores of the machine.
    "MEMORYGB" indicates calculation based on the memory size of the machine.
    TerminatePolicy String No Termination policy. "DEFAULT" denotes the default policy, which indicates that scale-in is triggered by scale-in rules. "TIMING" denotes timed destruction.
    MaxUse Integer No Maximum use time in seconds. The minimum value is 1 hour, and the maximum is 24 hours.
    SoftDeployInfo Array of Integer No Node deployment service list. Fill in only HDFS and YARN. For details, see Mapping Table for Component Names.
    Note: This field may return null, indicating that no valid values can be obtained.
    ServiceNodeInfo Array of Integer No Startup process list

    Note: This field may return null, indicating that no valid values can be obtained.
    CompensateFlag Integer No Compensatory scale-out. 0: disable, 1: enable.
    GroupId Integer No Scaling group ID.
    GraceDownLabel Array of TkeLabel No Graceful scale-in business pod tag. Nodes are scaled in when the pod mentioned above is not found on the node or the graceful scale-in time is passed.

    TkeLabel

    Kubernetes Label

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy, ScaleOutInstance.

    Name Type Required Description
    Name String No Label Name
    Value String No Label Value

    TopologyInfo

    Cluster node topology information

    Used by actions: DescribeInstances.

    Name Type Required Description
    ZoneId Integer No Availability zone ID.
    Zone String No Availability information.
    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.

    TriggerCondition

    Rule trigger condition.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    CompareMethod Integer Yes Conditional comparison method. 1: greater than, 2: less than, 3: greater than or equal to, 4: less than or equal to
    Threshold Float No Conditional threshold.

    TrinoQueryInfo

    Trino query information.

    Used by actions: DescribeTrinoQueryInfo.

    Name Type Description
    Catalog String catalog
    ClientIpAddr String IP address used for submission.
    CompletedSplits String Number of segments.
    CpuTime Integer CPU time.
    CumulativeMemory Integer Cumulative memory.
    DurationMillis Integer Execution duration.
    EndTime Integer End time (seconds).
    Id String Query ID.
    InternalNetworkBytes Integer Internal transmission volume.
    OutputBytes Integer Number of output bytes.
    PeakUserMemoryBytes Integer Peak memory.
    PhysicalInputBytes Integer Physical input volume.
    ProcessedInputBytes Integer Processed input volume.
    SqlCompileTime Integer Compilation duration.
    StartTime Integer Start time (seconds).
    State String Execution status.
    Statement String Execution statement.
    User String User who submits requests.
    WrittenBytes Integer Number of bytes written.

    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
    Groups Array of String No User subgroup.

    UserManagerFilter

    User management list filter

    Used by actions: DescribeUsersForUserManager.

    Name Type Required Description
    UserName String No Username.
    UserType String No User source.
    Groups String No Group name.

    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 User creation time.
    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 address of the keytab file.

    VPCSettings

    VPC parameters

    Used by actions: CreateInstance, CreateSLInstance, DescribeSLInstance, 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.

    WeekRepeatStrategy

    Scheduled scaling-out of weekly recurring tasks policy

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    ExecuteAtTimeOfDay String Yes Specific time for repetition task execution, such as 01:02:00.
    DaysOfWeek Array of Integer Yes Ordinal number description of the day of a week, for example, [1,3,4] indicates Monday, Wednesday, and Thursday.

    Note: This field may return null, indicating that no valid values can be obtained.

    ZoneDetailPriceResult

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

    Used by actions: InquiryPriceCreateInstance.

    Name Type Description
    ZoneId String Availability zone ID.
    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 Leave ZoneTag empty in the case of a single availability zone. In the case of a dual-AZ deployment, select master for the first availability zone's ZoneTag and standby for the second. In the case of a three-AZ deployment, select master for the first availability zone's ZoneTag, standby for the second, and third-party for the third. Valid values.
  • master

  • standby

  • third-party
    		•

    ZoneSetting

    AZ configuration description.

    Used by actions: CreateSLInstance, DescribeSLInstance, DescribeSLInstanceList.

    Name Type Required Description
    Zone String Yes Availability zone name
    VPCSettings VPCSettings Yes AZ VPC and subnet.
    NodeNum Integer Yes Number of AZ nodes.
    本页内容是否解决了您的问题？
    您也可以 联系销售 或 提交工单 以寻求帮助。
    是
    否

    文档反馈