{ "name": "emr", "display_name": "弹性 MapReduce", "description": "介绍如何使用API对弹性MapReduce进行操作，包括信息查询、集群生命周期等。", "domain": "database", "api_version": "2019-01-03", "endpoint": "emr.tencentcloudapi.com", "actions": [ { "name": "AddMetricScaleStrategy", "description": "添加扩缩容规则，按负载和时间", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "emr-dttol202" }, { "name": "StrategyType", "type": "integer", "required": true, "description": "1表示按负载规则扩缩容，2表示按时间规则扩缩容。必须填写，并且和下面的规则策略匹配", "example": "1" }, { "name": "LoadAutoScaleStrategy", "type": "object", "required": false, "description": "按负载扩容的规则。", "example": "无", "children": [ { "name": "StrategyId", "type": "integer", "required": false, "description": "规则ID。", "example": "1" }, { "name": "StrategyName", "type": "string", "required": false, "description": "规则名称。", "example": "name_test" }, { "name": "CalmDownTime", "type": "integer", "required": false, "description": "规则生效冷却时间。", "example": "300" }, { "name": "ScaleAction", "type": "integer", "required": false, "description": "扩缩容动作，1表示扩容，2表示缩容。", "example": "1" }, { "name": "ScaleNum", "type": "integer", "required": false, "description": "每次规则生效时的扩缩容数量。", "example": "2" }, { "name": "ProcessMethod", "type": "integer", "required": false, "description": "指标处理方法，1表示MAX，2表示MIN，3表示AVG。", "example": "1" }, { "name": "Priority", "type": "integer", "required": false, "description": "规则优先级，添加时无效，默认为自增。", "example": "1" }, { "name": "StrategyStatus", "type": "integer", "required": false, "description": "规则状态，1表示启动，3表示禁用。", "example": "1" }, { "name": "YarnNodeLabel", "type": "string", "required": false, "description": "规则扩容指定 yarn node label", "example": "label_test" }, { "name": "PeriodValid", "type": "string", "required": false, "description": "规则生效的有效时间", "example": "{\"Category\":1,\"StartDay\":\"2024-12-24\",\"EndDay\":\"2024-12-24\",\"StartTime\":\"00:00:00\",\"EndTime\":\"23:59:59\"}" }, { "name": "GraceDownFlag", "type": "boolean", "required": false, "description": "优雅缩容开关", "example": "false" }, { "name": "GraceDownTime", "type": "integer", "required": false, "description": "优雅缩容等待时间", "example": "1800" }, { "name": "GraceDownProtectFlag", "type": "boolean", "required": false, "description": "是否开启任务保护", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "绑定标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "ConfigGroupAssigned", "type": "string", "required": false, "description": "预设配置组", "example": "\"{\\\"HDFS-3.2.2\\\":-1,\\\"YARN-3.2.2\\\":-1}" }, { "name": "MeasureMethod", "type": "string", "required": false, "description": "扩容资源计算方法，\"DEFAULT\",\"INSTANCE\", \"CPU\", \"MEMORYGB\"。 \"DEFAULT\"表示默认方式，与\"INSTANCE\"意义相同。 \"INSTANCE\"表示按照节点计算，默认方式。 \"CPU\"表示按照机器的核数计算。 \"MEMORYGB\"表示按照机器内存数计算。", "example": "DEFAULT" }, { "name": "SoftDeployDesc", "type": "array", "required": false, "description": "节点部署服务列表，例如[\"HDFS-3.1.2\",\"YARN-3.1.2\"]。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"HDFS-3.1.2\",\"YARN-3.1.2\"]", "item_type": "string" }, { "name": "ServiceNodeDesc", "type": "string", "required": false, "description": "启动进程列表，例如[\"NodeManager\"]。", "example": "[\"NodeManager\"]" }, { "name": "ServiceNodeInfo", "type": "array", "required": false, "description": "启动进程列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[98]", "item_type": "integer" }, { "name": "SoftDeployInfo", "type": "array", "required": false, "description": "节点部署服务列表。部署服务仅填写HDFS、YARN。[组件名对应的映射关系表](https://cloud.tencent.com/document/product/589/98760) 注意：此字段可能返回 null，表示取不到有效值。", "example": "[98]", "item_type": "integer" }, { "name": "LoadMetricsConditions", "type": "object", "required": false, "description": "多指标触发条件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "LoadMetrics", "type": "array", "required": false, "description": "触发规则条件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "StatisticPeriod", "type": "integer", "required": false, "description": "规则统计周期，提供1min,3min,5min。", "example": "300" }, { "name": "TriggerThreshold", "type": "integer", "required": false, "description": "触发次数，当连续触发超过TriggerThreshold次后才开始扩缩容。", "example": "1" }, { "name": "LoadMetrics", "type": "string", "required": false, "description": "扩缩容负载指标。", "example": "AvailableVCores#root" }, { "name": "MetricId", "type": "integer", "required": false, "description": "规则元数据记录ID。", "example": "1" }, { "name": "Conditions", "type": "array", "required": false, "description": "触发条件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Match", "type": "integer", "required": false, "description": "0:所有条件满足 1：满足任意一个", "example": "0" } ] }, { "name": "GroupId", "type": "integer", "required": false, "description": "伸缩组Id", "example": "2" }, { "name": "Soft", "type": "string", "required": false, "description": "soft例如yarn", "example": "yarn" }, { "name": "GraceDownProtectTime", "type": "integer", "required": false, "description": "任务保护时间", "example": "60" } ] }, { "name": "TimeAutoScaleStrategy", "type": "object", "required": false, "description": "按时间扩缩容的规则。", "example": "无", "children": [ { "name": "StrategyName", "type": "string", "required": true, "description": "策略名字，集群内唯一。", "example": "dafsd" }, { "name": "IntervalTime", "type": "integer", "required": true, "description": "策略触发后的冷却时间，该段时间内，将不能触发弹性扩缩容。", "example": "300" }, { "name": "ScaleAction", "type": "integer", "required": true, "description": "扩缩容动作，1表示扩容，2表示缩容。", "example": "1" }, { "name": "ScaleNum", "type": "integer", "required": true, "description": "扩缩容数量。", "example": "20" }, { "name": "StrategyStatus", "type": "integer", "required": true, "description": "规则状态，1表示有效，2表示无效，3表示暂停。必须填写", "example": "1" }, { "name": "Priority", "type": "integer", "required": true, "description": "规则优先级，越小越高。", "example": "2" }, { "name": "RetryValidTime", "type": "integer", "required": true, "description": "当多条规则同时触发，其中某些未真正执行时，在该时间范围内，将会重试。", "example": "600" }, { "name": "RepeatStrategy", "type": "object", "required": true, "description": "时间扩缩容重复策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "RepeatType", "type": "string", "required": true, "description": "取值范围\"DAY\",\"DOW\",\"DOM\",\"NONE\"，分别表示按天重复、按周重复、按月重复和一次执行。必须填写", "example": "NONE" }, { "name": "DayRepeat", "type": "object", "required": false, "description": "按天重复规则，当RepeatType为\"DAY\"时有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExecuteAtTimeOfDay", "type": "string", "required": true, "description": "重复任务执行的具体时刻，例如\"01:02:00\"", "example": "10:01:00" }, { "name": "Step", "type": "integer", "required": true, "description": "每隔Step天执行一次", "example": "1" } ] }, { "name": "WeekRepeat", "type": "object", "required": false, "description": "按周重复规则，当RepeatType为\"DOW\"时有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExecuteAtTimeOfDay", "type": "string", "required": true, "description": "重复任务执行的具体时刻，例如\"01:02:00\"", "example": "11:05:00" }, { "name": "DaysOfWeek", "type": "array", "required": true, "description": "每周几的数字描述，例如，[1,3,4]表示每周周一、周三、周四。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1", "item_type": "integer" } ] }, { "name": "MonthRepeat", "type": "object", "required": false, "description": "按月重复规则，当RepeatType为\"DOM\"时有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExecuteAtTimeOfDay", "type": "string", "required": true, "description": "重复任务执行的具体时刻，例如\"01:02:00\"", "example": "15:04:05" }, { "name": "DaysOfMonthRange", "type": "array", "required": true, "description": "每月中的天数时间段描述，长度只能为2，例如[2,10]表示每月2-10号。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[1,2]", "item_type": "integer" } ] }, { "name": "NotRepeat", "type": "object", "required": false, "description": "一次执行规则，当RepeatType为\"NONE\"时有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExecuteAt", "type": "string", "required": true, "description": "该次任务执行的具体完整时间，格式为\"2020-07-13 00:00:00\"", "example": "2024-12-05 08:38:00" } ] }, { "name": "Expire", "type": "string", "required": false, "description": "规则过期时间，超过该时间后，规则将自动置为暂停状态，形式为\"2020-07-23 00:00:00\"。必须填写", "example": "2026-01-09 23:59:59" }, { "name": "StartTime", "type": "string", "required": false, "description": "周期性规则开始时间", "example": "2024-01-09 23:59:59" } ] }, { "name": "StrategyId", "type": "integer", "required": false, "description": "策略唯一ID。", "example": "1" }, { "name": "GraceDownFlag", "type": "boolean", "required": false, "description": "优雅缩容开关", "example": "false" }, { "name": "GraceDownTime", "type": "integer", "required": false, "description": "优雅缩容等待时间", "example": "600" }, { "name": "GraceDownProtectFlag", "type": "boolean", "required": false, "description": "是否开启任务保护", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "绑定标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "ConfigGroupAssigned", "type": "string", "required": false, "description": "预设配置组", "example": "{\\\"HDFS-3.2.2\\\":-1,\\\"TRINO-389\\\":-1,\\\"YARN-3.2.2\\\":-1}" }, { "name": "MeasureMethod", "type": "string", "required": false, "description": "扩容资源计算方法，\"DEFAULT\",\"INSTANCE\", \"CPU\", \"MEMORYGB\"。 \"DEFAULT\"表示默认方式，与\"INSTANCE\"意义相同。 \"INSTANCE\"表示按照节点计算，默认方式。 \"CPU\"表示按照机器的核数计算。 \"MEMORYGB\"表示按照机器内存数计算。", "example": "DEFAULT" }, { "name": "TerminatePolicy", "type": "string", "required": false, "description": "销毁策略, \"DEFAULT\",默认销毁策略，由缩容规则触发缩容，\"TIMING\"表示定时销毁", "example": "DEFAULT" }, { "name": "MaxUse", "type": "integer", "required": false, "description": "最长使用时间， 秒数，最短1小时，最长24小时", "example": "3600" }, { "name": "SoftDeployInfo", "type": "array", "required": false, "description": "节点部署服务列表。部署服务仅填写HDFS、YARN。[组件名对应的映射关系表](https://cloud.tencent.com/document/product/589/98760) 注意：此字段可能返回 null，表示取不到有效值。", "example": "[1,2,42]", "item_type": "integer" }, { "name": "ServiceNodeInfo", "type": "array", "required": false, "description": "启动进程列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[7,89]", "item_type": "integer" }, { "name": "CompensateFlag", "type": "integer", "required": false, "description": "补偿扩容，0表示不开启，1表示开启", "example": "0" }, { "name": "GroupId", "type": "integer", "required": false, "description": "伸缩组id", "example": "0" }, { "name": "GraceDownLabel", "type": "array", "required": false, "description": "优雅缩容业务pod标签，当node不存在上述pod或超过优雅缩容时间时，缩容节点", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "Label Name", "example": "cloud.tencent.com/node-instance-id" }, { "name": "Value", "type": "string", "required": false, "description": "Label Value", "example": "ins-0dcxficf" } ] }, { "name": "GraceDownProtectTime", "type": "integer", "required": false, "description": "任务保护时间", "example": "60" } ] } ], "required": [ "InstanceId", "StrategyType" ] }, { "name": "AddNodeResourceConfig", "description": "增加当前集群的节点规格配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例Id", "example": "emr-examples" }, { "name": "ResourceType", "type": "string", "required": true, "description": "节点类型 CORE TASK ROUTER", "example": "CORE" }, { "name": "ResourceConfig", "type": "object", "required": true, "description": "资源详情", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "云盘类型 CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "CLOUD_SSD" }, { "name": "Volume", "type": "integer", "required": false, "description": "云盘大小", "example": "20000" }, { "name": "Count", "type": "integer", "required": false, "description": "该类型云盘个数", "example": "1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "PayMode", "type": "integer", "required": true, "description": "付费模式", "example": "1" }, { "name": "IsDefault", "type": "string", "required": false, "description": "是否默认配置,DEFAULT,BACKUP,不填默认不是默认配置", "example": "DEFAULT" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "地域ID", "example": "100002" }, { "name": "MultipleResourceConfig", "type": "array", "required": false, "description": "添加多个规格时，第1个规格详情在ResourceConfig参数，第2-n个在MultipleResourceConfig参数", "example": "无", "item_type": "object", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "云盘类型 CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "CLOUD_SSD" }, { "name": "Volume", "type": "integer", "required": false, "description": "云盘大小", "example": "20000" }, { "name": "Count", "type": "integer", "required": false, "description": "该类型云盘个数", "example": "1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "ResourceBaseType", "type": "string", "required": false, "description": "类型为ComputeResource和EMR以及默认，默认为EMR", "example": "ComputeResource" }, { "name": "ComputeResourceId", "type": "string", "required": false, "description": "计算资源id", "example": "emr-cr-xxxxx" }, { "name": "HardwareResourceType", "type": "string", "required": false, "description": "硬件类型", "example": "HOST" } ], "required": [ "InstanceId", "ResourceType", "ResourceConfig", "PayMode" ] }, { "name": "AddUsersForUserManager", "description": "该接口支持安装了OpenLdap组件的集群。 新增用户列表（用户管理）。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群字符串ID", "example": "emr-o88f3whr" }, { "name": "UserManagerUserList", "type": "array", "required": true, "description": "用户信息列表", "example": "无", "item_type": "object", "children": [ { "name": "UserName", "type": "string", "required": true, "description": "用户名", "example": "user1" }, { "name": "UserGroup", "type": "string", "required": true, "description": "用户所属的组", "example": "group1" }, { "name": "PassWord", "type": "string", "required": true, "description": "密码", "example": "PassWord_123" }, { "name": "ReMark", "type": "string", "required": false, "description": "备注", "example": "提交mr任务" }, { "name": "Groups", "type": "array", "required": false, "description": "用户副组", "example": "groups", "item_type": "string" } ] } ], "required": [ "InstanceId", "UserManagerUserList" ] }, { "name": "AttachDisks", "description": "云盘挂载", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "EMR集群实例ID", "example": "emr-xxxxxxx" }, { "name": "DiskIds", "type": "array", "required": false, "description": "需要挂载的云盘ID", "example": "[disk-xxx1, disk-xxx2]", "item_type": "string" }, { "name": "AlignType", "type": "string", "required": false, "description": "挂载模式，取值范围： AUTO_RENEW：自动续费 ALIGN_DEADLINE：自动对其到期时间", "example": "AUTO_RENEW" }, { "name": "CvmInstanceIds", "type": "array", "required": false, "description": "需要挂载的cvm节点id列表", "example": "[ins-dfsi3u4s, ins-eidsii3u]", "item_type": "string" }, { "name": "CreateDisk", "type": "boolean", "required": false, "description": "是否是新购云盘进行挂载", "example": "true" }, { "name": "DiskSpec", "type": "object", "required": false, "description": "新购云盘规格", "example": "无", "children": [ { "name": "Count", "type": "integer", "required": false, "description": "数量", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "名字", "example": "高效云盘" }, { "name": "DiskType", "type": "string", "required": false, "description": "磁盘类型", "example": "CLOUD_SSD" }, { "name": "DefaultDiskSize", "type": "integer", "required": false, "description": "指定磁盘大小", "example": "1000" } ] }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "可选参数，不传该参数则仅执行挂载操作。传入True时，会在挂载成功后将云硬盘设置为随云主机销毁模式，仅对按量计费云硬盘有效。", "example": "true" }, { "name": "SelectiveConfServices", "type": "array", "required": false, "description": "新挂磁盘时可支持配置的服务名称列表", "example": "[\"HDFS\",\"YARN\"]", "item_type": "string" }, { "name": "ChargeType", "type": "integer", "required": false, "description": "磁盘计费类型（1包月、3包销）", "example": "1" }, { "name": "UnderWriteDuration", "type": "integer", "required": false, "description": "磁盘包销购买时长（仅支持12、24、36、48、60）", "example": "12" } ], "required": [ "InstanceId" ] }, { "name": "ConvertPreToPostCluster", "description": "包月集群转按量集群（不含cdb）", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID。", "example": "\"emr-ge0vrqkl\"" }, { "name": "ClientToken", "type": "string", "required": false, "description": "5min内不可重入标识，订单标识", "example": "86f16cf2f5ceb39b1ff5ac3d56e869a8" } ], "required": [ "InstanceId" ] }, { "name": "CreateCloudInstance", "description": "创建EMR容器集群实例", "status": "online", "parameters": [ { "name": "InstanceName", "type": "string", "required": true, "description": "实例名称。 长度限制为6-36个字符。 只允许包含中文、字母、数字、-、_。", "example": "emrtest" }, { "name": "ClusterClass", "type": "string", "required": true, "description": "容器集群类型，取值范围 EMR容器集群实例: EMR-TKE", "example": "EMR-TKE" }, { "name": "Software", "type": "array", "required": true, "description": "部署的组件列表，不同的EMR产品ID（ProductId：具体含义参考入参ProductId字段）对应不同可选组件列表，不同产品版本可选组件列表查询：[组件版本](https://cloud.tencent.com/document/product/589/20279) ；", "example": "[\"zookeeper-3.6.3\",\"metastore-3.1.3\",\"openldap-2.4.44\",\"hiveserver2-3.1.3\",\"spark-3.3.2\"]", "item_type": "string" }, { "name": "PlatFormType", "type": "string", "required": true, "description": "容器平台类型，取值范围 EMR容器集群实例: tke", "example": "tke" }, { "name": "CosBucket", "type": "string", "required": true, "description": "cos存储桶", "example": "sparkhistorytest-1258469122" }, { "name": "EksClusterId", "type": "string", "required": false, "description": "容器集群id", "example": "cls-k4bsjrtr" }, { "name": "ProductId", "type": "integer", "required": false, "description": "产品Id，不同产品ID表示不同的EMR产品版本。取值范围： 60:表示EMR-TKE-V1.1.0 55:表示EMR-TKE-V1.0.1 52:表示EMR-TKE-V1.0.0", "example": "60" }, { "name": "ClientToken", "type": "string", "required": false, "description": "客户端token，唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，小于等于64个字符，例如 a9a90aa6fae36063280 示例值：a9a90aa6fae36063280", "example": "a9a90aa6----fae36063280" }, { "name": "VPCSettings", "type": "object", "required": false, "description": "私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC ID", "example": "vpc-xxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "Subnet ID", "example": "subnet-xxxxx" } ] }, { "name": "CloudResources", "type": "array", "required": false, "description": "所有组件角色及其对应的Pod资源请求信息", "example": "无", "item_type": "object", "children": [ { "name": "ComponentName", "type": "string", "required": true, "description": "组件角色名", "example": "Coordinator" }, { "name": "PodNumber", "type": "integer", "required": true, "description": "pod请求数量", "example": "2" }, { "name": "LimitCpu", "type": "integer", "required": true, "description": "Cpu请求数量最大值", "example": "4" }, { "name": "LimitMemory", "type": "integer", "required": true, "description": "内存请求数量最大值", "example": "2048" }, { "name": "Service", "type": "string", "required": false, "description": "服务名称，如HIVE", "example": "RSS" }, { "name": "VolumeDir", "type": "object", "required": false, "description": "数据卷目录设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VolumeType", "type": "string", "required": false, "description": "数据卷类型 HOST_PATH表示支持本机路径 NEW_PVC表示新建PVC 组件角色支持的数据卷类型可参考 EMR on TKE 集群部署说明：[部署说明](https://cloud.tencent.com/document/product/589/94254)", "example": "NEW_PVC" }, { "name": "HostPath", "type": "object", "required": false, "description": "主机路径信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Path", "type": "string", "required": false, "description": "主机路径", "example": "/data/test" }, { "name": "Type", "type": "string", "required": false, "description": "主机路径类型，当前默认DirectoryOrCreate", "example": "DirectoryOrCreate" } ] } ] }, { "name": "ExternalAccess", "type": "object", "required": false, "description": "组件外部访问设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "外部访问类型，当前仅支持CLB字段", "example": "CLB" }, { "name": "CLBServer", "type": "object", "required": false, "description": "CLB设置信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "CLBType", "type": "string", "required": false, "description": "CLB类型，PUBLIC_IP表示支持公网CLB和INTERNAL_IP表示支持内网CLB字段", "example": "PUBLIC_IP" }, { "name": "VPCSettings", "type": "object", "required": false, "description": "Vpc和子网信息设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] } ] }, { "name": "Affinity", "type": "object", "required": false, "description": "节点亲和性设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "RequiredDuringSchedulingIgnoredDuringExecution", "type": "object", "required": false, "description": "节点亲和性-强制调度设置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "NodeSelectorTerms", "type": "array", "required": false, "description": "Pod强制调度节点选择条件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "PreferredDuringSchedulingIgnoredDuringExecution", "type": "array", "required": false, "description": "节点亲和性-容忍调度 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Weight", "type": "integer", "required": false, "description": "权重，范围1-100", "example": "1" }, { "name": "Preference", "type": "object", "required": false, "description": "节点选择表达式 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] } ] }, { "name": "Disks", "type": "array", "required": false, "description": "所选数据盘信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型，创建EMR容器集群实例可选 SSD云盘: CLOUD_SSD 高效云盘: CLOUD_PREMIUM", "example": "CLOUD_SSD" }, { "name": "DiskCapacity", "type": "integer", "required": false, "description": "单块大小GB", "example": "70" }, { "name": "DiskNumber", "type": "integer", "required": false, "description": "数据盘数量", "example": "1" } ] }, { "name": "Tolerations", "type": "array", "required": false, "description": "容忍 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "键", "example": "key1" }, { "name": "Value", "type": "string", "required": false, "description": "值", "example": "value1" }, { "name": "Operator", "type": "string", "required": false, "description": "操作符", "example": "Equal" }, { "name": "Effect", "type": "string", "required": false, "description": "污点排斥效果", "example": "NoSchedule" }, { "name": "TolerationSeconds", "type": "integer", "required": false, "description": "驱逐等待时间", "example": "300" } ] } ] }, { "name": "SgId", "type": "string", "required": false, "description": "安全组Id，为空默认创建新的安全组", "example": "sg-jfluxxxx" }, { "name": "MetaDBInfo", "type": "object", "required": false, "description": "元数据库信息 MetaDB信息，当MetaType选择EMR_NEW_META时，MetaDataJdbcUrl MetaDataUser MetaDataPass UnifyMetaInstanceId不用填 当MetaType选择EMR_EXIT_META时，填写UnifyMetaInstanceId 当MetaType选择USER_CUSTOM_META时，填写MetaDataJdbcUrl MetaDataUser MetaDataPass", "example": "无", "children": [ { "name": "MetaDataJdbcUrl", "type": "string", "required": false, "description": "自定义MetaDB的JDBC连接，示例: jdbc:mysql://10.10.10.10:3306/dbname", "example": "jdbc:mysql://ip:port/hive" }, { "name": "MetaDataUser", "type": "string", "required": false, "description": "自定义MetaDB用户名", "example": "userName" }, { "name": "MetaDataPass", "type": "string", "required": false, "description": "自定义MetaDB密码", "example": "pwd" }, { "name": "MetaType", "type": "string", "required": false, "description": "hive共享元数据库类型。取值范围： EMR_DEFAULT_META：表示集群默认创建 EMR_EXIST_META：表示集群使用指定EMR-MetaDB。 USER_CUSTOM_META：表示集群使用自定义MetaDB。", "example": "EMR_DEFAULT_META" }, { "name": "UnifyMetaInstanceId", "type": "string", "required": false, "description": "EMR-MetaDB实例", "example": "MetaDB-example" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "标签信息", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "LoginSettings", "type": "object", "required": false, "description": "登录密码，LoginSettings中的Password字段", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码，8-16个字符，包含大写字母、小写字母、数字和特殊字符四种，特殊符号仅支持!@%^*，密码第一位不能为特殊字符", "example": "Password_test" }, { "name": "PublicKeyId", "type": "string", "required": false, "description": "密钥ID。关联密钥后，就可以通过对应的私钥来访问实例；PublicKeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取", "example": "PublicKeyId_test" } ] }, { "name": "ExternalService", "type": "array", "required": false, "description": "共享服务信息", "example": "无", "item_type": "object", "children": [ { "name": "ShareType", "type": "string", "required": true, "description": "共用组件类型，EMR/CUSTOM", "example": "EMR" }, { "name": "Service", "type": "string", "required": true, "description": "共用组件名", "example": "zookeeper" }, { "name": "InstanceId", "type": "string", "required": true, "description": "共用组件集群", "example": "emr-123" }, { "name": "CustomServiceDefineList", "type": "array", "required": true, "description": "自定义参数集合", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "自定义参数key", "example": "zookeeper.quorum" }, { "name": "Value", "type": "string", "required": false, "description": "自定义参数value", "example": "1.1.1.1" } ] } ] }, { "name": "ZoneId", "type": "integer", "required": false, "description": "可用区id", "example": "100002" }, { "name": "DefaultMetaVersion", "type": "string", "required": false, "description": "数据库版本", "example": "mysql8" }, { "name": "NeedCdbAudit", "type": "integer", "required": false, "description": "是否开通审计", "example": "0" }, { "name": "SgIP", "type": "string", "required": false, "description": "安全组来源IP", "example": "10.0.0.0/0" } ], "required": [ "InstanceName", "ClusterClass", "Software", "PlatFormType", "CosBucket" ] }, { "name": "CreateCluster", "description": "创建EMR集群实例", "status": "online", "parameters": [ { "name": "ProductVersion", "type": "string", "required": true, "description": "EMR产品版本名称如EMR-V2.3.0 表示2.3.0版本的EMR， 当前支持产品版本名称查询：[产品版本名称](https://cloud.tencent.com/document/product/589/66338)", "example": "EMR-V1.3.1" }, { "name": "EnableSupportHAFlag", "type": "boolean", "required": true, "description": "是否开启节点高可用。取值范围： true：表示开启节点高可用。 false：表示不开启节点高可用。", "example": "true" }, { "name": "InstanceName", "type": "string", "required": true, "description": "实例名称。 长度限制为6-36个字符。 只允许包含中文、字母、数字、-、_。", "example": "emr测试" }, { "name": "InstanceChargeType", "type": "string", "required": true, "description": "实例计费模式。取值范围： PREPAID：预付费，即包年包月。 POSTPAID_BY_HOUR：按小时后付费。", "example": "PREPAID" }, { "name": "LoginSettings", "type": "object", "required": true, "description": "实例登录设置。通过该参数可以设置所购买节点的登录方式密码或者密钥。 设置密钥时，密码仅用于组件原生WebUI快捷入口登录。 未设置密钥时，密码用于登录所购节点以及组件原生WebUI快捷入口登录。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码，8-16个字符，包含大写字母、小写字母、数字和特殊字符四种，特殊符号仅支持!@%^*，密码第一位不能为特殊字符", "example": "Password_test" }, { "name": "PublicKeyId", "type": "string", "required": false, "description": "密钥ID。关联密钥后，就可以通过对应的私钥来访问实例；PublicKeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取", "example": "PublicKeyId_test" } ] }, { "name": "SceneSoftwareConfig", "type": "object", "required": true, "description": "集群应用场景以及支持部署组件配置", "example": "无", "children": [ { "name": "Software", "type": "array", "required": true, "description": "部署的组件列表。不同的EMR产品版本ProductVersion 对应不同可选组件列表，不同产品版本可选组件列表查询：[组件版本](https://cloud.tencent.com/document/product/589/20279) ； 填写实例值：hive、flink。", "example": "[\"hadoop-2.8.4\\n\",\"zookeeper-3.4.9\\n\",\"knox-1.2.0\\n\"]", "item_type": "string" }, { "name": "SceneName", "type": "string", "required": false, "description": "默认Hadoop-Default,[场景查询](https://cloud.tencent.com/document/product/589/14624)场景化取值范围： Hadoop-Kudu Hadoop-Zookeeper Hadoop-Presto Hadoop-Hbase Hadoop-Default", "example": "Hadoop-Kudu" } ] }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "包年包月时间，默认为1，单位：月。 取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10,11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "boolean", "required": true, "description": "是否自动续费，默认为否。 true：是 false：否", "example": "false" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组的ID，形如sg-xxxxxxxx。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的SecurityGroupId字段来获取。", "example": "[\"sg-test\"]", "item_type": "string" }, { "name": "ScriptBootstrapActionConfig", "type": "array", "required": false, "description": "[引导操作](https://cloud.tencent.com/document/product/589/35656)脚本设置。", "example": "无", "item_type": "object", "children": [ { "name": "CosFileURI", "type": "string", "required": true, "description": "脚本的cos地址，参照格式：https://beijing-111111.cos.ap-beijing.myqcloud.com/data/test.sh查询cos存储桶列表：[存储桶列表](https://console.cloud.tencent.com/cos/bucket)", "example": "https://becklong-cos-1258469122.cos.ap-guangzhou.myqcloud.com/te" }, { "name": "ExecutionMoment", "type": "string", "required": true, "description": "引导脚步执行时机范围 resourceAfter：节点初始化后 clusterAfter：集群启动后 clusterBefore：集群启动前", "example": "resourceAfter" }, { "name": "Args", "type": "array", "required": false, "description": "执行脚本参数，参数格式请遵循标准Shell规范", "example": "args_test", "item_type": "string" }, { "name": "CosFileName", "type": "string", "required": false, "description": "脚本文件名", "example": "name_test" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "remark_test" } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "唯一随机标识，时效性为5分钟，需要调用者指定 防止客户端重复创建资源，例如 a9a90aa6-****-****-****-fae360632808", "example": "sdcdwxxxws" }, { "name": "NeedMasterWan", "type": "string", "required": false, "description": "是否开启集群Master节点公网。取值范围： NEED_MASTER_WAN：表示开启集群Master节点公网。 NOT_NEED_MASTER_WAN：表示不开启。默认开启集群Master节点公网。", "example": "NEED_MASTER_WAN" }, { "name": "EnableRemoteLoginFlag", "type": "boolean", "required": false, "description": "是否开启外网远程登录。（在SecurityGroupId不为空时，该参数无效）不填默认为不开启 取值范围： true：表示开启 false：表示不开启", "example": "true" }, { "name": "EnableKerberosFlag", "type": "boolean", "required": false, "description": "是否开启Kerberos认证。默认不开启 取值范围： true：表示开启 false：表示不开启", "example": "true" }, { "name": "CustomConf", "type": "string", "required": false, "description": "[自定义软件配置](https://cloud.tencent.com/document/product/589/35655?from_cn_redirect=1)", "example": "`{ \"serviceName\": \"\",\"classification\": \"\", \"serviceVersion\": \"\", \"properties\": { \"dfs.blocksize\": \"\", } }`" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到相应的实例。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "分散置放群组ID列表，当前只支持指定一个。 该参数可以通过调用 [DescribeDisasterRecoverGroups](https://cloud.tencent.com/document/product/213/17810)的返回值中的DisasterRecoverGroupId字段来获取。", "example": "[\"disa-xxxxx\"]", "item_type": "string" }, { "name": "EnableCbsEncryptFlag", "type": "boolean", "required": false, "description": "是否开启集群维度CBS加密。默认不加密 取值范围： true：表示加密 false：表示不加密", "example": "true" }, { "name": "MetaDBInfo", "type": "object", "required": false, "description": "MetaDB信息，当MetaType选择EMR_NEW_META时，MetaDataJdbcUrl MetaDataUser MetaDataPass UnifyMetaInstanceId不用填 当MetaType选择EMR_EXIT_META时，填写UnifyMetaInstanceId 当MetaType选择USER_CUSTOM_META时，填写MetaDataJdbcUrl MetaDataUser MetaDataPass", "example": "无", "children": [ { "name": "MetaDataJdbcUrl", "type": "string", "required": false, "description": "自定义MetaDB的JDBC连接，示例: jdbc:mysql://10.10.10.10:3306/dbname", "example": "jdbc:mysql://ip:port/hive" }, { "name": "MetaDataUser", "type": "string", "required": false, "description": "自定义MetaDB用户名", "example": "userName" }, { "name": "MetaDataPass", "type": "string", "required": false, "description": "自定义MetaDB密码", "example": "pwd" }, { "name": "MetaType", "type": "string", "required": false, "description": "hive共享元数据库类型。取值范围： EMR_DEFAULT_META：表示集群默认创建 EMR_EXIST_META：表示集群使用指定EMR-MetaDB。 USER_CUSTOM_META：表示集群使用自定义MetaDB。", "example": "EMR_DEFAULT_META" }, { "name": "UnifyMetaInstanceId", "type": "string", "required": false, "description": "EMR-MetaDB实例", "example": "MetaDB-example" } ] }, { "name": "DependService", "type": "array", "required": false, "description": "共享组件信息", "example": "无", "item_type": "object", "children": [ { "name": "ServiceName", "type": "string", "required": true, "description": "共用组件名", "example": "zookeeper" }, { "name": "InstanceId", "type": "string", "required": true, "description": "共用组件集群", "example": "emr-123" } ] }, { "name": "ZoneResourceConfiguration", "type": "array", "required": false, "description": "节点资源的规格，有几个可用区，就填几个，按顺序第一个为主可用区，第二个为备可用区，第三个为仲裁可用区。如果没有开启跨AZ，则长度为1即可。", "example": "无", "item_type": "object", "children": [ { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC ID", "example": "vpc-xxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "Subnet ID", "example": "subnet-xxxxx" } ] }, { "name": "Placement", "type": "object", "required": false, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区，例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "AllNodeResourceSpec", "type": "object", "required": false, "description": "所有节点资源的规格 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "MasterResourceSpec", "type": "object", "required": false, "description": "描述Master节点资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceType", "type": "string", "required": true, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "SystemDisk", "type": "array", "required": true, "description": "系统盘，系统盘个数不超过1块 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "DataDisk", "type": "array", "required": false, "description": "云数据盘，云数据盘总个数不超过15块 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "LocalDataDisk", "type": "array", "required": false, "description": "本地数据盘 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "CoreResourceSpec", "type": "object", "required": false, "description": "描述Core节点资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceType", "type": "string", "required": true, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "SystemDisk", "type": "array", "required": true, "description": "系统盘，系统盘个数不超过1块 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "DataDisk", "type": "array", "required": false, "description": "云数据盘，云数据盘总个数不超过15块 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "LocalDataDisk", "type": "array", "required": false, "description": "本地数据盘 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "TaskResourceSpec", "type": "object", "required": false, "description": "描述Taskr节点资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceType", "type": "string", "required": true, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "SystemDisk", "type": "array", "required": true, "description": "系统盘，系统盘个数不超过1块 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "DataDisk", "type": "array", "required": false, "description": "云数据盘，云数据盘总个数不超过15块 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "LocalDataDisk", "type": "array", "required": false, "description": "本地数据盘 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "CommonResourceSpec", "type": "object", "required": false, "description": "描述Common节点资源 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InstanceType", "type": "string", "required": true, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "SystemDisk", "type": "array", "required": true, "description": "系统盘，系统盘个数不超过1块 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "DataDisk", "type": "array", "required": false, "description": "云数据盘，云数据盘总个数不超过15块 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "LocalDataDisk", "type": "array", "required": false, "description": "本地数据盘 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "MasterCount", "type": "integer", "required": false, "description": "Master节点数量", "example": "1" }, { "name": "CoreCount", "type": "integer", "required": false, "description": "Corer节点数量", "example": "1" }, { "name": "TaskCount", "type": "integer", "required": false, "description": "Task节点数量", "example": "1" }, { "name": "CommonCount", "type": "integer", "required": false, "description": "Common节点数量", "example": "1" } ] }, { "name": "ZoneTag", "type": "string", "required": false, "description": "如果是单可用区，ZoneTag可以不用填， 如果是双AZ部署，第一个可用区ZoneTag选择master，第二个可用区ZoneTag选择standby，如果是三AZ部署，第一个可用区ZoneTag选择master，第二个可用区ZoneTag选择standby，第三个可用区ZoneTag选择third-party，取值范围： master standby third-party", "example": "master" } ] }, { "name": "CosBucket", "type": "string", "required": false, "description": "cos桶路径，创建StarRocks存算分离集群时用到", "example": "test-cos-1258469122" }, { "name": "NodeMarks", "type": "array", "required": false, "description": "节点标识信息，目前只提供给tf平台使用", "example": "无", "item_type": "object", "children": [ { "name": "NodeType", "type": "string", "required": false, "description": "节点类型：master,core,task,router", "example": "master" }, { "name": "NodeNames", "type": "array", "required": false, "description": "节点标记信息，目前只提供给tf平台使用，作为入参区分同类型节点信息", "example": "Master_1", "item_type": "string" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区名称", "example": "ap-guangzhou-1" } ] }, { "name": "LoadBalancerId", "type": "string", "required": false, "description": "clb id", "example": "lb-xxxxxxxx" }, { "name": "DefaultMetaVersion", "type": "string", "required": false, "description": "数据库版本：mysql8/tdsql8/mysql5", "example": "mysql8" }, { "name": "NeedCdbAudit", "type": "integer", "required": false, "description": "是否开通数据库审计", "example": "0" }, { "name": "SgIP", "type": "string", "required": false, "description": "安全指定来源ip", "example": "10.0.0.0/8" } ], "required": [ "ProductVersion", "EnableSupportHAFlag", "InstanceName", "InstanceChargeType", "LoginSettings", "SceneSoftwareConfig" ] }, { "name": "CreateGroupsSTD", "description": "用户管理-批量创建用户组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群名称", "example": "emr-o88f3whr" }, { "name": "Groups", "type": "array", "required": true, "description": "批量用户组信息", "example": "无", "item_type": "object", "children": [ { "name": "GroupName", "type": "string", "required": false, "description": "组名", "example": "groupTest" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "userGroup" }, { "name": "Users", "type": "array", "required": false, "description": "用户列表", "example": "[\"user\"]", "item_type": "string" } ] } ], "required": [ "InstanceId", "Groups" ] }, { "name": "CreateInstance", "description": "创建EMR集群实例", "status": "online", "parameters": [ { "name": "ProductId", "type": "integer", "required": true, "description": "产品ID，不同产品ID表示不同的EMR产品版本。取值范围： 51:表示STARROCKS-V1.4.0 54:表示STARROCKS-V2.0.0 27:表示KAFKA-V1.0.0 50:表示KAFKA-V2.0.0 16:表示EMR-V2.3.0 20:表示EMR-V2.5.0 30:表示EMR-V2.6.0 38:表示EMR-V2.7.0 25:表示EMR-V3.1.0 33:表示EMR-V3.2.1 34:表示EMR-V3.3.0 37:表示EMR-V3.4.0 44:表示EMR-V3.5.0 53:表示EMR-V3.6.0 58:表示EMR-3.6.1 59:表示EMR-serverless-1.0.0 60:表示EMR-TKE-1.1.0 61:表示SR-V2.1.0 62:表示SR-V2.1.0-SharedData 63:表示...", "example": "4" }, { "name": "Software", "type": "array", "required": true, "description": "部署的组件列表。不同的EMR产品ID（ProductId：具体含义参考入参ProductId字段）对应不同可选组件列表，不同产品版本可选组件列表查询：[组件版本](https://cloud.tencent.com/document/product/589/20279) ； 填写实例值：hive、flink。", "example": "[\"hadoop-2.8.4\\n\",\"zookeeper-3.4.9\\n\",\"knox-1.2.0\\n\"]", "item_type": "string" }, { "name": "SupportHA", "type": "integer", "required": true, "description": "是否开启节点高可用。取值范围： 0：表示不开启节点高可用。 1：表示开启节点高可用。", "example": "0" }, { "name": "InstanceName", "type": "string", "required": true, "description": "实例名称。 长度限制为6-36个字符。 只允许包含中文、字母、数字、-、_。", "example": "emr测试" }, { "name": "PayMode", "type": "integer", "required": true, "description": "实例计费模式。取值范围： 0：表示按量计费。 1：表示包年包月。", "example": "0" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "购买实例的时长。结合TimeUnit一起使用。 TimeUnit为s时，该参数只能填写3600，表示按量计费实例。 TimeUnit为m时，该参数填写的数字表示包年包月实例的购买时长，如1表示购买一个月", "example": "3600" }, { "name": "TimeUnit", "type": "string", "required": true, "description": "购买实例的时间单位。取值范围： s：表示秒。PayMode取值为0时，TimeUnit只能取值为s。 m：表示月份。PayMode取值为1时，TimeUnit只能取值为m。", "example": "s" }, { "name": "LoginSettings", "type": "object", "required": true, "description": "实例登录设置。通过该参数可以设置所购买节点的登录方式密码或者密钥。 设置密钥时，密码仅用于组件原生WebUI快捷入口登录。 未设置密钥时，密码用于登录所购节点以及组件原生WebUI快捷入口登录。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码，8-16个字符，包含大写字母、小写字母、数字和特殊字符四种，特殊符号仅支持!@%^*，密码第一位不能为特殊字符", "example": "Password_test" }, { "name": "PublicKeyId", "type": "string", "required": false, "description": "密钥ID。关联密钥后，就可以通过对应的私钥来访问实例；PublicKeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取", "example": "PublicKeyId_test" } ] }, { "name": "VPCSettings", "type": "object", "required": false, "description": "私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC ID", "example": "vpc-xxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "Subnet ID", "example": "subnet-xxxxx" } ] }, { "name": "ResourceSpec", "type": "object", "required": false, "description": "节点资源的规格。", "example": "无", "children": [ { "name": "MasterResourceSpec", "type": "object", "required": false, "description": "描述Master节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "云盘类型 CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "CLOUD_SSD" }, { "name": "Volume", "type": "integer", "required": false, "description": "云盘大小", "example": "20000" }, { "name": "Count", "type": "integer", "required": false, "description": "该类型云盘个数", "example": "1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "CoreResourceSpec", "type": "object", "required": false, "description": "描述Core节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "云盘类型 CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "CLOUD_SSD" }, { "name": "Volume", "type": "integer", "required": false, "description": "云盘大小", "example": "20000" }, { "name": "Count", "type": "integer", "required": false, "description": "该类型云盘个数", "example": "1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "TaskResourceSpec", "type": "object", "required": false, "description": "描述Task节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "云盘类型 CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "CLOUD_SSD" }, { "name": "Volume", "type": "integer", "required": false, "description": "云盘大小", "example": "20000" }, { "name": "Count", "type": "integer", "required": false, "description": "该类型云盘个数", "example": "1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "MasterCount", "type": "integer", "required": false, "description": "Master节点数量", "example": "2" }, { "name": "CoreCount", "type": "integer", "required": false, "description": "Core节点数量", "example": "3" }, { "name": "TaskCount", "type": "integer", "required": false, "description": "Task节点数量", "example": "0" }, { "name": "CommonResourceSpec", "type": "object", "required": false, "description": "描述Common节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "云盘类型 CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "CLOUD_SSD" }, { "name": "Volume", "type": "integer", "required": false, "description": "云盘大小", "example": "20000" }, { "name": "Count", "type": "integer", "required": false, "description": "该类型云盘个数", "example": "1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "CommonCount", "type": "integer", "required": false, "description": "Common节点数量", "example": "3" } ] }, { "name": "COSSettings", "type": "object", "required": false, "description": "开启COS访问需要设置的参数。", "example": "无", "children": [ { "name": "CosSecretId", "type": "string", "required": true, "description": "COS SecretId", "example": "SecretId " }, { "name": "CosSecretKey", "type": "string", "required": true, "description": "COS SecrectKey", "example": "SecrectKey" }, { "name": "LogOnCosPath", "type": "string", "required": false, "description": "日志存储在COS上的路径", "example": "cosn://ad-data-xxxxxx/data/logs/xxxxxxx" } ] }, { "name": "Placement", "type": "object", "required": false, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区，例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "SgId", "type": "string", "required": false, "description": "实例所属安全组的ID，形如sg-xxxxxxxx。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的SecurityGroupId字段来获取。", "example": "sg-xxxxxxxxxx" }, { "name": "PreExecutedFileSettings", "type": "array", "required": false, "description": "[引导操作](https://cloud.tencent.com/document/product/589/35656)脚本设置。", "example": "无", "item_type": "object", "children": [ { "name": "Path", "type": "string", "required": false, "description": "脚本在COS上路径，已废弃", "example": "emr/emr_init.sh" }, { "name": "Args", "type": "array", "required": false, "description": "执行脚本参数", "example": "Args_test", "item_type": "string" }, { "name": "Bucket", "type": "string", "required": false, "description": "COS的Bucket名称，已废弃", "example": "starmaker-research-xxxx" }, { "name": "Region", "type": "string", "required": false, "description": "COS的Region名称，已废弃", "example": "ap-mumbai" }, { "name": "Domain", "type": "string", "required": false, "description": "COS的Domain数据，已废弃", "example": "Domain_test" }, { "name": "RunOrder", "type": "integer", "required": false, "description": "执行顺序", "example": "0" }, { "name": "WhenRun", "type": "string", "required": false, "description": "resourceAfter 或 clusterAfter", "example": "resourceAfter" }, { "name": "CosFileName", "type": "string", "required": false, "description": "脚本文件名，已废弃", "example": "test_file" }, { "name": "CosFileURI", "type": "string", "required": false, "description": "脚本的cos地址", "example": "cos://xxxxx" }, { "name": "CosSecretId", "type": "string", "required": false, "description": "cos的SecretId", "example": "CosSecretId_test" }, { "name": "CosSecretKey", "type": "string", "required": false, "description": "Cos的SecretKey", "example": "CosSecretKey_test" }, { "name": "AppId", "type": "string", "required": false, "description": "cos的appid，已废弃", "example": "41345531" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "remark_test" } ] }, { "name": "AutoRenew", "type": "integer", "required": false, "description": "包年包月实例是否自动续费。取值范围： 0：表示不自动续费。 1：表示自动续费。", "example": "0" }, { "name": "ClientToken", "type": "string", "required": false, "description": "唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6-****-****-****-fae36063280", "example": "a9a90aa6-****-****-****-fae36063280" }, { "name": "NeedMasterWan", "type": "string", "required": false, "description": "是否开启集群Master节点公网。取值范围： NEED_MASTER_WAN：表示开启集群Master节点公网。 NOT_NEED_MASTER_WAN：表示不开启。默认开启集群Master节点公网。", "example": "NEED_MASTER_WAN" }, { "name": "RemoteLoginAtCreate", "type": "integer", "required": false, "description": "是否需要开启外网远程登录，即22号端口。在SgId不为空时，该参数无效。", "example": "22" }, { "name": "CheckSecurity", "type": "integer", "required": false, "description": "是否开启安全集群。0表示不开启，非0表示开启。", "example": "0" }, { "name": "ExtendFsField", "type": "string", "required": false, "description": "访问外部文件系统。", "example": "fs" }, { "name": "Tags", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到相应的实例。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "分散置放群组ID列表，当前只支持指定一个。 该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/product/213/15486 ) 的返回值中的SecurityGroupId字段来获取。", "example": "[\"disa-xxxxx\"]", "item_type": "string" }, { "name": "CbsEncrypt", "type": "integer", "required": false, "description": "集群维度CBS加密盘，默认0表示不加密，1表示加密", "example": "0" }, { "name": "MetaType", "type": "string", "required": false, "description": "hive共享元数据库类型。取值范围： EMR_DEFAULT_META：表示集群默认创建 EMR_EXIST_META：表示集群使用指定EMR-MetaDB。 USER_CUSTOM_META：表示集群使用自定义MetaDB。", "example": "EMR_EXIT_META" }, { "name": "UnifyMetaInstanceId", "type": "string", "required": false, "description": "EMR-MetaDB实例", "example": "instdxxxxx" }, { "name": "MetaDBInfo", "type": "object", "required": false, "description": "自定义MetaDB信息", "example": "无", "children": [ { "name": "MetaDataJdbcUrl", "type": "string", "required": false, "description": "自定义MetaDB的JDBC连接，请以 jdbc:mysql:// 开头", "example": "jdbc:mysql://ip:port/hive" }, { "name": "MetaDataUser", "type": "string", "required": false, "description": "自定义MetaDB用户名", "example": "userName" }, { "name": "MetaDataPass", "type": "string", "required": false, "description": "自定义MetaDB密码", "example": "pwd" } ] }, { "name": "ApplicationRole", "type": "string", "required": false, "description": "自定义应用角色。", "example": "roleName" }, { "name": "SceneName", "type": "string", "required": false, "description": "场景化取值： Hadoop-Kudu Hadoop-Zookeeper Hadoop-Presto Hadoop-Hbase", "example": "Hadoop-Kudu" }, { "name": "ExternalService", "type": "array", "required": false, "description": "共享组件信息", "example": "无", "item_type": "object", "children": [ { "name": "ShareType", "type": "string", "required": true, "description": "共用组件类型，EMR/CUSTOM", "example": "EMR" }, { "name": "Service", "type": "string", "required": true, "description": "共用组件名", "example": "zookeeper" }, { "name": "InstanceId", "type": "string", "required": true, "description": "共用组件集群", "example": "emr-123" }, { "name": "CustomServiceDefineList", "type": "array", "required": true, "description": "自定义参数集合", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "自定义参数key", "example": "zookeeper.quorum" }, { "name": "Value", "type": "string", "required": false, "description": "自定义参数value", "example": "1.1.1.1" } ] } ] }, { "name": "VersionID", "type": "integer", "required": false, "description": "如果为0，则MultiZone、MultiDeployStrategy、MultiZoneSettings是disable的状态，如果为1，则废弃ResourceSpec，使用MultiZoneSettings。", "example": "1" }, { "name": "MultiZone", "type": "boolean", "required": false, "description": "true表示开启跨AZ部署；仅为新建集群时的用户参数，后续不支持调整。", "example": "false" }, { "name": "MultiZoneSettings", "type": "array", "required": false, "description": "节点资源的规格，有几个可用区，就填几个，按顺序第一个为主可用区，第二个为备可用区，第三个为仲裁可用区。如果没有开启跨AZ，则长度为1即可。", "example": "无", "item_type": "object", "children": [ { "name": "ZoneTag", "type": "string", "required": false, "description": "\"master\"、\"standby\"、\"third-party\"", "example": "\"master\"" }, { "name": "VPCSettings", "type": "object", "required": false, "description": "无", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC ID", "example": "vpc-xxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "Subnet ID", "example": "subnet-xxxxx" } ] }, { "name": "Placement", "type": "object", "required": false, "description": "无", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区，例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "ResourceSpec", "type": "object", "required": false, "description": "无", "example": "无", "children": [ { "name": "MasterResourceSpec", "type": "object", "required": false, "description": "描述Master节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "CoreResourceSpec", "type": "object", "required": false, "description": "描述Core节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "TaskResourceSpec", "type": "object", "required": false, "description": "描述Task节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "MasterCount", "type": "integer", "required": false, "description": "Master节点数量", "example": "2" }, { "name": "CoreCount", "type": "integer", "required": false, "description": "Core节点数量", "example": "3" }, { "name": "TaskCount", "type": "integer", "required": false, "description": "Task节点数量", "example": "0" }, { "name": "CommonResourceSpec", "type": "object", "required": false, "description": "描述Common节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "CommonCount", "type": "integer", "required": false, "description": "Common节点数量", "example": "3" } ] } ] }, { "name": "CosBucket", "type": "string", "required": false, "description": "cos桶路径，创建StarRocks存算分离集群时用到", "example": "aicv-prod-1306440315" }, { "name": "NodeMarks", "type": "array", "required": false, "description": "节点标识信息，目前只提供给tf平台使用", "example": "无", "item_type": "object", "children": [ { "name": "NodeType", "type": "string", "required": false, "description": "节点类型：master,core,task,router", "example": "master" }, { "name": "NodeNames", "type": "array", "required": false, "description": "节点标记信息，目前只提供给tf平台使用，作为入参区分同类型节点信息", "example": "Master_1", "item_type": "string" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区名称", "example": "ap-guangzhou-1" } ] }, { "name": "LoadBalancerId", "type": "string", "required": false, "description": "CLB id", "example": "lb-xxxxxx" }, { "name": "DefaultMetaVersion", "type": "string", "required": false, "description": "数据库类型：mysql8/tdsql8", "example": "mysql8" }, { "name": "NeedCdbAudit", "type": "integer", "required": false, "description": "是否开通审计：0:不开通,1:开通", "example": "0" }, { "name": "SgIP", "type": "string", "required": false, "description": "安全组指定来源ip", "example": "10.0.0.0/8" } ], "required": [ "ProductId", "Software", "SupportHA", "InstanceName", "PayMode", "TimeSpan", "TimeUnit", "LoginSettings" ] }, { "name": "CreateSLInstance", "description": "本接口（CreateSLInstance）用于创建Serverless HBase实例 - 接口调用成功，会创建Serverless HBase实例，创建实例请求成功会返回创建实例的InstaceId和请求的 RequestID。 - 接口为异步接口，接口返回时操作并未立即完成，实例操作结果可以通过调用DescribeInstancesList查看当前实例的StatusDesc状态。", "status": "online", "parameters": [ { "name": "InstanceName", "type": "string", "required": true, "description": "实例名称。", "example": "emr-test" }, { "name": "PayMode", "type": "integer", "required": true, "description": "实例计费模式，0表示后付费，即按量计费，1表示预付费，即包年包月。", "example": "0" }, { "name": "DiskType", "type": "string", "required": true, "description": "实例存储类型，CLOUD_HSSD表示性能云存储， CLOUD_BSSD表示标准云存储。", "example": "CLOUD_HSSD" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "实例单节点磁盘容量，单位GB，单节点磁盘容量需大于等于100，小于等于250*CPU核心数，容量调整步长为100。", "example": "200" }, { "name": "NodeType", "type": "string", "required": true, "description": "实例节点规格，可填写4C16G、8C32G、16C64G、32C128G，不区分大小写。", "example": "4C16G" }, { "name": "ZoneSettings", "type": "array", "required": true, "description": "实例可用区详细配置，当前支持多可用区，可用区数量只能为1或3，包含区域名称，VPC信息、节点数量，其中所有区域节点总数需大于等于3，小于等于50。", "example": "无", "item_type": "object", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区名称", "example": "ap-guangzhou-2" }, { "name": "VPCSettings", "type": "object", "required": true, "description": "可用区VPC和子网", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC ID", "example": "vpc-xxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "Subnet ID", "example": "subnet-xxxxx" } ] }, { "name": "NodeNum", "type": "integer", "required": true, "description": "可用区节点数量", "example": "3" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "实例要绑定的标签列表。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "PrePaySetting", "type": "object", "required": false, "description": "预付费参数", "example": "无", "children": [ { "name": "Period", "type": "object", "required": true, "description": "时间 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "TimeSpan", "type": "integer", "required": true, "description": "时间跨度", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "时间单位，\"m\"代表月。", "example": "m" } ] }, { "name": "AutoRenewFlag", "type": "integer", "required": true, "description": "自动续费标记，0：表示通知即将过期，但不自动续费 1：表示通知即将过期，而且自动续费 2：表示不通知即将过期，也不自动续费", "example": "0" } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "唯一随机标识，时效性为5分钟，需要调用者指定 防止客户端重复创建资源，例如 a9a90aa6-****-****-****-fae360632808", "example": "sdcdwxxxws" }, { "name": "DeploymentMode", "type": "string", "required": false, "description": "部署模式", "example": "Active-Standby" } ], "required": [ "InstanceName", "PayMode", "DiskType", "DiskSize", "NodeType", "ZoneSettings" ] }, { "name": "DeleteAutoScaleStrategy", "description": "删除自动扩缩容规则，后台销毁根据该规则扩缩容出来的节点", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "emr-3ap64zl6" }, { "name": "StrategyType", "type": "integer", "required": true, "description": "自动扩缩容规则类型，1表示按照负载指标扩缩容，2表示按照时间规则扩缩容。", "example": "1" }, { "name": "StrategyId", "type": "integer", "required": true, "description": "规则ID。", "example": "42" }, { "name": "GroupId", "type": "integer", "required": false, "description": "伸缩组Id", "example": "2" } ], "required": [ "InstanceId", "StrategyType", "StrategyId" ] }, { "name": "DeleteGroupsSTD", "description": "批量删除用户组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群名称", "example": "emr-o88f3whr" }, { "name": "GroupNames", "type": "array", "required": true, "description": "用户组名称数组", "example": "[\"group1\",\"group2\"]", "item_type": "string" } ], "required": [ "InstanceId", "GroupNames" ] }, { "name": "DeleteNodeResourceConfig", "description": "删除当前集群的节点规格配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例Id", "example": "emr-dadsca" }, { "name": "ResourceConfigId", "type": "integer", "required": true, "description": "节点配置Id", "example": "12" }, { "name": "ResourceType", "type": "string", "required": false, "description": "节点类型 CORE TASK ROUTER", "example": "CORE" }, { "name": "ResourceBaseType", "type": "string", "required": false, "description": "类型为ComputeResource和EMR以及默认，默认为EMR", "example": "ComputeResource" }, { "name": "ComputeResourceId", "type": "string", "required": false, "description": "计算资源id", "example": "emr-cr-xxxxx" } ], "required": [ "InstanceId", "ResourceConfigId" ] }, { "name": "DeleteUserManagerUserList", "description": "删除用户列表（用户管理）", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID", "example": "emr-o88f3whr" }, { "name": "UserNameList", "type": "array", "required": false, "description": "集群用户名列表", "example": "[\"user1\"]", "item_type": "string" }, { "name": "TkeClusterId", "type": "string", "required": false, "description": "tke/eks集群id，容器集群传", "example": "emr-xxx" }, { "name": "DisplayStrategy", "type": "string", "required": false, "description": "默认空，容器版传\"native\"", "example": "native" }, { "name": "UserGroupList", "type": "array", "required": false, "description": "用户组", "example": "无", "item_type": "object", "children": [ { "name": "UserName", "type": "string", "required": true, "description": "用户名", "example": "root" }, { "name": "UserGroup", "type": "string", "required": true, "description": "用户组", "example": "root" } ] }, { "name": "DeleteHomeDir", "type": "boolean", "required": false, "description": "是否删除家目录，只针对cvm集群", "example": "true" } ], "required": [ "InstanceId" ] }, { "name": "DeployYarnConf", "description": "yarn资源调度-部署生效", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "emr集群的英文id", "example": "emr-2xef56" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAutoScaleGroupGlobalConf", "description": "获取自动扩缩容全局配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "emr-xxxxxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAutoScaleRecords", "description": "获取集群的自动扩缩容的详细记录", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "emr-3ap64zl6" }, { "name": "Filters", "type": "array", "required": false, "description": "记录过滤参数，目前仅能为“StartTime”,“EndTime”和“StrategyName”、ActionStatus、ScaleAction。 StartTime和EndTime支持2006-01-02 15:04:05 或者2006/01/02 15:04:05的时间格式 ActionStatus：0:INITED,1:SUCCESS, 2:FAILED,3:LIMITED_SUCCESSED,4:IN_PROCESS,5:IN_RETRY ScaleAction：1:扩容 2:缩容", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "键", "example": "key_test" }, { "name": "Value", "type": "string", "required": true, "description": "值", "example": "value_test" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数。最大支持100", "example": "10" }, { "name": "RecordSource", "type": "integer", "required": false, "description": "表示是自动(0)还是托管伸缩(1)", "example": "0" }, { "name": "Asc", "type": "integer", "required": false, "description": "是否升序，1:升序，0:降序", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeAutoScaleStrategies", "description": "获取自动扩缩容规则", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "emr-dttol202" }, { "name": "GroupId", "type": "integer", "required": false, "description": "伸缩组id", "example": "2" } ], "required": [ "InstanceId" ] }, { "name": "DescribeClusterFlowStatusDetail", "description": "查询EMR任务运行详情状态", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "EMR实例ID", "example": "emr-examples" }, { "name": "FlowParam", "type": "object", "required": true, "description": "流程相关参数", "example": "无", "children": [ { "name": "FKey", "type": "string", "required": true, "description": "流程参数key TraceId：通过TraceId查询 FlowId： 通过FlowId查询", "example": "FlowId" }, { "name": "FValue", "type": "string", "required": true, "description": "参数value", "example": "11" } ] }, { "name": "NeedExtraDetail", "type": "boolean", "required": false, "description": "是否返回任务额外信息 默认: false", "example": "false" } ], "required": [ "InstanceId", "FlowParam" ] }, { "name": "DescribeClusterNodes", "description": "查询集群节点信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID,实例ID形如: emr-xxxxxxxx", "example": "emr-6deluvd4" }, { "name": "NodeFlag", "type": "string", "required": true, "description": "节点标识，取值为： all：表示获取全部类型节点，cdb信息除外。 master：表示获取master节点信息。 core：表示获取core节点信息。 task：表示获取task节点信息。 common：表示获取common节点信息。 router：表示获取router节点信息。 db：表示获取正常状态的cdb信息。 recyle：表示获取回收站隔离中的节点信息，包括cdb信息。 renew：表示获取所有待续费的节点信息，包括cdb信息，自动续费节...", "example": "all" }, { "name": "ExportDb", "type": "boolean", "required": false, "description": "导出全部节点信息csv时是否携带cdb信息", "example": "true" }, { "name": "Offset", "type": "integer", "required": false, "description": "页编号，默认值为0，表示第一页。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页返回数量，默认值为100，最大值为100。 如果offset和limit都不填，或者都填0，则返回全部数据", "example": "10" }, { "name": "HardwareResourceType", "type": "string", "required": false, "description": "资源类型:支持all/host/pod，默认为all", "example": "all" }, { "name": "SearchFields", "type": "array", "required": false, "description": "支持搜索的字段", "example": "无", "item_type": "object", "children": [ { "name": "SearchType", "type": "string", "required": true, "description": "支持搜索的类型", "example": "ipv4" }, { "name": "SearchValue", "type": "string", "required": true, "description": "支持搜索的值", "example": "127.0.0.1" } ] }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段", "example": "ApplyTime" }, { "name": "Asc", "type": "integer", "required": false, "description": "是否升序，1:升序，0:降序", "example": "1" } ], "required": [ "InstanceId", "NodeFlag" ] }, { "name": "DescribeCvmQuota", "description": "获取账户的CVM配额", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "EMR集群ID", "example": "emr-xxxxxxx" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "区ID", "example": "100002" } ], "required": [ "ClusterId" ] }, { "name": "DescribeDAGInfo", "description": "查询DAG信息", "status": "online", "parameters": [ { "name": "InstanceID", "type": "string", "required": true, "description": "集群ID", "example": "emr-xfaf11ab" }, { "name": "Type", "type": "string", "required": true, "description": "DAG类型，目前只支持STARROCKS", "example": "STARROCKS" }, { "name": "IDList", "type": "array", "required": true, "description": "查询ID列表,最大长度为1", "example": "query_xxx", "item_type": "string" } ], "required": [ "InstanceID", "Type", "IDList" ] }, { "name": "DescribeEMREventList", "description": "查询EMR事件监控数据", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-32xv111" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询事件的开始时间", "example": "1767671005" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询事件的结束时间", "example": "1767671005" }, { "name": "Host", "type": "string", "required": false, "description": "事件触发的IP", "example": "127.0.0.1" }, { "name": "Role", "type": "string", "required": false, "description": "事件受影响服务角色", "example": "CPU" }, { "name": "Name", "type": "string", "required": false, "description": "事件名称", "example": "CPU利用率连续高于阈值" }, { "name": "Offset", "type": "integer", "required": false, "description": "事件列表的偏移量", "example": "20" }, { "name": "Limit", "type": "integer", "required": false, "description": "事件列表的Limit", "example": "10" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeEmrApplicationStatics", "description": "yarn application 统计接口查询", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "emr-9kd5tnmq" }, { "name": "StartTime", "type": "integer", "required": false, "description": "起始时间，时间戳（秒）", "example": "1621570097" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间，时间戳（秒）", "example": "1621590097" }, { "name": "Queues", "type": "array", "required": false, "description": "过滤的队列名", "example": "[\"normal\"]", "item_type": "string" }, { "name": "Users", "type": "array", "required": false, "description": "过滤的用户名", "example": "[\"testuser\"]", "item_type": "string" }, { "name": "ApplicationTypes", "type": "array", "required": false, "description": "过滤的作业类型", "example": "[\"MAPREDUCE\",\"SPARK\"]", "item_type": "string" }, { "name": "GroupBy", "type": "array", "required": false, "description": "分组字段，可选：queue, user, applicationType", "example": "[\"user\"]", "item_type": "string" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，可选：sumMemorySeconds, sumVCoreSeconds, sumHDFSBytesWritten, sumHDFSBytesRead", "example": "sumMemorySeconds" }, { "name": "IsAsc", "type": "integer", "required": false, "description": "是否顺序排序，0-逆序，1-正序", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "页号", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "页容量，范围为[10,100]", "example": "20" } ], "required": [ "InstanceId" ] }, { "name": "DescribeEmrOverviewMetrics", "description": "查询监控概览页指标数据", "status": "online", "parameters": [ { "name": "End", "type": "integer", "required": true, "description": "结束时间", "example": "1111122" }, { "name": "Metric", "type": "string", "required": true, "description": "指标名，NODE.CPU：节点平均CPU利用率和总核数；NODE.CPU.SLHBASE：Serverless实例平均CPU利用率和总核数；HDFS.NN.CAPACITY：存储使用率和总量", "example": "NODE.CPU" }, { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "emr-byecdx96" }, { "name": "Downsample", "type": "string", "required": true, "description": "粒度 30s-max 1m-max 1h-max等", "example": "30s-min" }, { "name": "Start", "type": "integer", "required": false, "description": "起始时间，画饼状图时不传", "example": "111111" }, { "name": "Aggregator", "type": "string", "required": false, "description": "聚合方法，扩展用，这里目前不用传", "example": "30s" }, { "name": "Tags", "type": "string", "required": false, "description": "指标要查询的具体type 如：\"{\"type\":\"CapacityTotal|CapacityRemaining\"}\"", "example": "queue" } ], "required": [ "End", "Metric", "InstanceId", "Downsample" ] }, { "name": "DescribeGlobalConfig", "description": "查询YARN资源调度的全局配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "emr集群的英文id", "example": "emr-2xef56" } ], "required": [ "InstanceId" ] }, { "name": "DescribeGroupsSTD", "description": "查询用户组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群名称", "example": "emr-mzkssfla" }, { "name": "Filters", "type": "array", "required": false, "description": "描述键值对过滤器，用于条件过滤查询", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "需要过滤的字段。", "example": "groupName" }, { "name": "Values", "type": "array", "required": false, "description": "字段的过滤值。", "example": "nametest", "item_type": "string" } ] }, { "name": "OrderFields", "type": "object", "required": false, "description": "描述排序，用于排序", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "排序字段。", "example": "create_time" }, { "name": "Direction", "type": "string", "required": false, "description": "Desc or Asc。", "example": "asc" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数", "example": "100" } ], "required": [ "InstanceId" ] }, { "name": "DescribeHBaseTableOverview", "description": "获取Hbase表级监控数据概览接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "emr-xfaf11ab" }, { "name": "Offset", "type": "integer", "required": true, "description": "页码，第一页:0，第二页:1", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页查询时的分页大小，最小1，最大100", "example": "100" }, { "name": "Table", "type": "string", "required": false, "description": "表名称，模糊匹配", "example": "hbase-meta" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序的字段，有默认值", "example": "ReadRequestCount" }, { "name": "OrderType", "type": "string", "required": false, "description": "默认为降序，asc代表升序，desc代表降序", "example": "asc" } ], "required": [ "InstanceId", "Offset", "Limit" ] }, { "name": "DescribeHBaseTableRequestMetric", "description": "Hbase的表粒度读取和写入速率", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-lvr4kbpk" }, { "name": "TableName", "type": "string", "required": true, "description": "Hbase表名", "example": "hbase_meta" }, { "name": "RegionServer", "type": "string", "required": false, "description": "Hbase的RegionServer服务", "example": "127.0.0.1:6003" }, { "name": "Downsample", "type": "string", "required": false, "description": "获取监控的数据粒度", "example": "5m" }, { "name": "StartTime", "type": "integer", "required": false, "description": "查询监控数据起始时间戳", "example": "1764826199" }, { "name": "EndTime", "type": "integer", "required": false, "description": "查询监控数据结束时间戳", "example": "1764828199" } ], "required": [ "InstanceId", "TableName" ] }, { "name": "DescribeHBaseTableStoreSizeMetric", "description": "查询Hbase的表粒度StoreSize大小监控指标数据", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-lvr4kbpk" }, { "name": "TableName", "type": "string", "required": true, "description": "Hbase表名", "example": "hbase_meta" }, { "name": "RegionServer", "type": "string", "required": false, "description": "Hbase的RegionServer服务", "example": "127.0.0.1:6003" }, { "name": "Downsample", "type": "string", "required": false, "description": "获取监控的数据粒度", "example": "5m" }, { "name": "StartTime", "type": "integer", "required": false, "description": "查询监控数据起始时间戳", "example": "1764826199" }, { "name": "EndTime", "type": "integer", "required": false, "description": "查询监控数据结束时间戳", "example": "1764828199" } ], "required": [ "InstanceId", "TableName" ] }, { "name": "DescribeHDFSStorageInfo", "description": "查询HDFS存储文件信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "emr-xfaf11ab" }, { "name": "StartTime", "type": "integer", "required": true, "description": "获取查询信息开始时间 (s)", "example": "161222341" }, { "name": "EndTime", "type": "integer", "required": true, "description": "获取查询信息结束时间 (s)", "example": "161222341" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeHiveQueries", "description": "获取hive查询信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-9kd5tnmq" }, { "name": "StartTime", "type": "integer", "required": true, "description": "起始时间秒", "example": "1621570097" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间秒，EndTime-StartTime不得超过1天秒数86400", "example": "1621590097" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页起始偏移，从0开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小，合法范围[1,100]", "example": "20" }, { "name": "State", "type": "array", "required": false, "description": "执行状态,ERROR等", "example": "[\"FINISHED\",\"ERROR\"]", "item_type": "string" }, { "name": "EndTimeGte", "type": "integer", "required": false, "description": "结束时间大于的时间点", "example": "1621570097" }, { "name": "EndTimeLte", "type": "integer", "required": false, "description": "结束时间小于时间点", "example": "1621570097" } ], "required": [ "InstanceId", "StartTime", "EndTime", "Offset", "Limit" ] }, { "name": "DescribeImpalaQueries", "description": "DescribeImpalaQueries", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-a9871cxr" }, { "name": "StartTime", "type": "integer", "required": true, "description": "起始时间秒", "example": "1686101465" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间秒，EndTime-StartTime不得超过1天秒数86400", "example": "1686201465" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页起始偏移，从0开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小，合法范围[1,100]", "example": "20" }, { "name": "State", "type": "array", "required": false, "description": "执行状态，CREATED、INITIALIZED、COMPILED、RUNNING、FINISHED、EXCEPTION", "example": "[\"RUNNING\",\"COMPILED\"]", "item_type": "string" }, { "name": "EndTimeGte", "type": "integer", "required": false, "description": "结束时间大于的时间点", "example": "1686101465" }, { "name": "EndTimeLte", "type": "integer", "required": false, "description": "结束时间小于的时间点", "example": "1686101465" } ], "required": [ "InstanceId", "StartTime", "EndTime", "Offset", "Limit" ] }, { "name": "DescribeInsightList", "description": "获取洞察结果信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-xfaf11ab" }, { "name": "StartTime", "type": "integer", "required": true, "description": "获取的洞察结果开始时间，此时间针对对App或者Hive查询的开始时间的过滤", "example": "161222341" }, { "name": "EndTime", "type": "integer", "required": true, "description": "获取的洞察结果结束时间，此时间针对对App或者Hive查询的开始时间的过滤", "example": "171213123" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页查询时的分页大小，最小1，最大100", "example": "100" }, { "name": "Page", "type": "integer", "required": true, "description": "分页查询时的页号，从1开始", "example": "1" }, { "name": "Type", "type": "string", "required": false, "description": "查询类型,支持HIVE,SPARK,DLC_SPARK,SPARK_SQL,SCHEDULE,MAPREDUCE,TRINO等类型,默认查询全部", "example": "HIVE" }, { "name": "MustHasContext", "type": "boolean", "required": false, "description": "是否包含具体参数建议等信息", "example": "false" } ], "required": [ "InstanceId", "StartTime", "EndTime", "PageSize", "Page" ] }, { "name": "DescribeInspectionTaskResult", "description": "获取巡检任务结果列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "emr-mwyixwxp" }, { "name": "Type", "type": "string", "required": false, "description": "类型", "example": "RealTime" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间", "example": "1742110677" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间", "example": "1744702682" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceOplog", "description": "获取实例操作日志", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "EMR实例ID", "example": "emr-0sfuq468" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "页大小", "example": "1" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开头时间时间戳", "example": "1708505169" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结尾时间时间戳", "example": "1708505169" }, { "name": "SearchFields", "type": "array", "required": false, "description": "搜索项数组", "example": "[{SearchType: \"operation\", SearchValue: \"缩容|扩容\"}]", "item_type": "object", "children": [ { "name": "SearchType", "type": "string", "required": true, "description": "支持搜索的类型", "example": "ipv4" }, { "name": "SearchValue", "type": "string", "required": true, "description": "支持搜索的值", "example": "127.0.0.1" } ] }, { "name": "Operand", "type": "string", "required": false, "description": "集群、节点、组件", "example": "集群" }, { "name": "SecurityLevel", "type": "string", "required": false, "description": "一般、危险、高危", "example": "一般" } ], "required": [ "InstanceId", "Offset", "Limit" ] }, { "name": "DescribeInstanceRenewNodes", "description": "查询待续费节点信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID,实例ID形如: emr-xxxxxxxx", "example": "emr-6deluvd4" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstances", "description": "查询集群实例信息", "status": "online", "parameters": [ { "name": "DisplayStrategy", "type": "string", "required": true, "description": "集群筛选策略。取值范围： clusterList：表示查询除了已销毁集群之外的集群列表。 monitorManage：表示查询除了已销毁、创建中以及创建失败的集群之外的集群列表。 cloudHardwareManage/componentManage：目前这两个取值为预留取值，暂时和monitorManage表示同样的含义。", "example": "clusterList" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "按照一个或者多个实例ID查询。实例ID形如: emr-xxxxxxxx 。(此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的 Ids.N 一节)。如果不填写实例ID，返回该APPID下所有实例列表。", "example": "[\"emr-p9f700x8\\r\\n\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "页编号，默认值为0，表示第一页。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页返回数量，默认值为100，最大值为100。", "example": "10" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "建议必填-1，表示拉取所有项目下的集群。 不填默认值为0，表示拉取默认项目下的集群。 实例所属项目ID。该参数可以通过调用 [DescribeProjects](https://cloud.tencent.com/document/product/651/78725) 的返回值中的 projectId 字段来获取。", "example": "0" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。取值范围： clusterId：表示按照实例ID排序。 addTime：表示按照实例创建时间排序。 status：表示按照实例的状态码排序。", "example": "clusterid" }, { "name": "Asc", "type": "integer", "required": false, "description": "按照OrderField升序或者降序进行排序。取值范围： 0：表示降序。 1：表示升序。默认值为0。", "example": "0" } ], "required": [ "DisplayStrategy" ] }, { "name": "DescribeInstancesList", "description": "查询集群列表", "status": "online", "parameters": [ { "name": "DisplayStrategy", "type": "string", "required": true, "description": "集群筛选策略。取值范围：clusterList：表示查询除了已销毁集群之外的集群列表。monitorManage：表示查询除了已销毁、创建中以及创建失败的集群之外的集群列表。cloudHardwareManage/componentManage：目前这两个取值为预留取值，暂时和monitorManage表示同样的含义。", "example": "clusterList" }, { "name": "Offset", "type": "integer", "required": false, "description": "页编号，默认值为0，表示第一页。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页返回数量，默认值为100，最大值为100。 如果limit和offset都为0，则查询全部记录；", "example": "10" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。取值范围：clusterId：表示按照实例ID排序。addTime：表示按照实例创建时间排序。status：表示按照实例的状态码排序。", "example": "clusterid" }, { "name": "Asc", "type": "integer", "required": false, "description": "按照OrderField升序或者降序进行排序。取值范围：0：表示升序。1：表示降序。默认值为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "自定义查询过滤器。示例：根据ClusterId过滤实例：[{\"Name\":\"ClusterId\",\"Values\":[\"emr-xxxxxxxx\"]}]根据clusterName过滤实例：[{\"Name\": \"ClusterName\",\"Values\": [\"cluster_name\"]}]根据ClusterStatus过滤实例：[{\"Name\": \"ClusterStatus\",\"Values\": [\"2\"]}]", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "ComponentNames" }, { "name": "Values", "type": "array", "required": true, "description": "过滤字段值", "example": "[\"Presto-Coordinator\"]}]", "item_type": "string" } ] }, { "name": "ClusterType", "type": "integer", "required": false, "description": "默认0为普通集群，2为tke集群", "example": "0" } ], "required": [ "DisplayStrategy" ] }, { "name": "DescribeJobFlow", "description": "查询流程任务", "status": "online", "parameters": [ { "name": "JobFlowId", "type": "integer", "required": true, "description": "流程任务Id，RunJobFlow接口返回的值。", "example": "1" } ], "required": [ "JobFlowId" ] }, { "name": "DescribeKyuubiQueryInfo", "description": "查询Kyuubi查询信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-xfaf11ab" }, { "name": "StartTime", "type": "integer", "required": true, "description": "获取查询信息开始时间 (s)", "example": "161222341" }, { "name": "EndTime", "type": "integer", "required": true, "description": "获取查询信息结束时间 (s)", "example": "171213123" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页查询时的分页大小，最小1，最大100", "example": "100" }, { "name": "Page", "type": "integer", "required": true, "description": "分页查询时的页号，从1开始", "example": "1" } ], "required": [ "InstanceId", "StartTime", "EndTime", "PageSize", "Page" ] }, { "name": "DescribeNodeDataDisks", "description": "查询节点数据盘信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "EMR集群实例ID", "example": "emr-xxx" }, { "name": "CvmInstanceIds", "type": "array", "required": true, "description": "节点CVM实例Id列表", "example": "[\"ins-xxx\",\"inx-xxx\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "查询云盘的过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "ComponentNames" }, { "name": "Values", "type": "array", "required": true, "description": "过滤字段值", "example": "[\"Presto-Coordinator\"]}]", "item_type": "string" } ] }, { "name": "InnerSearch", "type": "string", "required": false, "description": "模糊搜索", "example": "test1" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页返回数量，默认值为100，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移值", "example": "0" }, { "name": "Scene", "type": "string", "required": false, "description": "场景值： ModifyDiskExtraPerformance ：调整数据盘额外性能", "example": "ModifyDiskExtraPerformance" } ], "required": [ "InstanceId", "CvmInstanceIds" ] }, { "name": "DescribeNodeResourceConfigFast", "description": "快速获取当前集群的节点规格配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例Id", "example": "emr-sdaf1a" }, { "name": "ResourceType", "type": "string", "required": true, "description": "节点类型 CORE TASK ROUTER ALL", "example": "CORE" }, { "name": "PayMode", "type": "integer", "required": true, "description": "计费类型", "example": "0" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "可用区ID", "example": "100002" }, { "name": "ResourceBaseType", "type": "string", "required": false, "description": "类型为ComputeResource和EMR以及默认，默认为EMR", "example": "ComputeResource" }, { "name": "ComputeResourceId", "type": "string", "required": false, "description": "计算资源id", "example": "emr-cr-xxxxx" }, { "name": "HardwareResourceType", "type": "string", "required": false, "description": "硬件类型", "example": "HOST" } ], "required": [ "InstanceId", "ResourceType", "PayMode" ] }, { "name": "DescribeNodeSpec", "description": "查询节点规格", "status": "online", "parameters": [ { "name": "ZoneId", "type": "integer", "required": true, "description": "可用区Id，可以通过https://document.capi.woa.com/document/api/1605/76892查询相关信息", "example": "100003" }, { "name": "CvmPayMode", "type": "integer", "required": true, "description": "0,按量，1包年包月，99按量+包年包月，错填将不会展示费用信息", "example": "1" }, { "name": "NodeType", "type": "string", "required": true, "description": "节点类型,Master,Core,Task,Router,All", "example": "All" }, { "name": "TradeType", "type": "integer", "required": true, "description": "0:旧计费页面,1:新计费页面。 错填，默认为旧计费", "example": "1" }, { "name": "ProductId", "type": "integer", "required": true, "description": "产品Id，不填为0，则表示所有productId，前台使用必填 44 EMR V3.5.0 43 EMR V3.4.0.tlinux 42 EMR V2.7.0.tlinux 41 DRUID V1.1.0 67 STARROCKS V2.2.0 45 DRUID V1.1.0.tlinux 40 EMRCLOUD v3.2.0 47 EMR V4.0.0 48 STARROCKS V1.2.0 49 STARROCKS V1.3.0 50 KAFKA V2.0.0 51 STARROCKS V1.4.0 52 EMR-TKE V1.0.0 53 EMR V3.6.0 54 STARROCKS V2.0.0 55 EMR-TKE V1.0.1 56 EMR-TKE DLCV1.0.0 57 EMR V2.8.0 58 EMR V3.6.1 59 SERVERLESS V1.0.0 60 EMR-TKE V1.1.0 62 STARROCKS V2.1.1 63 STARROCKS V2.1.1.tlinux 6...", "example": "20" }, { "name": "SceneName", "type": "string", "required": true, "description": "场景名", "example": "HADOOP-Hbase" }, { "name": "ResourceBaseType", "type": "string", "required": false, "description": "类型为ComputeResource和EMR以及默认，默认为EMR", "example": "ComputeResource" }, { "name": "ComputeResourceId", "type": "string", "required": false, "description": "计算资源id", "example": "emr-cr-xxxxx" } ], "required": [ "ZoneId", "CvmPayMode", "NodeType", "TradeType", "ProductId", "SceneName" ] }, { "name": "DescribeResourceSchedule", "description": "查询YARN资源调度数据信息。已废弃，请使用`DescribeYarnQueue`去查询队列信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "emr集群的英文id", "example": "emr-2xef56" } ], "required": [ "InstanceId" ] }, { "name": "DescribeResourceScheduleDiffDetail", "description": "YARN资源调度-变更详情", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "emr集群的英文id", "example": "emr-2xef56" }, { "name": "Scheduler", "type": "string", "required": false, "description": "查询的变更明细对应的调度器，可选值为fair、capacity。如果不传或者传空会使用最新的调度器", "example": "fair" } ], "required": [ "InstanceId" ] }, { "name": "DescribeSLInstance", "description": "本接口（DescribeSLInstance）用于查询 Serverless HBase实例基本信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例唯一标识符（字符串表示）", "example": "emr-xxxxxxxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeSLInstanceList", "description": "本接口（DescribeSLInstanceList）用于查询Serverless HBase实例列表详细信息", "status": "online", "parameters": [ { "name": "DisplayStrategy", "type": "string", "required": true, "description": "实例筛选策略。取值范围：clusterList：表示查询除了已销毁实例之外的实例列表。monitorManage：表示查询除了已销毁、创建中以及创建失败的实例之外的实例列表。", "example": "clusterList" }, { "name": "Offset", "type": "integer", "required": false, "description": "页编号，默认值为0，表示第一页。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页返回数量，默认值为10，最大值为100。", "example": "10" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。取值范围：clusterId：表示按照实例ID排序。addTime：表示按照实例创建时间排序。status：表示按照实例的状态码排序。", "example": "clusterid" }, { "name": "Asc", "type": "integer", "required": false, "description": "按照OrderField升序或者降序进行排序。取值范围：0：表示升序。1：表示降序。默认值为0。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "自定义查询过滤器。示例：根据ClusterId过滤实例：[{\"Name\":\"ClusterId\",\"Values\":[\"emr-xxxxxxxx\"]}]根据clusterName过滤实例：[{\"Name\": \"ClusterName\",\"Values\": [\"cluster_name\"]}]根据ClusterStatus过滤实例：[{\"Name\": \"ClusterStatus\",\"Values\": [\"2\"]}]", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "ComponentNames" }, { "name": "Values", "type": "array", "required": true, "description": "过滤字段值", "example": "[\"Presto-Coordinator\"]}]", "item_type": "string" } ] } ], "required": [ "DisplayStrategy" ] }, { "name": "DescribeServiceConfGroupInfos", "description": "描述服务配置组信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "emr-cp4f67tz" }, { "name": "ServiceName", "type": "string", "required": true, "description": "组件名", "example": "HDFS" }, { "name": "ConfGroupName", "type": "string", "required": true, "description": "配置组名称", "example": "hdfs-core-defaultGroup" }, { "name": "PageNo", "type": "integer", "required": true, "description": "页码，从1开始", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "页大小", "example": "10" } ], "required": [ "InstanceId", "ServiceName", "ConfGroupName", "PageNo", "PageSize" ] }, { "name": "DescribeServiceNodeInfos", "description": "查询服务进程信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "emr-3qg9lptu" }, { "name": "Offset", "type": "integer", "required": false, "description": "页码", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "页大小", "example": "10" }, { "name": "SearchText", "type": "string", "required": false, "description": "搜索字段", "example": "null" }, { "name": "ConfStatus", "type": "integer", "required": false, "description": "'配置状态，-2：配置失败，-1:配置过期，1：已同步', -99 '全部'", "example": "-99" }, { "name": "MaintainStateId", "type": "integer", "required": false, "description": "过滤条件：维护状态 0代表所有状态 1代表正常模式 2代表维护模式", "example": "0" }, { "name": "OperatorStateId", "type": "integer", "required": false, "description": "过滤条件：操作状态 0代表所有状态 1代表已启动 2代表已停止", "example": "0" }, { "name": "HealthStateId", "type": "string", "required": false, "description": "过滤条件：健康状态 \"0\"代表不可用 \"1\"代表良好 \"-2\"代表未知 \"-99\"代表所有 \"-3\"代表存在隐患 \"-4\"代表未探测", "example": "\"0\"" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务组件名称应采用全大写形式（例如：YARN），api调用时须与 ServiceGroupType 在两者之中任选其一并保证必填。", "example": "\"YARN\"" }, { "name": "NodeTypeName", "type": "string", "required": false, "description": "节点名称master,core,task,common,router", "example": "\"master\"" }, { "name": "DataNodeMaintenanceId", "type": "integer", "required": false, "description": "过滤条件：dn是否处于维护状态 0代表所有状态 1代表处于维护状态", "example": "1" }, { "name": "SearchFields", "type": "array", "required": false, "description": "支持搜索的字段，目前支持 SearchType ：ipv4", "example": "无", "item_type": "object", "children": [ { "name": "SearchType", "type": "string", "required": true, "description": "支持搜索的类型", "example": "ipv4" }, { "name": "SearchValue", "type": "string", "required": true, "description": "支持搜索的值", "example": "127.0.0.1" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeSparkApplications", "description": "获取spark应用列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "emr-xxxx" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询开始时间", "example": "1746498971" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询结束时间", "example": "1746498972" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每一页条数", "example": "100" }, { "name": "Page", "type": "integer", "required": true, "description": "第几页", "example": "1" } ], "required": [ "InstanceId", "StartTime", "EndTime", "PageSize", "Page" ] }, { "name": "DescribeSparkQueries", "description": "查询Spark查询信息列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-a9871cxr" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间", "example": "1712505600" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间", "example": "1712591999" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页起始偏移，从0开始", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小，合法范围[1,100]", "example": "20" }, { "name": "Status", "type": "array", "required": false, "description": "执行状态:RUNNING,COMPLETED,FAILED", "example": "[\"RUNNING\",\"COMPLETED\"]", "item_type": "string" } ], "required": [ "InstanceId", "StartTime", "EndTime", "Offset", "Limit" ] }, { "name": "DescribeStarRocksQueryInfo", "description": "查询StarRocks查询信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-xfaf11ab" }, { "name": "StartTime", "type": "integer", "required": true, "description": "获取查询信息开始时间 (s)", "example": "161222341" }, { "name": "EndTime", "type": "integer", "required": true, "description": "获取查询信息结束时间 (s)", "example": "171213123" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页查询时的分页大小，最小1，最大100", "example": "100" }, { "name": "Page", "type": "integer", "required": true, "description": "分页查询时的页号，从1开始", "example": "1" } ], "required": [ "InstanceId", "StartTime", "EndTime", "PageSize", "Page" ] }, { "name": "DescribeTrinoQueryInfo", "description": "查询Trino(PrestoSQL)查询信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-xfaf11ab" }, { "name": "StartTime", "type": "integer", "required": true, "description": "获取查询信息开始时间 (s)", "example": "161222341" }, { "name": "EndTime", "type": "integer", "required": true, "description": "获取查询信息结束时间 (s)", "example": "171213123" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页查询时的分页大小，最小1，最大100", "example": "100" }, { "name": "Page", "type": "integer", "required": true, "description": "分页查询时的页号，从1开始", "example": "1" } ], "required": [ "InstanceId", "StartTime", "EndTime", "PageSize", "Page" ] }, { "name": "DescribeUsersForUserManager", "description": "该接口支持安装了OpenLdap组件的集群。 批量导出用户。对于kerberos集群，如果需要kertab文件下载地址，可以将NeedKeytabInfo设置为true；注意SupportDownLoadKeyTab为true，但是DownLoadKeyTabUrl为空字符串，表示keytab文件在后台没有准备好（正在生成）。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID", "example": "emr-xxx" }, { "name": "PageNo", "type": "integer", "required": true, "description": "页码", "example": "0" }, { "name": "PageSize", "type": "integer", "required": true, "description": "分页的大小。 默认查询全部；PageNo和PageSize不合理的设置，都是查询全部", "example": "10" }, { "name": "UserManagerFilter", "type": "object", "required": false, "description": "查询用户列表过滤器", "example": "无", "children": [ { "name": "UserName", "type": "string", "required": false, "description": "用户名", "example": "emr" }, { "name": "UserType", "type": "string", "required": false, "description": "用户来源", "example": "自定义" }, { "name": "Groups", "type": "string", "required": false, "description": "组名", "example": "组名" } ] }, { "name": "NeedKeytabInfo", "type": "boolean", "required": false, "description": "是否需要keytab文件的信息，仅对开启kerberos的集群有效，默认为false", "example": "true" } ], "required": [ "InstanceId", "PageNo", "PageSize" ] }, { "name": "DescribeYarnApplications", "description": "DescribeYarnApplications", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-xfyags1d" }, { "name": "StartTime", "type": "integer", "required": true, "description": "起始时间秒", "example": "1686029737" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间秒，EndTime-StartTime不得超过1天秒数86400", "example": "1686129737" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页；如果limit=100，Offset=1，则表示第二页，数据第101条开始查询，返回100条数据；如果limit=100，Offset=2，则表示第三页，数据第201条开始查询，返回100条数据。依次类推", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小，合法范围[1,100]", "example": "20" } ], "required": [ "InstanceId", "StartTime", "EndTime", "Offset", "Limit" ] }, { "name": "DescribeYarnQueue", "description": "获取资源调度中的队列信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群Id", "example": "emr-xxx" }, { "name": "Scheduler", "type": "string", "required": true, "description": "调度器，可选值： 1. capacity 2. fair", "example": "capacity" } ], "required": [ "InstanceId", "Scheduler" ] }, { "name": "DescribeYarnScheduleHistory", "description": "查看yarn资源调度的调度历史。废弃，请使用流程中心查看历史记录。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "emr-2xef56" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间", "example": "1722873600" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间", "example": "1722873600" }, { "name": "Limit", "type": "integer", "required": false, "description": "页码", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "页大小", "example": "10" }, { "name": "SchedulerType", "type": "string", "required": false, "description": "调度器类型 可选值为“ALL”，\"Capacity Scheduler\", \"Fair Scheduler\"", "example": "Capacity Scheduler" }, { "name": "TaskState", "type": "integer", "required": false, "description": "任务类型0:等待执行，1:执行中，2：完成，-1:失败 ，-99:全部", "example": "2" } ], "required": [ "InstanceId" ] }, { "name": "InquirePriceRenewEmr", "description": "集群续费询价。", "status": "online", "parameters": [ { "name": "TimeSpan", "type": "integer", "required": true, "description": "实例续费的时长。需要结合TimeUnit一起使用。1表示续费一个月", "example": "1" }, { "name": "InstanceId", "type": "string", "required": true, "description": "待续费集群ID列表。", "example": "emr-vm-jv1s4" }, { "name": "Placement", "type": "object", "required": true, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区，例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "PayMode", "type": "integer", "required": true, "description": "实例计费模式。此处只支持取值为1，表示包年包月。", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "实例续费的时间单位。取值范围： m：表示月份。", "example": "m" }, { "name": "Currency", "type": "string", "required": false, "description": "货币种类。取值范围： CNY：表示人民币。", "example": "CNY" } ], "required": [ "TimeSpan", "InstanceId", "Placement", "PayMode" ] }, { "name": "InquiryPriceCreateInstance", "description": "创建实例询价", "status": "online", "parameters": [ { "name": "TimeUnit", "type": "string", "required": true, "description": "购买实例的时间单位。取值范围： s：表示秒。PayMode取值为0时，TimeUnit只能取值为s。 m：表示月份。PayMode取值为1时，TimeUnit只能取值为m。", "example": "s" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "购买实例的时长。结合TimeUnit一起使用。 TimeUnit为s时，该参数只能填写3600，表示按量计费实例。 TimeUnit为m时，该参数填写的数字表示包年包月实例的购买时长，如1表示购买一个月", "example": "3600" }, { "name": "Currency", "type": "string", "required": true, "description": "货币种类。取值范围： CNY：表示人民币。", "example": "CNY" }, { "name": "PayMode", "type": "integer", "required": true, "description": "实例计费模式。取值范围： 0：表示按量计费。 1：表示包年包月。", "example": "0" }, { "name": "SupportHA", "type": "integer", "required": true, "description": "是否开启节点高可用。取值范围： 0：表示不开启节点高可用。 1：表示开启节点高可用。\u0007", "example": "0" }, { "name": "Software", "type": "array", "required": true, "description": "部署的组件列表。不同的EMR产品ID（ProductId：具体含义参考入参ProductId字段）需要选择不同的必选组件：ProductId为2(EMR-V2.0.1)的时候，必选组件包括：hdfs-2.7.3,yarn-2.7.3,zookeeper-3.4.9,knox-1.2.0ProductId为16(EMR-V2.3.0)的时候，必选组件包括：hdfs-2.8.5,yarn-2.8.5,zookeeper-3.5.5,knox-1.2.0ProductId为20(EMR-V2.5.0)的时候，必选组件包括：hdfs-2.8.5,yarn-2.8.5,zookeeper-3.6.1,knox-1.2.0ProductId为30(EMR-V2.6.0)的时候，必\ufffd\ufffd...", "example": "[\"hdfs-2.7.3\"]", "item_type": "string" }, { "name": "ResourceSpec", "type": "object", "required": false, "description": "询价的节点规格。", "example": "无", "children": [ { "name": "MasterResourceSpec", "type": "object", "required": false, "description": "描述Master节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "云盘类型 CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "CLOUD_SSD" }, { "name": "Volume", "type": "integer", "required": false, "description": "云盘大小", "example": "20000" }, { "name": "Count", "type": "integer", "required": false, "description": "该类型云盘个数", "example": "1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "CoreResourceSpec", "type": "object", "required": false, "description": "描述Core节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "云盘类型 CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "CLOUD_SSD" }, { "name": "Volume", "type": "integer", "required": false, "description": "云盘大小", "example": "20000" }, { "name": "Count", "type": "integer", "required": false, "description": "该类型云盘个数", "example": "1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "TaskResourceSpec", "type": "object", "required": false, "description": "描述Task节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "云盘类型 CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "CLOUD_SSD" }, { "name": "Volume", "type": "integer", "required": false, "description": "云盘大小", "example": "20000" }, { "name": "Count", "type": "integer", "required": false, "description": "该类型云盘个数", "example": "1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "MasterCount", "type": "integer", "required": false, "description": "Master节点数量", "example": "2" }, { "name": "CoreCount", "type": "integer", "required": false, "description": "Core节点数量", "example": "3" }, { "name": "TaskCount", "type": "integer", "required": false, "description": "Task节点数量", "example": "0" }, { "name": "CommonResourceSpec", "type": "object", "required": false, "description": "描述Common节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "云盘类型 CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "CLOUD_SSD" }, { "name": "Volume", "type": "integer", "required": false, "description": "云盘大小", "example": "20000" }, { "name": "Count", "type": "integer", "required": false, "description": "该类型云盘个数", "example": "1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "CommonCount", "type": "integer", "required": false, "description": "Common节点数量", "example": "3" } ] }, { "name": "Placement", "type": "object", "required": false, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区，例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "VPCSettings", "type": "object", "required": false, "description": "私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC ID", "example": "vpc-xxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "Subnet ID", "example": "subnet-xxxxx" } ] }, { "name": "MetaType", "type": "string", "required": false, "description": "hive共享元数据库类型。取值范围： EMR_NEW_META：表示集群默认创建 EMR_EXIT_METE：表示集群使用指定EMR-MetaDB。 USER_CUSTOM_META：表示集群使用自定义MetaDB。", "example": "EMR_NEW_META" }, { "name": "UnifyMetaInstanceId", "type": "string", "required": false, "description": "EMR-MetaDB实例", "example": "cdb-xxx" }, { "name": "MetaDBInfo", "type": "object", "required": false, "description": "自定义MetaDB信息", "example": "无", "children": [ { "name": "MetaDataJdbcUrl", "type": "string", "required": false, "description": "自定义MetaDB的JDBC连接，请以 jdbc:mysql:// 开头", "example": "jdbc:mysql://ip:port/hive" }, { "name": "MetaDataUser", "type": "string", "required": false, "description": "自定义MetaDB用户名", "example": "userName" }, { "name": "MetaDataPass", "type": "string", "required": false, "description": "自定义MetaDB密码", "example": "pwd" } ] }, { "name": "ProductId", "type": "integer", "required": false, "description": "产品ID，不同产品ID表示不同的EMR产品版本。取值范围：2：表示EMR-V2.0.116：表示EMR-V2.3.020：表示EMR-V2.5.030：表示EMR-V2.6.038：表示EMR-V2.7.057：表示EMR-V2.8.07：表示EMR-V3.0.025：表示EMR-V3.1.031：表示EMR-V3.1.128：表示EMR-V3.2.033：表示EMR-V3.2.134：表示EMR-V3.3.037：表示EMR-V3.4.044：表示EMR-V3.5.053：表示EMR-V3.6.058：表示EMR-V3.6.147：表示EMR-V4.0.0", "example": "47" }, { "name": "SceneName", "type": "string", "required": false, "description": "场景化取值：Hadoop-Kudu，Hadoop-Zookeeper，Hadoop-Presto，Hadoop-Hbase", "example": "Hadoop-Hbase" }, { "name": "ExternalService", "type": "array", "required": false, "description": "共用组件信息", "example": "无", "item_type": "object", "children": [ { "name": "ShareType", "type": "string", "required": true, "description": "共用组件类型，EMR/CUSTOM", "example": "EMR" }, { "name": "Service", "type": "string", "required": true, "description": "共用组件名", "example": "zookeeper" }, { "name": "InstanceId", "type": "string", "required": true, "description": "共用组件集群", "example": "emr-123" }, { "name": "CustomServiceDefineList", "type": "array", "required": true, "description": "自定义参数集合", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "自定义参数key", "example": "zookeeper.quorum" }, { "name": "Value", "type": "string", "required": false, "description": "自定义参数value", "example": "1.1.1.1" } ] } ] }, { "name": "VersionID", "type": "integer", "required": false, "description": "当前默认值为0，跨AZ特性支持后为1", "example": "0" }, { "name": "MultiZoneSettings", "type": "array", "required": false, "description": "可用区的规格信息", "example": "无", "item_type": "object", "children": [ { "name": "ZoneTag", "type": "string", "required": false, "description": "\"master\"、\"standby\"、\"third-party\"", "example": "\"master\"" }, { "name": "VPCSettings", "type": "object", "required": false, "description": "无", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC ID", "example": "vpc-xxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "Subnet ID", "example": "subnet-xxxxx" } ] }, { "name": "Placement", "type": "object", "required": false, "description": "无", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区，例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "ResourceSpec", "type": "object", "required": false, "description": "无", "example": "无", "children": [ { "name": "MasterResourceSpec", "type": "object", "required": false, "description": "描述Master节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "CoreResourceSpec", "type": "object", "required": false, "description": "描述Core节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "TaskResourceSpec", "type": "object", "required": false, "description": "描述Task节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "MasterCount", "type": "integer", "required": false, "description": "Master节点数量", "example": "2" }, { "name": "CoreCount", "type": "integer", "required": false, "description": "Core节点数量", "example": "3" }, { "name": "TaskCount", "type": "integer", "required": false, "description": "Task节点数量", "example": "0" }, { "name": "CommonResourceSpec", "type": "object", "required": false, "description": "描述Common节点资源", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "节点规格描述，如CVM.SA2。", "example": "CVM.SA2" }, { "name": "StorageType", "type": "integer", "required": true, "description": "取值范围: \"LOCAL_SSD\" 3 //本地SSD \"CLOUD_SSD\" 4 //云SSD \"CLOUD_PREMIUM\" 5 //高效云盘 \"CLOUD_HSSD\" 6 //增强型SSD云硬盘 \"CLOUD_THROUGHPUT\" 11//吞吐型云硬盘 \"CLOUD_TSSD\" 12 //极速型SSD云硬盘 \"CLOUD_BSSD\" 13 //通用型SSD云硬盘 \"CLOUD_BIGDATA\" 14 //大数据型云硬盘 \"CLOUD_HIGHIO\" 15 //高IO型云硬盘 该类型字段为无效字段，实际系统盘类型会根据数据盘类型和节点类型判断，如果节点支持所选的数据盘类型，系统盘类型...", "example": "5" }, { "name": "DiskType", "type": "string", "required": true, "description": "数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示极速型SSD云硬盘。 CLOUD_BIGDATA：表示大数据型云硬盘。 CLOUD_HIGHIO：表示高IO型云硬盘。 CLOUD_BSSD：表示通用型SSD云硬盘。 REMOTE_SSD：表示远端SSD盘。", "example": "LOUD_PREMIUM" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量,单位为M", "example": "131072" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数", "example": "2" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘容量", "example": "300" }, { "name": "RootSize", "type": "integer", "required": false, "description": "系统盘容量", "example": "0" }, { "name": "MultiDisks", "type": "array", "required": false, "description": "云盘列表，当数据盘为一块云盘时，直接使用DiskType和DiskSize参数，超出部分使用MultiDisks 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": false, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "LocalDiskNum", "type": "integer", "required": false, "description": "本地盘数量，该字段已废弃", "example": "1" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "本地盘数量，如2", "example": "2" }, { "name": "GpuDesc", "type": "string", "required": false, "description": "GPU信息", "example": "1 * NVIDIA T4" } ] }, { "name": "CommonCount", "type": "integer", "required": false, "description": "Common节点数量", "example": "3" } ] } ] }, { "name": "DefaultMetaVersion", "type": "string", "required": false, "description": "数据库版本", "example": "mysql8" }, { "name": "NeedCdbAudit", "type": "integer", "required": false, "description": "0:不开通审计；1:开通审计", "example": "0" } ], "required": [ "TimeUnit", "TimeSpan", "Currency", "PayMode", "SupportHA", "Software" ] }, { "name": "InquiryPriceRenewInstance", "description": "续费询价。", "status": "online", "parameters": [ { "name": "TimeSpan", "type": "integer", "required": true, "description": "实例续费的时长。需要结合TimeUnit一起使用。1表示续费一个月", "example": "1" }, { "name": "PayMode", "type": "integer", "required": true, "description": "实例计费模式。此处只支持取值为1，表示包年包月。", "example": "1" }, { "name": "ResourceIds", "type": "array", "required": false, "description": "待续费节点的资源ID列表。资源ID形如：emr-vm-xxxxxxxx。有效的资源ID可通过登录[控制台](https://console.cloud.tencent.com/emr)查询。", "example": "[\"emr-vm-jv1s4zas\\r\\n\"]", "item_type": "string" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "实例续费的时间单位。取值范围： m：表示月份。", "example": "m" }, { "name": "Currency", "type": "string", "required": false, "description": "货币种类。取值范围： CNY：表示人民币。", "example": "CNY" }, { "name": "Placement", "type": "object", "required": false, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区，例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "ModifyPayMode", "type": "integer", "required": false, "description": "是否按量转包年包月。0：否，1：是。", "example": "1" }, { "name": "NeedDetail", "type": "boolean", "required": false, "description": "是否需要每个节点续费价格", "example": "false" }, { "name": "InstanceId", "type": "string", "required": false, "description": "集群id，如果需要集群所有包年包月节点续费信息，可以填写该参数", "example": "emr-21adfa" } ], "required": [ "TimeSpan", "PayMode" ] }, { "name": "InquiryPriceScaleOutInstance", "description": "扩容询价. 当扩容时候，请通过该接口查询价格。", "status": "online", "parameters": [ { "name": "TimeUnit", "type": "string", "required": true, "description": "扩容的时间单位。取值范围： s：表示秒。PayMode取值为0时，TimeUnit只能取值为s。 m：表示月份。PayMode取值为1时，TimeUnit只能取值为m。", "example": "s" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "扩容的时长。结合TimeUnit一起使用。 TimeUnit为s时，该参数只能填写3600，表示按量计费实例。 TimeUnit为m时，该参数填写的数字表示包年包月实例的购买时长，如1表示购买一个月", "example": "3600" }, { "name": "ZoneId", "type": "integer", "required": true, "description": "实例所属的可用区ID，例如100003。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/213/15707) 的返回值中的ZoneId字段来获取。", "example": "100003" }, { "name": "PayMode", "type": "integer", "required": true, "description": "实例计费模式。取值范围： 0：表示按量计费。 1：表示包年包月。", "example": "0" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "emr-3ida6zmi" }, { "name": "CoreCount", "type": "integer", "required": true, "description": "扩容的Core节点数量。", "example": "1" }, { "name": "TaskCount", "type": "integer", "required": true, "description": "扩容的Task节点数量。", "example": "0" }, { "name": "Currency", "type": "string", "required": true, "description": "货币种类。取值范围： CNY：表示人民币。", "example": "CNY" }, { "name": "RouterCount", "type": "integer", "required": false, "description": "扩容的Router节点数量。", "example": "0" }, { "name": "MasterCount", "type": "integer", "required": false, "description": "扩容的Master节点数量。", "example": "0" }, { "name": "ResourceBaseType", "type": "string", "required": false, "description": "类型为ComputeResource和EMR以及默认，默认为EMR", "example": "ComputeResource" }, { "name": "ComputeResourceId", "type": "string", "required": false, "description": "计算资源id", "example": "emr-cr-xxxxx" }, { "name": "HardwareResourceType", "type": "string", "required": false, "description": "扩容资源类型", "example": "HOST" } ], "required": [ "TimeUnit", "TimeSpan", "ZoneId", "PayMode", "InstanceId", "CoreCount", "TaskCount", "Currency" ] }, { "name": "InquiryPriceUpdateInstance", "description": "变配询价", "status": "online", "parameters": [ { "name": "TimeUnit", "type": "string", "required": true, "description": "变配的时间单位。取值范围： s：表示秒。PayMode取值为0时，TimeUnit只能取值为s。 m：表示月份。PayMode取值为1时，TimeUnit只能取值为m。", "example": "s" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "变配的时长。结合TimeUnit一起使用。 TimeUnit为s时，该参数只能填写3600，表示按量计费实例。 TimeUnit为m时，该参数填写的数字表示包年包月实例的购买时长，如1表示购买一个月", "example": "3600" }, { "name": "PayMode", "type": "integer", "required": true, "description": "实例计费模式。取值范围： 0：表示按量计费。 1：表示包年包月。", "example": "0" }, { "name": "UpdateSpec", "type": "object", "required": false, "description": "节点变配的目标配置。", "example": "无", "children": [ { "name": "Memory", "type": "integer", "required": true, "description": "内存容量，单位为G", "example": "16" }, { "name": "CPUCores", "type": "integer", "required": true, "description": "CPU核数", "example": "8" }, { "name": "ResourceId", "type": "string", "required": true, "description": "机器资源ID（EMR测资源标识）", "example": "emr-vm-eqeq131" }, { "name": "InstanceType", "type": "string", "required": false, "description": "变配机器规格", "example": "S5.2XLARGE16" } ] }, { "name": "Placement", "type": "object", "required": false, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区，例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "Currency", "type": "string", "required": false, "description": "货币种类。取值范围： CNY：表示人民币。", "example": "CNY" }, { "name": "ResourceIdList", "type": "array", "required": false, "description": "批量变配资源ID列表", "example": "[\"emr-vm-xxx\"]", "item_type": "string" } ], "required": [ "TimeUnit", "TimeSpan", "PayMode" ] }, { "name": "ModifyAutoRenewFlag", "description": "前提：预付费集群 资源级别开启或关闭自动续费", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-djj13azf" }, { "name": "ResourceIds", "type": "array", "required": true, "description": "实例ID", "example": "[emr-vm-4slr7ad7,emr--vm-daa23n1]", "item_type": "string" }, { "name": "RenewFlag", "type": "string", "required": true, "description": "NOTIFY_AND_MANUAL_RENEW：表示通知即将过期，但不自动续费 NOTIFY_AND_AUTO_RENEW：表示通知即将过期，而且自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：表示不通知即将过期，也不自动续费。", "example": "NOTIFY_AND_MANUAL_RENEW" }, { "name": "ComputeResourceId", "type": "string", "required": false, "description": "计算资源id", "example": "emr-cr-xxxxxxxx" } ], "required": [ "InstanceId", "ResourceIds", "RenewFlag" ] }, { "name": "ModifyAutoScaleStrategy", "description": "修改自动扩缩容规则", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "emr-3ap64zl6" }, { "name": "StrategyType", "type": "integer", "required": true, "description": "自动扩缩容规则类型，1表示按负载指标扩缩容，2表示按时间扩缩容。", "example": "1" }, { "name": "LoadAutoScaleStrategies", "type": "array", "required": false, "description": "按负载扩缩容的指标。", "example": "无", "item_type": "object", "children": [ { "name": "StrategyId", "type": "integer", "required": false, "description": "规则ID。", "example": "1" }, { "name": "StrategyName", "type": "string", "required": false, "description": "规则名称。", "example": "name_test" }, { "name": "CalmDownTime", "type": "integer", "required": false, "description": "规则生效冷却时间。", "example": "300" }, { "name": "ScaleAction", "type": "integer", "required": false, "description": "扩缩容动作，1表示扩容，2表示缩容。", "example": "1" }, { "name": "ScaleNum", "type": "integer", "required": false, "description": "每次规则生效时的扩缩容数量。", "example": "2" }, { "name": "ProcessMethod", "type": "integer", "required": false, "description": "指标处理方法，1表示MAX，2表示MIN，3表示AVG。", "example": "1" }, { "name": "Priority", "type": "integer", "required": false, "description": "规则优先级，添加时无效，默认为自增。", "example": "1" }, { "name": "StrategyStatus", "type": "integer", "required": false, "description": "规则状态，1表示启动，3表示禁用。", "example": "1" }, { "name": "YarnNodeLabel", "type": "string", "required": false, "description": "规则扩容指定 yarn node label", "example": "label_test" }, { "name": "PeriodValid", "type": "string", "required": false, "description": "规则生效的有效时间", "example": "{\"Category\":1,\"StartDay\":\"2024-12-24\",\"EndDay\":\"2024-12-24\",\"StartTime\":\"00:00:00\",\"EndTime\":\"23:59:59\"}" }, { "name": "GraceDownFlag", "type": "boolean", "required": false, "description": "优雅缩容开关", "example": "false" }, { "name": "GraceDownTime", "type": "integer", "required": false, "description": "优雅缩容等待时间", "example": "1800" }, { "name": "GraceDownProtectFlag", "type": "boolean", "required": false, "description": "是否开启任务保护", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "绑定标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "ConfigGroupAssigned", "type": "string", "required": false, "description": "预设配置组", "example": "\"{\\\"HDFS-3.2.2\\\":-1,\\\"YARN-3.2.2\\\":-1}" }, { "name": "MeasureMethod", "type": "string", "required": false, "description": "扩容资源计算方法，\"DEFAULT\",\"INSTANCE\", \"CPU\", \"MEMORYGB\"。 \"DEFAULT\"表示默认方式，与\"INSTANCE\"意义相同。 \"INSTANCE\"表示按照节点计算，默认方式。 \"CPU\"表示按照机器的核数计算。 \"MEMORYGB\"表示按照机器内存数计算。", "example": "DEFAULT" }, { "name": "SoftDeployDesc", "type": "array", "required": false, "description": "节点部署服务列表，例如[\"HDFS-3.1.2\",\"YARN-3.1.2\"]。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"HDFS-3.1.2\",\"YARN-3.1.2\"]", "item_type": "string" }, { "name": "ServiceNodeDesc", "type": "string", "required": false, "description": "启动进程列表，例如[\"NodeManager\"]。", "example": "[\"NodeManager\"]" }, { "name": "ServiceNodeInfo", "type": "array", "required": false, "description": "启动进程列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[98]", "item_type": "integer" }, { "name": "SoftDeployInfo", "type": "array", "required": false, "description": "节点部署服务列表。部署服务仅填写HDFS、YARN。[组件名对应的映射关系表](https://cloud.tencent.com/document/product/589/98760) 注意：此字段可能返回 null，表示取不到有效值。", "example": "[98]", "item_type": "integer" }, { "name": "LoadMetricsConditions", "type": "object", "required": false, "description": "多指标触发条件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "LoadMetrics", "type": "array", "required": false, "description": "触发规则条件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "StatisticPeriod", "type": "integer", "required": false, "description": "规则统计周期，提供1min,3min,5min。", "example": "300" }, { "name": "TriggerThreshold", "type": "integer", "required": false, "description": "触发次数，当连续触发超过TriggerThreshold次后才开始扩缩容。", "example": "1" }, { "name": "LoadMetrics", "type": "string", "required": false, "description": "扩缩容负载指标。", "example": "AvailableVCores#root" }, { "name": "MetricId", "type": "integer", "required": false, "description": "规则元数据记录ID。", "example": "1" }, { "name": "Conditions", "type": "array", "required": false, "description": "触发条件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Match", "type": "integer", "required": false, "description": "0:所有条件满足 1：满足任意一个", "example": "0" } ] }, { "name": "GroupId", "type": "integer", "required": false, "description": "伸缩组Id", "example": "2" }, { "name": "Soft", "type": "string", "required": false, "description": "soft例如yarn", "example": "yarn" }, { "name": "GraceDownProtectTime", "type": "integer", "required": false, "description": "任务保护时间", "example": "60" } ] }, { "name": "TimeAutoScaleStrategies", "type": "array", "required": false, "description": "按时间扩缩容的规则。", "example": "无", "item_type": "object", "children": [ { "name": "StrategyName", "type": "string", "required": true, "description": "策略名字，集群内唯一。", "example": "dafsd" }, { "name": "IntervalTime", "type": "integer", "required": true, "description": "策略触发后的冷却时间，该段时间内，将不能触发弹性扩缩容。", "example": "300" }, { "name": "ScaleAction", "type": "integer", "required": true, "description": "扩缩容动作，1表示扩容，2表示缩容。", "example": "1" }, { "name": "ScaleNum", "type": "integer", "required": true, "description": "扩缩容数量。", "example": "20" }, { "name": "StrategyStatus", "type": "integer", "required": true, "description": "规则状态，1表示有效，2表示无效，3表示暂停。必须填写", "example": "1" }, { "name": "Priority", "type": "integer", "required": true, "description": "规则优先级，越小越高。", "example": "2" }, { "name": "RetryValidTime", "type": "integer", "required": true, "description": "当多条规则同时触发，其中某些未真正执行时，在该时间范围内，将会重试。", "example": "600" }, { "name": "RepeatStrategy", "type": "object", "required": true, "description": "时间扩缩容重复策略 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "RepeatType", "type": "string", "required": true, "description": "取值范围\"DAY\",\"DOW\",\"DOM\",\"NONE\"，分别表示按天重复、按周重复、按月重复和一次执行。必须填写", "example": "NONE" }, { "name": "DayRepeat", "type": "object", "required": false, "description": "按天重复规则，当RepeatType为\"DAY\"时有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExecuteAtTimeOfDay", "type": "string", "required": true, "description": "重复任务执行的具体时刻，例如\"01:02:00\"", "example": "10:01:00" }, { "name": "Step", "type": "integer", "required": true, "description": "每隔Step天执行一次", "example": "1" } ] }, { "name": "WeekRepeat", "type": "object", "required": false, "description": "按周重复规则，当RepeatType为\"DOW\"时有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExecuteAtTimeOfDay", "type": "string", "required": true, "description": "重复任务执行的具体时刻，例如\"01:02:00\"", "example": "11:05:00" }, { "name": "DaysOfWeek", "type": "array", "required": true, "description": "每周几的数字描述，例如，[1,3,4]表示每周周一、周三、周四。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1", "item_type": "integer" } ] }, { "name": "MonthRepeat", "type": "object", "required": false, "description": "按月重复规则，当RepeatType为\"DOM\"时有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExecuteAtTimeOfDay", "type": "string", "required": true, "description": "重复任务执行的具体时刻，例如\"01:02:00\"", "example": "15:04:05" }, { "name": "DaysOfMonthRange", "type": "array", "required": true, "description": "每月中的天数时间段描述，长度只能为2，例如[2,10]表示每月2-10号。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[1,2]", "item_type": "integer" } ] }, { "name": "NotRepeat", "type": "object", "required": false, "description": "一次执行规则，当RepeatType为\"NONE\"时有效 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExecuteAt", "type": "string", "required": true, "description": "该次任务执行的具体完整时间，格式为\"2020-07-13 00:00:00\"", "example": "2024-12-05 08:38:00" } ] }, { "name": "Expire", "type": "string", "required": false, "description": "规则过期时间，超过该时间后，规则将自动置为暂停状态，形式为\"2020-07-23 00:00:00\"。必须填写", "example": "2026-01-09 23:59:59" }, { "name": "StartTime", "type": "string", "required": false, "description": "周期性规则开始时间", "example": "2024-01-09 23:59:59" } ] }, { "name": "StrategyId", "type": "integer", "required": false, "description": "策略唯一ID。", "example": "1" }, { "name": "GraceDownFlag", "type": "boolean", "required": false, "description": "优雅缩容开关", "example": "false" }, { "name": "GraceDownTime", "type": "integer", "required": false, "description": "优雅缩容等待时间", "example": "600" }, { "name": "GraceDownProtectFlag", "type": "boolean", "required": false, "description": "是否开启任务保护", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "绑定标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "ConfigGroupAssigned", "type": "string", "required": false, "description": "预设配置组", "example": "{\\\"HDFS-3.2.2\\\":-1,\\\"TRINO-389\\\":-1,\\\"YARN-3.2.2\\\":-1}" }, { "name": "MeasureMethod", "type": "string", "required": false, "description": "扩容资源计算方法，\"DEFAULT\",\"INSTANCE\", \"CPU\", \"MEMORYGB\"。 \"DEFAULT\"表示默认方式，与\"INSTANCE\"意义相同。 \"INSTANCE\"表示按照节点计算，默认方式。 \"CPU\"表示按照机器的核数计算。 \"MEMORYGB\"表示按照机器内存数计算。", "example": "DEFAULT" }, { "name": "TerminatePolicy", "type": "string", "required": false, "description": "销毁策略, \"DEFAULT\",默认销毁策略，由缩容规则触发缩容，\"TIMING\"表示定时销毁", "example": "DEFAULT" }, { "name": "MaxUse", "type": "integer", "required": false, "description": "最长使用时间， 秒数，最短1小时，最长24小时", "example": "3600" }, { "name": "SoftDeployInfo", "type": "array", "required": false, "description": "节点部署服务列表。部署服务仅填写HDFS、YARN。[组件名对应的映射关系表](https://cloud.tencent.com/document/product/589/98760) 注意：此字段可能返回 null，表示取不到有效值。", "example": "[1,2,42]", "item_type": "integer" }, { "name": "ServiceNodeInfo", "type": "array", "required": false, "description": "启动进程列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[7,89]", "item_type": "integer" }, { "name": "CompensateFlag", "type": "integer", "required": false, "description": "补偿扩容，0表示不开启，1表示开启", "example": "0" }, { "name": "GroupId", "type": "integer", "required": false, "description": "伸缩组id", "example": "0" }, { "name": "GraceDownLabel", "type": "array", "required": false, "description": "优雅缩容业务pod标签，当node不存在上述pod或超过优雅缩容时间时，缩容节点", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "Label Name", "example": "cloud.tencent.com/node-instance-id" }, { "name": "Value", "type": "string", "required": false, "description": "Label Value", "example": "ins-0dcxficf" } ] }, { "name": "GraceDownProtectTime", "type": "integer", "required": false, "description": "任务保护时间", "example": "60" } ] }, { "name": "GroupId", "type": "integer", "required": false, "description": "伸缩组Id", "example": "2" } ], "required": [ "InstanceId", "StrategyType" ] }, { "name": "ModifyGlobalConfig", "description": "修改YARN资源调度的全局配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "emr集群的英文id", "example": "emr-2xef56" }, { "name": "Items", "type": "array", "required": true, "description": "修改的配置列表。其中Key的取值与`DescribeGlobalConfig`接口的出参一一对应，不区分大小写（如果报错找不到Key，以出参为准），分别为： 1. 开启或关闭资源调度：enableResourceSchedule；在关闭时会有一个同步的选项，Key为sync，取值为true或false。 2. 调度器类型：scheduler。 2. 开启或关闭标签：enableLabel，取值为true或false。 2. 标签目录：labelDir。 3. 是否覆盖用户指定队列：queueMappingOverr...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "健值", "example": "k" }, { "name": "Value", "type": "string", "required": true, "description": "值", "example": "v" } ] } ], "required": [ "InstanceId", "Items" ] }, { "name": "ModifyInspectionSettings", "description": "设置巡检任务配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "emr-mwyixwxp" }, { "name": "Type", "type": "string", "required": true, "description": "巡检类型，FixedTime/RealTime", "example": "RealTime" }, { "name": "Settings", "type": "array", "required": true, "description": "任务配置", "example": "[{ \"Name\": \"元数据库异常\", \"Group\": \"节点\", \"TaskType\": \"MetaDBPingFail\", \"Selected\": \"true\", \"TaskSettings\": [] }]", "item_type": "object", "children": [ { "name": "TaskType", "type": "string", "required": true, "description": "巡检任务的唯一标记", "example": "CpuIOWaitAvgMoreThanThreshold" }, { "name": "Group", "type": "string", "required": false, "description": "巡检任务组名称", "example": "节点" }, { "name": "Name", "type": "string", "required": false, "description": "巡检任务名称", "example": "CPU利用率连续高于阈值" }, { "name": "TaskSettings", "type": "array", "required": false, "description": "巡检任务参数设置", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "参数名称", "example": "阈值" }, { "name": "Value", "type": "string", "required": false, "description": "参数值", "example": "85" }, { "name": "Key", "type": "string", "required": false, "description": "参数唯一标记", "example": "Threshold" }, { "name": "Editable", "type": "string", "required": false, "description": "是否可编辑，”true\" \"false\"", "example": "true" } ] }, { "name": "Selected", "type": "string", "required": false, "description": "是否选中，”true“ ”false“", "example": "true" }, { "name": "Enable", "type": "string", "required": false, "description": "是否开启监控", "example": "true" }, { "name": "SettingsJson", "type": "string", "required": false, "description": "事件Json模板", "example": " [{ \"StrategyMeta\":{ \"type\": \"AND\" }, \"StrategyList\":[{\"metricName\":\"elapsedtime\",\"Value\":10,\"opType\":\"\u003e=\",\"id\":\"0\"}], \"StrategyLabels\":[{\"labelKey\":\"queue\",\"labelValue\":[\"root\",\"root.default\"]}] }]" } ] }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间戳", "example": "1741795200" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间戳", "example": "1741837980" }, { "name": "Strategy", "type": "string", "required": false, "description": "巡检周期，eg EveryDay EveryWeek EveryMonth", "example": "None" }, { "name": "Clock", "type": "string", "required": false, "description": "每天的开始的时间", "example": "15:04:05" }, { "name": "DayOfWeek", "type": "string", "required": false, "description": "每周的周几", "example": "1" }, { "name": "DayOfMonth", "type": "string", "required": false, "description": "每月的第几号", "example": "2" }, { "name": "JobId", "type": "string", "required": false, "description": "巡检作业Id", "example": "500" } ], "required": [ "InstanceId", "Type", "Settings" ] }, { "name": "ModifyInstanceBasic", "description": "修改集群名称", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID", "example": "emr-sfaddfda" }, { "name": "ClusterName", "type": "string", "required": true, "description": "集群名称", "example": "emr-test" }, { "name": "ResourceBaseType", "type": "string", "required": false, "description": "用来标注修改计算资源", "example": "ComputeResource" }, { "name": "ComputeResourceId", "type": "string", "required": false, "description": "需要修改的计算资源id，与ResourceBaseType 配合使用", "example": "emr-cr-xxxxx" } ], "required": [ "InstanceId", "ClusterName" ] }, { "name": "ModifyPodNum", "description": "调整Pod数量", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群Id", "example": "emr-xxxxxxxx" }, { "name": "ServiceGroup", "type": "integer", "required": true, "description": "服务编号", "example": "44" }, { "name": "ServiceType", "type": "integer", "required": false, "description": "角色编号", "example": "93" }, { "name": "PodNum", "type": "integer", "required": false, "description": "期望Pod数量", "example": "3" } ], "required": [ "InstanceId", "ServiceGroup" ] }, { "name": "ModifyResource", "description": "变配实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "emr-3ap64zl6" }, { "name": "PayMode", "type": "integer", "required": true, "description": "计费类型", "example": "0" }, { "name": "NewCpu", "type": "integer", "required": true, "description": "变配CPU", "example": "4" }, { "name": "NewMem", "type": "integer", "required": true, "description": "变配内存", "example": "32" }, { "name": "ClientToken", "type": "string", "required": false, "description": "Token", "example": "adsfadfdsddad" }, { "name": "InstanceType", "type": "string", "required": false, "description": "变配机器规格", "example": "SA2.8XLARGE128" }, { "name": "ResourceIdList", "type": "array", "required": false, "description": "节点ID列表", "example": "[\"emr-vm-xxx\",\"emr-vm-xxx\"]", "item_type": "string" } ], "required": [ "InstanceId", "PayMode", "NewCpu", "NewMem" ] }, { "name": "ModifyResourcePools", "description": "已废弃，请使用DeployYarnConf\\\\n，近一年未被调用 刷新YARN的动态资源池。已废弃，请使用`DeployYarnConf`", "status": "deprecated", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "emr集群id", "example": "emr-2xef56" }, { "name": "Key", "type": "string", "required": true, "description": "取值范围： fair:代表公平调度标识 capacity:代表容量调度标识", "example": "fair" } ], "required": [ "InstanceId", "Key" ] }, { "name": "ModifyResourceScheduleConfig", "description": "已废弃，请使用ModifyYarnQueueV2来修改队列配置，近一年无相关日志 修改YARN资源调度的资源配置。已废弃，请使用`ModifyYarnQueueV2`来修改队列配置", "status": "deprecated", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "emr集群的英文id", "example": "emr-2xef56" }, { "name": "Key", "type": "string", "required": true, "description": "业务标识，fair表示编辑公平的配置项，fairPlan表示编辑执行计划，capacity表示编辑容量的配置项", "example": "fair" }, { "name": "Value", "type": "string", "required": true, "description": "修改后的模块消息", "example": "null" } ], "required": [ "InstanceId", "Key", "Value" ] }, { "name": "ModifyResourceScheduler", "description": "修改了yarn的资源调度器，点击部署生效。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "emr集群的英文id", "example": "emr-2xef56" }, { "name": "OldValue", "type": "string", "required": true, "description": "老的调度器:fair", "example": "fair" }, { "name": "NewValue", "type": "string", "required": true, "description": "新的调度器:capacity", "example": "capacity" } ], "required": [ "InstanceId", "OldValue", "NewValue" ] }, { "name": "ModifyResourcesTags", "description": "强制修改标签", "status": "online", "parameters": [ { "name": "ModifyType", "type": "string", "required": true, "description": "标签类型，取值Cluster或者Node", "example": "cluster" }, { "name": "ModifyResourceTagsInfoList", "type": "array", "required": true, "description": "标签信息", "example": "无", "item_type": "object", "children": [ { "name": "ResourceId", "type": "string", "required": true, "description": "集群id 或者 cvm id", "example": "emr-xxxx" }, { "name": "Resource", "type": "string", "required": true, "description": "资源6段式表达式", "example": "qcs::emr:ap-guangzhou:..." }, { "name": "ResourcePrefix", "type": "string", "required": true, "description": "资源前缀", "example": "emr-instance" }, { "name": "ResourceRegion", "type": "string", "required": true, "description": "ap-beijing", "example": "地域" }, { "name": "ServiceType", "type": "string", "required": true, "description": "emr", "example": "服务类型" }, { "name": "DeleteTags", "type": "array", "required": false, "description": "删除的标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "AddTags", "type": "array", "required": false, "description": "添加的标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "ModifyTags", "type": "array", "required": false, "description": "修改的标签列表", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] } ] } ], "required": [ "ModifyType", "ModifyResourceTagsInfoList" ] }, { "name": "ModifySLInstance", "description": "本接口（ModifySLInstance）用于Serverless HBase变配实例。 - 接口调用成功，会创建Serverless HBase实例，创建实例请求成功会返回请求的 RequestID。 - 接口为异步接口，接口返回时操作并未立即完成，实例操作结果可以通过调用DescribeInstancesList查看当前实例的StatusDesc状态。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例唯一标识符（字符串表示）。", "example": "emr-xxxxxxxx" }, { "name": "Zone", "type": "string", "required": true, "description": "需要变更的区域名称。", "example": "ap-guangzhou-1" }, { "name": "NodeNum", "type": "integer", "required": true, "description": "该区域变配后的目标节点数量，所有区域节点总数应大于等于3，小于等于50。", "example": "4" }, { "name": "ClientToken", "type": "string", "required": false, "description": "唯一随机标识，时效性为5分钟，需要调用者指定 防止客户端重复创建资源，例如 a9a90aa6-****-****-****-fae360632808", "example": "sdcdwxxxws" } ], "required": [ "InstanceId", "Zone", "NodeNum" ] }, { "name": "ModifySLInstanceBasic", "description": "serverless hbase修改实例名称", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID", "example": "emr-ke6f8bc5" }, { "name": "ClusterName", "type": "string", "required": true, "description": "实例名称", "example": "EMR-audi_CDP" } ], "required": [ "InstanceId", "ClusterName" ] }, { "name": "ModifyUserGroup", "description": "用户管理-修改用户组", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群字符串ID", "example": "emr-o88f3whr" }, { "name": "Users", "type": "array", "required": true, "description": "用户信息列表", "example": "[\"user1\"]", "item_type": "string" }, { "name": "UserGroup", "type": "string", "required": false, "description": "用户主组，cvm集群为必填参数，tke集群选填", "example": "group4" }, { "name": "Groups", "type": "array", "required": false, "description": "用户副组", "example": "[\"group4\"]", "item_type": "string" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "modify" } ], "required": [ "InstanceId", "Users" ] }, { "name": "ModifyUserManagerPwd", "description": "修改用户密码（用户管理）", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID", "example": "emr-xxx" }, { "name": "UserName", "type": "string", "required": true, "description": "用户名", "example": "emr" }, { "name": "PassWord", "type": "string", "required": true, "description": "密码", "example": "pwd-test-123" }, { "name": "SyncPwd", "type": "boolean", "required": false, "description": "是否同步密码", "example": "false" } ], "required": [ "InstanceId", "UserName", "PassWord" ] }, { "name": "ModifyUsersOfGroupSTD", "description": "变更用户组用户信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群名称", "example": "emr-o88f3whr" }, { "name": "Group", "type": "string", "required": true, "description": "用户组名", "example": "group3" }, { "name": "Users", "type": "array", "required": false, "description": "用户列表", "example": "[\"user1\"]", "item_type": "string" }, { "name": "Description", "type": "string", "required": false, "description": "用户组描述", "example": "modify" }, { "name": "OperateAction", "type": "string", "required": false, "description": "枚举类, ADD, DELETE, SYNC 枚举类说明: - ADD: 新增的批量用户, 多次新增相同的用户不会报错 - DELETE: 从用户组里删除的批量用户, 删除不存在的用户不会报错 - SYNC: 用于同步整个用户组, 当列表为空时代表清空整个用户组 默认为SYNC", "example": "SYNC" } ], "required": [ "InstanceId", "Group" ] }, { "name": "ModifyYarnDeploy", "description": "该接口已废弃，请使用DeployYarnConf完成部署生效 部署生效。已废弃，请使用`DeployYarnConf`接口进行部署生效", "status": "deprecated", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群id", "example": "emr-xx" }, { "name": "NewScheduler", "type": "string", "required": true, "description": "切换后的调度器，可选值为fair、capacity", "example": "fair" }, { "name": "OldScheduler", "type": "string", "required": false, "description": "现在使用的调度器，可选值为fair、capacity", "example": "capacity" } ], "required": [ "InstanceId", "NewScheduler" ] }, { "name": "ModifyYarnQueueV2", "description": "修改资源调度中队列信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群Id", "example": "emr-xxx" }, { "name": "Scheduler", "type": "string", "required": true, "description": "调度器类型。可选值： 1. capacity 2. fair", "example": "capacity" }, { "name": "ConfigModifyInfoList", "type": "array", "required": true, "description": "资源池数据", "example": "无", "item_type": "object", "children": [ { "name": "OpType", "type": "integer", "required": true, "description": "操作类型，可选值： - 0：新建队列 - 1：编辑-全量覆盖 - 2：新建子队列 - 3：删除 - 4：克隆，与新建子队列的行为一样，特别的对于`fair`，可以复制子队列到新建队列 - 6：编辑-增量更新", "example": "0" }, { "name": "Name", "type": "string", "required": false, "description": "队列名称，不支持修改。", "example": "b" }, { "name": "ParentId", "type": "string", "required": false, "description": "新建队列 传root的MyId；新建子队列 传 选中队列的 myId；克隆 要传 选中队列 parentId", "example": "root.a" }, { "name": "MyId", "type": "string", "required": false, "description": "编辑、删除 传选中队列的 myId。克隆只有在调度器是`fair`时才需要传，用来复制子队列到新队列。", "example": "root.a.b" }, { "name": "BasicParams", "type": "object", "required": false, "description": "基础配置信息。key的取值与**DescribeYarnQueue**返回的字段一致。 ###### 公平调度器 key的取值信息如下： - type，父队列，取值为 **parent** 或 **null** - aclSubmitApps，提交访问控制，取值为**AclForYarnQueue类型的json串**或**null** - aclAdministerApps，管理访问控制，取值为**AclForYarnQueue类型的json串**或**null** - minSharePreemptionTimeout，最小共享优先权超时时间，取值为**数字字符串**或**null** - fairShareP...", "example": "无", "children": [ { "name": "Items", "type": "array", "required": true, "description": "标签名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "健值", "example": "k" }, { "name": "Value", "type": "string", "required": true, "description": "值", "example": "v" } ] } ] }, { "name": "ConfigSetParams", "type": "array", "required": false, "description": "配置集信息，取值见该复杂类型的参数说明。配置集是计划模式在队列中表现，表示的是不同时间段不同的配置值，所有队列的配置集名称都一样，对于单个队列，每个配置集中的标签与参数都一样，只是参数值不同。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ConfigSet", "type": "string", "required": true, "description": "配置集名称", "example": "default" }, { "name": "LabelParams", "type": "array", "required": false, "description": "容量调度器会使用，里面设置了标签相关的配置。key的取值与**DescribeYarnQueue**返回的字段一致。 key的取值信息如下： - labelName，标签名称，标签管理里的标签。 - capacity，容量，取值为**数字字符串** - maximum-capacity，最大容量，取值为**数字字符串** 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Items", "type": "array", "required": true, "description": "标签名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "BasicParams", "type": "array", "required": false, "description": "设置配置集相关的参数。key的取值与**DescribeYarnQueue**返回的字段一致。 ###### 公平调度器 key的取值信息如下： - minResources，最大资源量，取值为**YarnResource类型的json串**或**null** - maxResources，最大资源量，取值为**YarnResource类型的json串**或**null** - maxChildResources，能够分配给为未声明子队列的最大资源量，取值为**数字字符串**或**null** - maxRunningApps，最高可同时处于运行的App数量\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "健值", "example": "k" }, { "name": "Value", "type": "string", "required": true, "description": "值", "example": "v" } ] } ] }, { "name": "DeleteLables", "type": "array", "required": false, "description": "容量调度专用，`OpType`为`6`时才生效，表示要删除这个队列中的哪些标签。优先级高于ConfigSetParams中的LabelParams。 注意：此字段可能返回 null，表示取不到有效值。", "example": "label_test", "item_type": "string" } ] } ], "required": [ "InstanceId", "Scheduler", "ConfigModifyInfoList" ] }, { "name": "ResetYarnConfig", "description": "修改YARN资源调度的资源配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "emr集群的英文id", "example": "emr-2xef56" }, { "name": "Key", "type": "string", "required": false, "description": "要重置的配置别名，可选值： - capacityLabel：重置标签管理的配置 - fair：重置公平调度的配置 - capacity：重置容量调度的配置", "example": "capacityLabel" } ], "required": [ "InstanceId" ] }, { "name": "ResizeDataDisks", "description": "云数据盘扩容", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "EMR集群实例ID", "example": "emr-xxxxxxx" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "需要扩充的容量值，容量值需要大于原容量，并且为10的整数倍", "example": "300" }, { "name": "CvmInstanceIds", "type": "array", "required": true, "description": "需要扩容的节点ID列表", "example": "[ins-xxx1,ins-xxx2]", "item_type": "string" }, { "name": "DiskIds", "type": "array", "required": false, "description": "需要扩容的云盘ID", "example": "[disk-xxx1, disk-xxx2]", "item_type": "string" }, { "name": "ResizeAll", "type": "boolean", "required": false, "description": "是否扩容全部云硬盘", "example": "true" } ], "required": [ "InstanceId", "DiskSize", "CvmInstanceIds" ] }, { "name": "RunJobFlow", "description": "创建流程作业", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "作业名称。", "example": "job-name" }, { "name": "CreateCluster", "type": "boolean", "required": true, "description": "是否新创建集群。 true，新创建集群，则使用Instance中的参数进行集群创建。 false，使用已有集群，则通过InstanceId传入。", "example": "false" }, { "name": "Steps", "type": "array", "required": true, "description": "作业流程执行步骤。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "执行步骤名称。", "example": "step1" }, { "name": "ExecutionStep", "type": "object", "required": true, "description": "执行动作。", "example": "无", "children": [ { "name": "JobType", "type": "string", "required": true, "description": "任务类型，目前支持以下类型。 1. “MR”，将通过hadoop jar的方式提交。 2. \"HIVE\"，将通过hive -f的方式提交。 3. \"SPARK\"，将通过spark-submit的方式提交。", "example": "MR" }, { "name": "Args", "type": "array", "required": true, "description": "任务参数，提供除提交指令以外的参数。", "example": "arg_test", "item_type": "string" } ] }, { "name": "ActionOnFailure", "type": "string", "required": true, "description": "执行失败策略。 1. TERMINATE_CLUSTER 执行失败时退出并销毁集群。 2. CONTINUE 执行失败时跳过并执行后续步骤。", "example": "CONTINUE" }, { "name": "User", "type": "string", "required": false, "description": "指定执行Step时的用户名，非必须，默认为hadoop。", "example": "hadoop" } ] }, { "name": "InstancePolicy", "type": "string", "required": true, "description": "作业流程正常完成时，集群的处理方式，可选择: Terminate 销毁集群。 Reserve 保留集群。", "example": "Terminate" }, { "name": "ProductVersion", "type": "string", "required": false, "description": "只有CreateCluster为true时生效，目前只支持EMR版本，例如EMR-2.2.0，不支持ClickHouse和Druid版本。", "example": "EMR-3.6.0" }, { "name": "SecurityClusterFlag", "type": "boolean", "required": false, "description": "只在CreateCluster为true时生效。 true 表示安装kerberos，false表示不安装kerberos。", "example": "true" }, { "name": "Software", "type": "array", "required": false, "description": "只在CreateCluster为true时生效。 新建集群时，要安装的软件列表。", "example": "[\"hadoop-2.8.4\\n\",\"zookeeper-3.4.9\\n\",\"knox-1.2.0\\n\"]", "item_type": "string" }, { "name": "BootstrapActions", "type": "array", "required": false, "description": "引导脚本。", "example": "无", "item_type": "object", "children": [ { "name": "Path", "type": "string", "required": true, "description": "脚本位置，支持cos上的文件，且只支持https协议。", "example": "https://beijing-111111.cos.ap-beijing.myqcloud.com/data/test.sh" }, { "name": "WhenRun", "type": "string", "required": true, "description": "执行时间。 resourceAfter 表示在机器资源申请成功后执行。 clusterBefore 表示在集群初始化前执行。 clusterAfter 表示在集群初始化后执行。", "example": "resourceAfter" }, { "name": "Args", "type": "array", "required": false, "description": "脚本参数", "example": "arg_test", "item_type": "string" } ] }, { "name": "Configurations", "type": "array", "required": false, "description": "指定配置创建集群。", "example": "无", "item_type": "object", "children": [ { "name": "Classification", "type": "string", "required": true, "description": "配置文件名，支持SPARK、HIVE、HDFS、YARN的部分配置文件自定义。", "example": "cluster.properties" }, { "name": "Properties", "type": "string", "required": true, "description": "配置参数通过KV的形式传入，部分文件支持自定义，可以通过特殊的键\"content\"传入所有内容。", "example": "{ \\\"spark.hadoop.fs.cosn.bucket.region\\\":\\\"ap-beijing-fsi\\\"}" } ] }, { "name": "LogUri", "type": "string", "required": false, "description": "作业日志保存地址。", "example": "uri/test" }, { "name": "InstanceId", "type": "string", "required": false, "description": "只在CreateCluster为false时生效。", "example": "emr-on1234" }, { "name": "ApplicationRole", "type": "string", "required": false, "description": "自定义应用角色，大数据应用访问外部服务时使用的角色，默认为\"EME_QCSRole\"。", "example": "EME_QCSRole" }, { "name": "ClientToken", "type": "string", "required": false, "description": "重入标签，用来可重入检查，防止在一段时间内，创建相同的流程作业。", "example": "\"test-test\"" }, { "name": "Instance", "type": "object", "required": false, "description": "只在CreateCluster为true时生效，使用该配置创建集群。", "example": "无", "children": [ { "name": "InstanceChargeType", "type": "string", "required": true, "description": "付费方式。 PREPAID 包年包月。 POSTPAID_BY_HOUR 按量计费，默认方式。", "example": "PREPAID" }, { "name": "SupportHA", "type": "boolean", "required": true, "description": "是否为HA集群。", "example": "true" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "集群所使用的安全组，目前仅支持一个。", "example": "sg-xxxxxxxx", "item_type": "string" }, { "name": "Placement", "type": "object", "required": true, "description": "实例位置。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区，例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" } ] }, { "name": "VPCSettings", "type": "object", "required": true, "description": "实例所在VPC。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC ID", "example": "vpc-xxxxx" }, { "name": "SubnetId", "type": "string", "required": true, "description": "Subnet ID", "example": "subnet-xxxxx" } ] }, { "name": "LoginSettings", "type": "object", "required": true, "description": "实例登录配置。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码，8-16个字符，包含大写字母、小写字母、数字和特殊字符四种，特殊符号仅支持!@%^*，密码第一位不能为特殊字符", "example": "Password_test" }, { "name": "PublicKeyId", "type": "string", "required": false, "description": "密钥ID。关联密钥后，就可以通过对应的私钥来访问实例；PublicKeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取", "example": "PublicKeyId_test" } ] }, { "name": "TagSpecification", "type": "array", "required": true, "description": "实例标签，示例：[\"{\\\"TagKey\\\":\\\"test-tag1\\\",\\\"TagValue\\\":\\\"001\\\"}\",\"{\\\"TagKey\\\":\\\"test-tag2\\\",\\\"TagValue\\\":\\\"002\\\"}\"]。", "example": "[\"{\\\"TagKey\\\":\\\"test-tag1\\\",\\\"TagValue\\\":\\\"001\\\"}\",\"{\\\"TagKey\\\":", "item_type": "string" }, { "name": "MetaDB", "type": "object", "required": true, "description": "元数据库配置。", "example": "无", "children": [ { "name": "MetaType", "type": "string", "required": true, "description": "元数据类型。", "example": "EMR_DEFAULT_META" }, { "name": "UnifyMetaInstanceId", "type": "string", "required": true, "description": "统一元数据库实例ID。", "example": "cdb-26u8vvwr" }, { "name": "MetaDBInfo", "type": "object", "required": true, "description": "自建元数据库信息。", "example": "无", "children": [ { "name": "MetaDataJdbcUrl", "type": "string", "required": false, "description": "自定义MetaDB的JDBC连接，请以 jdbc:mysql:// 开头", "example": "jdbc:mysql://ip:port/hive" }, { "name": "MetaDataUser", "type": "string", "required": false, "description": "自定义MetaDB用户名", "example": "userName" }, { "name": "MetaDataPass", "type": "string", "required": false, "description": "自定义MetaDB密码", "example": "pwd" } ] } ] }, { "name": "ResourceSpec", "type": "object", "required": true, "description": "实例硬件配置。", "example": "无", "children": [ { "name": "MasterCount", "type": "integer", "required": true, "description": "主节点数量。", "example": "1" }, { "name": "MasterResourceSpec", "type": "object", "required": true, "description": "主节点配置。", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "机器类型描述。", "example": "CVM.SA5" }, { "name": "InstanceType", "type": "string", "required": true, "description": "机器类型描述，可参考CVM的该含义。", "example": "SA5.8XLARGE128" }, { "name": "Tags", "type": "array", "required": true, "description": "标签KV对。", "example": "无", "item_type": "string" }, { "name": "DiskGroups", "type": "array", "required": true, "description": "磁盘描述列表。", "example": "无", "item_type": "string" } ] }, { "name": "CoreCount", "type": "integer", "required": true, "description": "Core节点数量", "example": "2" }, { "name": "CoreResourceSpec", "type": "object", "required": true, "description": "Core节点配置。", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "机器类型描述。", "example": "CVM.SA5" }, { "name": "InstanceType", "type": "string", "required": true, "description": "机器类型描述，可参考CVM的该含义。", "example": "SA5.8XLARGE128" }, { "name": "Tags", "type": "array", "required": true, "description": "标签KV对。", "example": "无", "item_type": "string" }, { "name": "DiskGroups", "type": "array", "required": true, "description": "磁盘描述列表。", "example": "无", "item_type": "string" } ] }, { "name": "TaskCount", "type": "integer", "required": false, "description": "Task节点数量。", "example": "0" }, { "name": "CommonCount", "type": "integer", "required": false, "description": "Common节点数量。", "example": "0" }, { "name": "TaskResourceSpec", "type": "object", "required": false, "description": "Task节点配置。", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "机器类型描述。", "example": "CVM.SA5" }, { "name": "InstanceType", "type": "string", "required": true, "description": "机器类型描述，可参考CVM的该含义。", "example": "SA5.8XLARGE128" }, { "name": "Tags", "type": "array", "required": true, "description": "标签KV对。", "example": "无", "item_type": "string" }, { "name": "DiskGroups", "type": "array", "required": true, "description": "磁盘描述列表。", "example": "无", "item_type": "string" } ] }, { "name": "CommonResourceSpec", "type": "object", "required": false, "description": "Common节点配置。", "example": "无", "children": [ { "name": "Spec", "type": "string", "required": true, "description": "机器类型描述。", "example": "CVM.SA5" }, { "name": "InstanceType", "type": "string", "required": true, "description": "机器类型描述，可参考CVM的该含义。", "example": "SA5.8XLARGE128" }, { "name": "Tags", "type": "array", "required": true, "description": "标签KV对。", "example": "无", "item_type": "string" }, { "name": "DiskGroups", "type": "array", "required": true, "description": "磁盘描述列表。", "example": "无", "item_type": "string" } ] } ] }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否申请公网IP，默认为false。", "example": "false" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "包年包月配置，只对包年包月集群生效。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "包年包月时间，默认为1，单位：月。 取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10,11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "boolean", "required": true, "description": "是否自动续费，默认为否。 true：是 false：否", "example": "false" } ] }, { "name": "DisasterRecoverGroupIds", "type": "string", "required": false, "description": "集群置放群组。", "example": "ps-iy2i7msf" }, { "name": "CbsEncryptFlag", "type": "boolean", "required": false, "description": "是否使用cbs加密。", "example": "false" }, { "name": "RemoteTcpDefaultPort", "type": "boolean", "required": false, "description": "是否使用远程登录，默认为false。", "example": "false" } ] } ], "required": [ "Name", "CreateCluster", "Steps", "InstancePolicy" ] }, { "name": "ScaleOutCluster", "description": "扩容集群节点", "status": "online", "parameters": [ { "name": "InstanceChargeType", "type": "string", "required": true, "description": "节点计费模式。取值范围： PREPAID：预付费，即包年包月。 POSTPAID_BY_HOUR：按小时后付费。 SPOTPAID：竞价付费（仅支持TASK节点）。", "example": "\"SPOTPAID\"" }, { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例ID。", "example": "\"emr-ge0vrqkl\"" }, { "name": "ScaleOutNodeConfig", "type": "object", "required": true, "description": "扩容节点类型以及数量", "example": "无", "children": [ { "name": "NodeFlag", "type": "string", "required": true, "description": "扩容节点类型取值范围： MASTER TASK CORE ROUTER", "example": "MASTER" }, { "name": "NodeCount", "type": "integer", "required": true, "description": "扩容节点数量", "example": "5" } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6-****-****-****-fae36063280", "example": "a9a90aa6-****-****-****-fae36063280" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "包年包月时间，默认为1，单位：月。 取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10,11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "boolean", "required": true, "description": "是否自动续费，默认为否。 true：是 false：否", "example": "false" } ] }, { "name": "ScriptBootstrapActionConfig", "type": "array", "required": false, "description": "[引导操作](https://cloud.tencent.com/document/product/589/35656)脚本设置。", "example": "无", "item_type": "object", "children": [ { "name": "CosFileURI", "type": "string", "required": true, "description": "脚本的cos地址，参照格式：https://beijing-111111.cos.ap-beijing.myqcloud.com/data/test.sh查询cos存储桶列表：[存储桶列表](https://console.cloud.tencent.com/cos/bucket)", "example": "https://becklong-cos-1258469122.cos.ap-guangzhou.myqcloud.com/te" }, { "name": "ExecutionMoment", "type": "string", "required": true, "description": "引导脚步执行时机范围 resourceAfter：节点初始化后 clusterAfter：集群启动后 clusterBefore：集群启动前", "example": "resourceAfter" }, { "name": "Args", "type": "array", "required": false, "description": "执行脚本参数，参数格式请遵循标准Shell规范", "example": "args_test", "item_type": "string" }, { "name": "CosFileName", "type": "string", "required": false, "description": "脚本文件名", "example": "name_test" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "remark_test" } ] }, { "name": "SoftDeployInfo", "type": "array", "required": false, "description": "扩容部署服务，新增节点将默认继承当前节点类型中所部署服务，部署服务含默认可选服务，该参数仅支持可选服务填写，如：存量task节点已部署HDFS、YARN、impala；使用api扩容task节不部署impala时，部署服务仅填写HDFS、YARN。[组件名对应的映射关系表](https://cloud.tencent.com/document/product/589/98760)。", "example": "[1,2]", "item_type": "integer" }, { "name": "ServiceNodeInfo", "type": "array", "required": false, "description": "部署进程，默认部署扩容服务的全部进程，支持修改部署进程，如：当前task节点部署服务为：HDFS、YARN、impala，默认部署服务为：DataNode,NodeManager,ImpalaServer，若用户需修改部署进程信息，部署进程： DataNode,NodeManager,ImpalaServerCoordinator或DataNode,NodeManager,ImpalaServerExecutor。[进程名对应的映射关系表](https://cloud.tencent.com/document/product/589/98760)。", "example": "[7]", "item_type": "integer" }, { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "分散置放群组ID列表，当前只支持指定一个。 该参数可以通过调用 [DescribeDisasterRecoverGroups](https://cloud.tencent.com/document/product/213/17810)的返回值中的DisasterRecoverGroupId字段来获取。", "example": "[\"ps-ery9dr5n\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "扩容节点绑定标签列表。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "HardwareSourceType", "type": "string", "required": false, "description": "扩容所选资源类型，可选范围为\"HOST\",\"POD\",\"MNode\"，HOST为普通的CVM资源，POD为TKE集群或EKS集群提供的资源,MNode为全托管资源类型", "example": "HOST" }, { "name": "PodSpecInfo", "type": "object", "required": false, "description": "Pod相关资源信息", "example": "无", "children": [ { "name": "PodSpec", "type": "object", "required": false, "description": "使用Pod资源扩容时，指定的Pod规格以及来源等信息", "example": "无", "children": [ { "name": "ResourceProviderIdentifier", "type": "string", "required": true, "description": "外部资源提供者的标识符，例如\"cls-a1cd23fa\"。", "example": "cls-a1cd2dsx" }, { "name": "ResourceProviderType", "type": "string", "required": true, "description": "外部资源提供者类型，例如\"tke\",当前仅支持\"tke\"。", "example": "tke" }, { "name": "NodeFlag", "type": "string", "required": true, "description": "资源的用途，即节点类型，当前仅支持\"TASK\"。", "example": "TASK" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数。", "example": "1" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位为GB。", "example": "1" }, { "name": "CpuType", "type": "string", "required": false, "description": "Eks集群-CPU类型，当前支持\"intel\"和\"amd\"", "example": "intel" }, { "name": "PodVolumes", "type": "array", "required": false, "description": "Pod节点数据目录挂载信息。", "example": "无", "item_type": "object", "children": [ { "name": "VolumeType", "type": "string", "required": true, "description": "存储类型，可为\"pvc\"，\"hostpath\"。", "example": "pvc" }, { "name": "PVCVolume", "type": "object", "required": false, "description": "当VolumeType为\"pvc\"时，该字段生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"DiskType\":\"CLOUD_PREMIUM\",\"DiskSize\":1000,\"DiskNum\":1}" }, { "name": "HostVolume", "type": "object", "required": false, "description": "当VolumeType为\"hostpath\"时，该字段生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"VolumePath\":\"/data/emr\"}" } ] }, { "name": "EnableDynamicSpecFlag", "type": "boolean", "required": false, "description": "是否浮动规格，默认否 true：代表是 false：代表否", "example": "true" }, { "name": "DynamicPodSpec", "type": "object", "required": false, "description": "浮动规格 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "RequestCpu", "type": "float", "required": false, "description": "需求最小cpu核数", "example": "0.1234" }, { "name": "LimitCpu", "type": "float", "required": false, "description": "需求最大cpu核数", "example": "1.2345" }, { "name": "RequestMemory", "type": "float", "required": false, "description": "需求最小memory，单位MB", "example": "1234.5678" }, { "name": "LimitMemory", "type": "float", "required": false, "description": "需求最大memory，单位MB", "example": "8765.4321" } ] }, { "name": "VpcId", "type": "string", "required": false, "description": "代表vpc网络唯一id", "example": "vpc-se938xw9" }, { "name": "SubnetId", "type": "string", "required": false, "description": "代表vpc子网唯一id", "example": "sub-ei39s9xx" }, { "name": "PodName", "type": "string", "required": false, "description": "pod name", "example": "podname_test" }, { "name": "OtherAccountInfo", "type": "object", "required": false, "description": "其他账号授权信息", "example": "无", "children": [ { "name": "OtherUin", "type": "string", "required": false, "description": "其他账号UIN 注意：此字段可能返回 null，表示取不到有效值。", "example": "700000446533" }, { "name": "RoleName", "type": "string", "required": false, "description": "其他账号授权角色名称 注意：此字段可能返回 null，表示取不到有效值。", "example": "EMR-CROSS-ACCOUNT-ROLE" } ] } ] }, { "name": "PodParameter", "type": "object", "required": false, "description": "POD自定义权限和自定义参数", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "TKE或EKS集群ID", "example": "emr-test" }, { "name": "Config", "type": "string", "required": true, "description": "自定义权限 如： { \"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\" } } ] }", "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\" } } ] }" }, { "name": "Parameter", "type": "string", "required": true, "description": "自定义参数 如： { \"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/nod...", "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\" ] } ] } ] } } } } } } }" } ] } ] }, { "name": "ClickHouseClusterName", "type": "string", "required": false, "description": "使用clickhouse集群扩容时，选择的机器分组名称", "example": "name-test" }, { "name": "ClickHouseClusterType", "type": "string", "required": false, "description": "使用clickhouse集群扩容时，选择的机器分组类型。new为新增，old为选择旧分组", "example": "new" }, { "name": "YarnNodeLabel", "type": "string", "required": false, "description": "扩容指定 Yarn Node Label", "example": "CLOUD" }, { "name": "EnableStartServiceFlag", "type": "boolean", "required": false, "description": "扩容后是否启动服务，默认取值否 true：是 false：否", "example": "true" }, { "name": "ResourceSpec", "type": "object", "required": false, "description": "规格设置", "example": "无", "children": [ { "name": "InstanceType", "type": "string", "required": true, "description": "规格类型，如S2.MEDIUM8", "example": "S2.MEDIUM8" }, { "name": "SystemDisk", "type": "array", "required": true, "description": "系统盘，系统盘个数不超过1块 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Count", "type": "integer", "required": true, "description": "磁盘数量", "example": "1" }, { "name": "DiskType", "type": "string", "required": true, "description": "系统盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示...", "example": "CLOUD_SSD" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据容量，单位为GB", "example": "70" }, { "name": "ExtraPerformance", "type": "integer", "required": false, "description": "额外性能", "example": "100" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "需要绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "DataDisk", "type": "array", "required": false, "description": "云数据盘，云数据盘总个数不超过15块 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Count", "type": "integer", "required": true, "description": "磁盘数量", "example": "1" }, { "name": "DiskType", "type": "string", "required": true, "description": "系统盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示...", "example": "CLOUD_SSD" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据容量，单位为GB", "example": "70" }, { "name": "ExtraPerformance", "type": "integer", "required": false, "description": "额外性能", "example": "100" } ] }, { "name": "LocalDataDisk", "type": "array", "required": false, "description": "本地数据盘 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Count", "type": "integer", "required": true, "description": "磁盘数量", "example": "1" }, { "name": "DiskType", "type": "string", "required": true, "description": "系统盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 数据盘类型 取值范围： CLOUD_SSD：表示云SSD。 CLOUD_PREMIUM：表示高效云盘。 CLOUD_BASIC：表示云硬盘。 LOCAL_BASIC：表示本地盘。 LOCAL_SSD：表示本地SSD。 CLOUD_HSSD：表示增强型SSD云硬盘。 CLOUD_THROUGHPUT：表示吞吐型云硬盘。 CLOUD_TSSD：表示...", "example": "CLOUD_SSD" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "数据容量，单位为GB", "example": "70" }, { "name": "ExtraPerformance", "type": "integer", "required": false, "description": "额外性能", "example": "100" } ] } ] }, { "name": "Zone", "type": "string", "required": false, "description": "实例所属的可用区，例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-1" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网，默认是集群创建时的子网", "example": "sub-xxx" }, { "name": "ScaleOutServiceConfGroupsInfo", "type": "array", "required": false, "description": "扩容指定配置组", "example": "无", "item_type": "object", "children": [ { "name": "ServiceComponentName", "type": "string", "required": false, "description": "组件版本名称 如 HDFS-2.8.5", "example": "HDFS-2.8.5" }, { "name": "ConfGroupName", "type": "string", "required": false, "description": "配置组名 如hdfs-core-defaultGroup ConfGroupName参数传入 代表配置组维度 ConfGroupName参数不传 默认 代表集群维度", "example": "hdfs-core-defaultGroup" } ] }, { "name": "NodeMarks", "type": "object", "required": false, "description": "节点标记信息，当前只提供给tf平台使用", "example": "无", "children": [ { "name": "NodeType", "type": "string", "required": false, "description": "节点类型：master,core,task,router", "example": "master" }, { "name": "NodeNames", "type": "array", "required": false, "description": "节点标记信息，目前只提供给tf平台使用，作为入参区分同类型节点信息", "example": "Master_1", "item_type": "string" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区名称", "example": "ap-guangzhou-1" } ] }, { "name": "WarehouseName", "type": "string", "required": false, "description": "扩容指定计算组名称", "example": "default_warehouse" } ], "required": [ "InstanceChargeType", "InstanceId", "ScaleOutNodeConfig" ] }, { "name": "ScaleOutInstance", "description": "扩容节点", "status": "online", "parameters": [ { "name": "TimeUnit", "type": "string", "required": true, "description": "扩容的时间单位。取值范围： s：表示秒。PayMode取值为0时，TimeUnit只能取值为s。 m：表示月份。PayMode取值为1时，TimeUnit只能取值为m。", "example": "s" }, { "name": "TimeSpan", "type": "integer", "required": true, "description": "扩容的时长。结合TimeUnit一起使用。 TimeUnit为s时，该参数只能填写3600，表示按量计费实例。 TimeUnit为m时，该参数填写的数字表示包年包月实例的购买时长，如1表示购买一个月", "example": "3600" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "emr-5n3l5c83" }, { "name": "PayMode", "type": "integer", "required": true, "description": "实例计费模式。取值范围： 0：表示按量计费。 1：表示包年包月。", "example": "0" }, { "name": "ClientToken", "type": "string", "required": false, "description": "唯一随机标识，时效5分钟，需要调用者指定 防止客户端重新创建资源，例如 a9a90aa6-****-****-****-fae36063280", "example": "a9a90aa6-****-****-****-fae36063280" }, { "name": "PreExecutedFileSettings", "type": "array", "required": false, "description": "引导操作脚本设置。", "example": "无", "item_type": "object", "children": [ { "name": "Path", "type": "string", "required": false, "description": "脚本在COS上路径，已废弃", "example": "emr/emr_init.sh" }, { "name": "Args", "type": "array", "required": false, "description": "执行脚本参数", "example": "Args_test", "item_type": "string" }, { "name": "Bucket", "type": "string", "required": false, "description": "COS的Bucket名称，已废弃", "example": "starmaker-research-xxxx" }, { "name": "Region", "type": "string", "required": false, "description": "COS的Region名称，已废弃", "example": "ap-mumbai" }, { "name": "Domain", "type": "string", "required": false, "description": "COS的Domain数据，已废弃", "example": "Domain_test" }, { "name": "RunOrder", "type": "integer", "required": false, "description": "执行顺序", "example": "0" }, { "name": "WhenRun", "type": "string", "required": false, "description": "resourceAfter 或 clusterAfter", "example": "resourceAfter" }, { "name": "CosFileName", "type": "string", "required": false, "description": "脚本文件名，已废弃", "example": "test_file" }, { "name": "CosFileURI", "type": "string", "required": false, "description": "脚本的cos地址", "example": "cos://xxxxx" }, { "name": "CosSecretId", "type": "string", "required": false, "description": "cos的SecretId", "example": "CosSecretId_test" }, { "name": "CosSecretKey", "type": "string", "required": false, "description": "Cos的SecretKey", "example": "CosSecretKey_test" }, { "name": "AppId", "type": "string", "required": false, "description": "cos的appid，已废弃", "example": "41345531" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "remark_test" } ] }, { "name": "TaskCount", "type": "integer", "required": false, "description": "扩容的Task节点数量。", "example": "0" }, { "name": "CoreCount", "type": "integer", "required": false, "description": "扩容的Core节点数量。", "example": "1" }, { "name": "UnNecessaryNodeList", "type": "array", "required": false, "description": "扩容时不需要安装的进程。", "example": "[53]", "item_type": "integer" }, { "name": "RouterCount", "type": "integer", "required": false, "description": "扩容的Router节点数量。", "example": "0" }, { "name": "SoftDeployInfo", "type": "array", "required": false, "description": "部署的服务。 SoftDeployInfo和ServiceNodeInfo是同组参数，和UnNecessaryNodeList参数互斥。 建议使用SoftDeployInfo和ServiceNodeInfo组合。", "example": "[1,2,25]", "item_type": "integer" }, { "name": "ServiceNodeInfo", "type": "array", "required": false, "description": "启动的进程。", "example": "[7]", "item_type": "integer" }, { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "分散置放群组ID列表，当前仅支持指定一个。", "example": "[\"ps-ery9dr5n\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "扩容节点绑定标签列表。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签键", "example": "depart-xxx" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "Intelligent-xxx" } ] }, { "name": "HardwareResourceType", "type": "string", "required": false, "description": "扩容所选资源类型，可选范围为\"HOST\",\"POD\",\"MNode\"，HOST为普通的CVM资源，POD为TKE集群或EKS集群提供的资源,MNode为全托管资源类型", "example": "HOST" }, { "name": "PodSpec", "type": "object", "required": false, "description": "使用Pod资源扩容时，指定的Pod规格以及来源等信息", "example": "无", "children": [ { "name": "ResourceProviderIdentifier", "type": "string", "required": true, "description": "外部资源提供者的标识符，例如\"cls-a1cd23fa\"。", "example": "cls-a1cd23fa" }, { "name": "ResourceProviderType", "type": "string", "required": true, "description": "外部资源提供者类型，例如\"tke\",当前仅支持\"tke\"。", "example": "tke" }, { "name": "NodeType", "type": "string", "required": true, "description": "资源的用途，即节点类型，当前仅支持\"TASK\"。", "example": "Task" }, { "name": "Cpu", "type": "integer", "required": true, "description": "CPU核数。", "example": "0" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位为GB。", "example": "0" }, { "name": "DataVolumes", "type": "array", "required": false, "description": "资源对宿主机的挂载点，指定的挂载点对应了宿主机的路径，该挂载点在Pod中作为数据存储目录使用。弃用", "example": "[\"/data\"]", "item_type": "string" }, { "name": "CpuType", "type": "string", "required": false, "description": "Eks集群-CPU类型，当前支持\"intel\"和\"amd\"", "example": "intel" }, { "name": "PodVolumes", "type": "array", "required": false, "description": "Pod节点数据目录挂载信息。", "example": "[\"/data\"]", "item_type": "object", "children": [ { "name": "VolumeType", "type": "string", "required": true, "description": "存储类型，可为\"pvc\"，\"hostpath\"。", "example": "pvc" }, { "name": "PVCVolume", "type": "object", "required": false, "description": "当VolumeType为\"pvc\"时，该字段生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"DiskType\":\"CLOUD_PREMIUM\",\"DiskSize\":1000,\"DiskNum\":1}", "children": [ { "name": "DiskSize", "type": "integer", "required": false, "description": "磁盘大小，单位为GB。", "example": "1024" }, { "name": "DiskType", "type": "string", "required": false, "description": "磁盘类型。CLOUD_PREMIUM;CLOUD_SSD", "example": "CLOUD_BSSD" }, { "name": "DiskNum", "type": "integer", "required": false, "description": "磁盘数量", "example": "1" }, { "name": "ExtraPerformance", "type": "integer", "required": false, "description": "云盘额外性能", "example": "100" } ] }, { "name": "HostVolume", "type": "object", "required": false, "description": "当VolumeType为\"hostpath\"时，该字段生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\"VolumePath\":\"/data/emr\"}", "children": [ { "name": "VolumePath", "type": "string", "required": true, "description": "Pod挂载宿主机的目录。资源对宿主机的挂载点，指定的挂载点对应了宿主机的路径，该挂载点在Pod中作为数据存储目录使用", "example": "data/emr" } ] } ] }, { "name": "IsDynamicSpec", "type": "integer", "required": false, "description": "是否浮动规格，1是，0否", "example": "0" }, { "name": "DynamicPodSpec", "type": "object", "required": false, "description": "浮动规格 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "RequestCpu", "type": "float", "required": false, "description": "需求最小cpu核数", "example": "0.1234" }, { "name": "LimitCpu", "type": "float", "required": false, "description": "需求最大cpu核数", "example": "1.2345" }, { "name": "RequestMemory", "type": "float", "required": false, "description": "需求最小memory，单位MB", "example": "1234.5678" }, { "name": "LimitMemory", "type": "float", "required": false, "description": "需求最大memory，单位MB", "example": "8765.4321" } ] }, { "name": "VpcId", "type": "string", "required": false, "description": "代表vpc网络唯一id", "example": "vpc-xxtt67hg" }, { "name": "SubnetId", "type": "string", "required": false, "description": "代表vpc子网唯一id", "example": "sub-yiu78vg7" }, { "name": "PodName", "type": "string", "required": false, "description": "pod name", "example": "emr-p9biv55e-kyuubi-kyuubiserver-0" } ] }, { "name": "ClickHouseClusterName", "type": "string", "required": false, "description": "使用clickhouse集群扩容时，选择的机器分组名称", "example": "name-test" }, { "name": "ClickHouseClusterType", "type": "string", "required": false, "description": "使用clickhouse集群扩容时，选择的机器分组类型。new为新增，old为选择旧分组", "example": "new" }, { "name": "YarnNodeLabel", "type": "string", "required": false, "description": "规则扩容指定 yarn node label", "example": "CLOUD" }, { "name": "PodParameter", "type": "object", "required": false, "description": "POD自定义权限和自定义参数", "example": "无", "children": [ { "name": "ClusterId", "type": "string", "required": true, "description": "TKE或EKS集群ID", "example": "cls-1234abcd" }, { "name": "Config", "type": "string", "required": true, "description": "自定义权限 如： { \"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\" } } ] }", "example": "{ \"apiVersion\": \"v1\", \"clusters\": [ { \"cluster\": {" }, { "name": "Parameter", "type": "string", "required": true, "description": "自定义参数 如： { \"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/nod...", "example": "{ \"apiVersion\": \"apps/v1\", \"kind\": \"Deployment\", \"metadata" } ] }, { "name": "MasterCount", "type": "integer", "required": false, "description": "扩容的Master节点的数量。 使用clickhouse集群扩容时，该参数不生效。 使用kafka集群扩容时，该参数不生效。 当HardwareResourceType=POD时，该参数不生效。", "example": "1" }, { "name": "StartServiceAfterScaleOut", "type": "string", "required": false, "description": "扩容后是否启动服务，true：启动，false：不启动", "example": "\"true\"" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "可用区，默认是集群的主可用区", "example": "100002" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网，默认是集群创建时的子网", "example": "sub-xxx" }, { "name": "ScaleOutServiceConfAssign", "type": "string", "required": false, "description": "预设配置组", "example": "{\\\"HDFS-3.2.2\\\":-1,\\\"YARN-3.2.2\\\":-1}" }, { "name": "AutoRenew", "type": "integer", "required": false, "description": "0表示关闭自动续费，1表示开启自动续费", "example": "1" }, { "name": "ResourceBaseType", "type": "string", "required": false, "description": "类型为ComputeResource和EMR以及默认，默认为EMR,类型为EMR时,InstanceId生效,类型为ComputeResource时,使用ComputeResourceId标识", "example": "ComputeResource" }, { "name": "ComputeResourceId", "type": "string", "required": false, "description": "计算资源id", "example": "emr-cr-xxxx" }, { "name": "ComputeResourceAdvanceParams", "type": "object", "required": false, "description": "计算资源高级设置", "example": "无", "children": [ { "name": "Labels", "type": "array", "required": false, "description": "节点Label数组", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "Label Name", "example": "cloud.tencent.com/node-instance-id" }, { "name": "Value", "type": "string", "required": false, "description": "Label Value", "example": "ins-0dcxficf" } ] }, { "name": "Taints", "type": "array", "required": false, "description": "节点污点", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "Taint Key", "example": "node.kubernetes.io/unschedulable" }, { "name": "Value", "type": "string", "required": false, "description": "Taint Value", "example": "true" }, { "name": "Effect", "type": "string", "required": false, "description": "Taint Effect", "example": "NoSchedule" } ] }, { "name": "PreStartUserScript", "type": "string", "required": false, "description": "base64 编码的用户脚本，在初始化节点之前执行", "example": "#!/bin/sh echo \"hello world\"" }, { "name": "UserScript", "type": "string", "required": false, "description": "base64 编码的用户脚本, 此脚本会在 k8s 组件运行后执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看", "example": "#!/bin/sh echo \"hello world\"" } ] }, { "name": "NodeMarks", "type": "object", "required": false, "description": "节点标记信息，目前只提供tf平台使用", "example": "无", "children": [ { "name": "NodeType", "type": "string", "required": false, "description": "节点类型：master,core,task,router", "example": "master" }, { "name": "NodeNames", "type": "array", "required": false, "description": "节点标记信息，目前只提供给tf平台使用，作为入参区分同类型节点信息", "example": "Master_1", "item_type": "string" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区名称", "example": "ap-guangzhou-1" } ] }, { "name": "WarehouseName", "type": "string", "required": false, "description": "扩容指定计算组", "example": "default_warehouse" } ], "required": [ "TimeUnit", "TimeSpan", "InstanceId", "PayMode" ] }, { "name": "SetNodeResourceConfigDefault", "description": "设置当前集群的某个节点规格配置为默认或取消默认", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群实例Id", "example": "emr-fadfdas" }, { "name": "ResourceConfigId", "type": "integer", "required": true, "description": "配置Id", "example": "12" }, { "name": "ResourceType", "type": "string", "required": false, "description": "规格节点类型 CORE TASK ROUTER", "example": "CORE" }, { "name": "ResourceBaseType", "type": "string", "required": false, "description": "类型为ComputeResource和EMR以及默认，默认为EMR", "example": "ComputeResource" }, { "name": "ComputeResourceId", "type": "string", "required": false, "description": "计算资源id", "example": "emr-cr-xxx" }, { "name": "HardwareResourceType", "type": "string", "required": false, "description": "硬件类型", "example": "HOST" } ], "required": [ "InstanceId", "ResourceConfigId" ] }, { "name": "StartStopServiceOrMonitor", "description": "用于启停服务 重启服务等功能", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "集群ID", "example": "emr-xxx" }, { "name": "OpType", "type": "string", "required": true, "description": "操作类型，当前支持 StartService：启动服务 StopService：停止服务 StartMonitor：退出维护 StopMonitor：进入维护 RestartService：重启服务 如果操作类型选择重启服务 StrategyConfig操作策略则是必填项", "example": "StartService" }, { "name": "OpScope", "type": "object", "required": true, "description": "操作范围", "example": "无", "children": [ { "name": "ServiceInfoList", "type": "array", "required": false, "description": "操作范围，要操作的服务信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "ServiceName", "type": "string", "required": false, "description": "服务名，必填，如HDFS", "example": "“HDFS”" }, { "name": "ComponentInfoList", "type": "array", "required": false, "description": "如果没传，则表示所有进程", "example": "无", "item_type": "object", "children": [ { "name": "ComponentName", "type": "string", "required": false, "description": "进程名，必填，如NameNode", "example": "“NameNode”" }, { "name": "IpList", "type": "array", "required": false, "description": "操作的IP列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"ip1\", \"ip2\"]", "item_type": "string" } ] } ] } ] }, { "name": "StrategyConfig", "type": "object", "required": false, "description": "操作策略", "example": "无", "children": [ { "name": "RollingRestartSwitch", "type": "integer", "required": false, "description": "0:关闭滚动重启 1:开启滚动启动", "example": "0" }, { "name": "BatchSize", "type": "integer", "required": false, "description": "滚动重启每批次的重启数量，最大重启台数为 99999 台", "example": "1" }, { "name": "TimeWait", "type": "integer", "required": false, "description": "滚动重启每批停止等待时间 ,最大间隔为 5 分钟 单位是秒", "example": "5" }, { "name": "DealOnFail", "type": "integer", "required": false, "description": "操作失败处理策略，0:失败阻塞, 1:失败自动跳过", "example": "0" }, { "name": "Args", "type": "array", "required": false, "description": "指令需要指定的参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "key", "example": "Threads" }, { "name": "Values", "type": "array", "required": false, "description": "值列表 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"0\"]", "item_type": "string" } ] } ] }, { "name": "StopParams", "type": "object", "required": false, "description": "暂停服务时用的参数", "example": "无", "children": [ { "name": "StopPolicy", "type": "string", "required": false, "description": "安全模式：safe 默认模式：default", "example": "default" }, { "name": "ThreadCount", "type": "integer", "required": false, "description": "线程数", "example": "12" } ] }, { "name": "KeepMonitorButNotRecoverProcess", "type": "boolean", "required": false, "description": "当OpType为StopMonitor才有用，true表示进入维护模式但是仍然监控进程但是不拉起进程", "example": "true" } ], "required": [ "InstanceId", "OpType", "OpScope" ] }, { "name": "SyncPodState", "description": "EMR同步TKE中POD状态", "status": "online", "parameters": [ { "name": "Message", "type": "object", "required": true, "description": "EmrService中pod状态信息", "example": "{”pod-1\"，”pod-1\"，““POD_STATE_DELETED”,\"pod is deleted\",\"1223456\"", "children": [ { "name": "Name", "type": "string", "required": true, "description": "pod的名称", "example": "1234-5677-3352-2" }, { "name": "Uuid", "type": "string", "required": true, "description": "pod uuid", "example": "1234-5677-3352-2" }, { "name": "State", "type": "string", "required": true, "description": "pod的状态", "example": "POD_STATE_DELETED" }, { "name": "Reason", "type": "string", "required": true, "description": "pod处于该状态原因", "example": "pod is deleted" }, { "name": "OwnerCluster", "type": "string", "required": true, "description": "pod所属集群", "example": "emr-cluster" }, { "name": "Memory", "type": "integer", "required": true, "description": "pod内存大小", "example": "2" } ] } ], "required": [ "Message" ] }, { "name": "TerminateClusterNodes", "description": "销毁集群节点", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "emr-4slr7ad7" }, { "name": "CvmInstanceIds", "type": "array", "required": true, "description": "销毁资源列表", "example": "[\"ins-42u6moui\\r\\n\"]", "item_type": "string" }, { "name": "NodeFlag", "type": "string", "required": true, "description": "销毁节点类型取值范围： MASTER TASK CORE ROUTER", "example": "MASTER" }, { "name": "GraceDownFlag", "type": "boolean", "required": false, "description": "优雅缩容开关 true:开启 false:不开启", "example": "true" }, { "name": "GraceDownTime", "type": "integer", "required": false, "description": "优雅缩容等待时间,时间范围60到1800 单位秒", "example": "60" } ], "required": [ "InstanceId", "CvmInstanceIds", "NodeFlag" ] }, { "name": "TerminateInstance", "description": "销毁EMR实例。此接口仅支持弹性MapReduce正式计费版本。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "emr-4slr7ad7" }, { "name": "ResourceIds", "type": "array", "required": false, "description": "销毁节点ID。该参数为预留参数，用户无需配置。", "example": "[\"id-test\"]", "item_type": "string" }, { "name": "ResourceBaseType", "type": "string", "required": false, "description": "类型为ComputeResource和EMR以及默认，默认为EMR,类型为EMR时,InstanceId生效,类型为ComputeResource时,使用ComputeResourceId标识", "example": "ComputeResource" }, { "name": "ComputeResourceId", "type": "string", "required": false, "description": "计算资源ID", "example": "emr-cr-0xrwm3bb" } ], "required": [ "InstanceId" ] }, { "name": "TerminateSLInstance", "description": "本接口（TerminateSLInstance）用于销毁Serverless HBase实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例唯一标识符（字符串表示）", "example": "emr-xxxxxxxx" } ], "required": [ "InstanceId" ] }, { "name": "TerminateTasks", "description": "缩容Task节点", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "emr-4slr7ad7" }, { "name": "ResourceIds", "type": "array", "required": true, "description": "待销毁节点的资源ID列表。资源ID形如：emr-vm-xxxxxxxx。有效的资源ID可通过登录[控制台](https://console.cloud.tencent.com/emr)查询。", "example": "[\"emr-vm-xxx33tg\\r\\n\"]", "item_type": "string" } ], "required": [ "InstanceId", "ResourceIds" ] } ] }