有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: emr.tencentcloudapi.com 。

扩容节点

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ScaleOutInstance。
Version String 公共参数,本接口取值:2019-01-03。
Region String 公共参数,详见产品支持的 地域列表
TimeUnit String 扩容的时间单位。取值范围:
  • s:表示秒。PayMode取值为0时,TimeUnit只能取值为s。
  • m:表示月份。PayMode取值为1时,TimeUnit只能取值为m。

  • 示例值:s
    TimeSpan Integer 扩容的时长。结合TimeUnit一起使用。
  • TimeUnit为s时,该参数只能填写3600,表示按量计费实例。
  • TimeUnit为m时,该参数填写的数字表示包年包月实例的购买时长,如1表示购买一个月

  • 示例值:3600
    InstanceId String 实例ID。
    示例值:emr-5n3l5c83
    PayMode Integer 实例计费模式。取值范围:
  • 0:表示按量计费。
  • 1:表示包年包月。

  • 示例值:0
    ClientToken String 唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,例如 a9a90aa6-751a-41b6-aad6-fae36063280
    示例值:a9a90aa6-751a-41b6-aad6-fae36063280
    PreExecutedFileSettings.N Array of PreExecuteFileSettings 引导操作脚本设置。
    TaskCount Integer 扩容的Task节点数量。
    示例值:0
    CoreCount Integer 扩容的Core节点数量。
    示例值:1
    UnNecessaryNodeList.N Array of Integer 扩容时不需要安装的进程。
    示例值:[]
    RouterCount Integer 扩容的Router节点数量。
    示例值:0
    SoftDeployInfo.N Array of Integer 部署的服务。
  • SoftDeployInfo和ServiceNodeInfo是同组参数,和UnNecessaryNodeList参数互斥。
  • 建议使用SoftDeployInfo和ServiceNodeInfo组合。

  • 示例值:[]
    ServiceNodeInfo.N Array of Integer 启动的进程。
    示例值:[]
    DisasterRecoverGroupIds.N Array of String 分散置放群组ID列表,当前仅支持指定一个。
    示例值:[]
    Tags.N Array of Tag 扩容节点绑定标签列表。
    HardwareResourceType String 扩容所选资源类型,可选范围为"host","pod",host为普通的CVM资源,Pod为TKE集群或EKS集群提供的资源
    示例值:""
    PodSpec PodSpec 使用Pod资源扩容时,指定的Pod规格以及来源等信息
    ClickHouseClusterName String 使用clickhouse集群扩容时,选择的机器分组名称
    示例值:""
    ClickHouseClusterType String 使用clickhouse集群扩容时,选择的机器分组类型。new为新增,old为选择旧分组
    示例值:""
    YarnNodeLabel String 规则扩容指定 yarn node label
    示例值:""
    PodParameter PodParameter POD自定义权限和自定义参数
    MasterCount Integer 扩容的Master节点的数量。
    使用clickhouse集群扩容时,该参数不生效。
    使用kafka集群扩容时,该参数不生效。
    当HardwareResourceType=POD时,该参数不生效。
    示例值:1
    StartServiceAfterScaleOut String 扩容后是否启动服务,true:启动,false:不启动
    示例值:"true"
    ZoneId Integer 可用区,默认是集群的主可用区
    示例值:100002
    SubnetId String 子网,默认是集群创建时的子网
    示例值:sub-xxx
    ScaleOutServiceConfAssign String 预设配置组
    示例值:""
    AutoRenew Integer 0表示关闭自动续费,1表示开启自动续费
    示例值:1

    3. 输出参数

    参数名称 类型 描述
    InstanceId String 实例ID。
    示例值:emr-5n3l5c83
    DealNames Array of String 订单号。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["20200309357833","20200309357834","20200309357835","20200309357836"]
    ClientToken String 客户端Token。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    FlowId Integer 扩容流程ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    BillId String 大订单号。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 集群扩容

    输入示例

    POST / HTTP/1.1
    Host: emr.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ScaleOutInstance
    <公共请求参数>
    
    {
        "InstanceId": "emr-5n3l5c83",
        "TimeUnit": "s",
        "CoreCount": "1",
        "PayMode": "0",
        "TimeSpan": "3600"
    }

    输出示例

    {
        "Response": {
            "BillId": "",
            "ClientToken": "",
            "DealNames": [
                "20200309357833",
                "20200309357834",
                "20200309357835",
                "20200309357836"
            ],
            "FlowId": 0,
            "InstanceId": "emr-5n3l5c83",
            "RequestId": "f0f11d21-6d0d-4f73-9177-8ae4ec456068"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation 操作失败。
    FailedOperation.CheckIfSupportPodStretch 操作失败。
    FailedOperation.DuplicateOrderNotAllowed 重复的订单,请检查emr控制台。
    FailedOperation.GetCvmConfigQuotaFailed 获取cvm 规格信息失败。
    FailedOperation.GetCvmServerFailed 调用cvm服务失败。
    FailedOperation.NotSupportPod 操作失败,不支持pod。
    InternalError 内部错误。
    InternalError.AccountCgwError 内部服务调用异常。
    InternalError.CamCgwError 内部服务调用异常。
    InternalError.CamError 内部服务调用异常。
    InternalError.CbsCgwError 内部服务调用异常。
    InternalError.CbsError 内部服务调用异常。
    InternalError.CdbCgwError 内部服务调用异常。
    InternalError.CdbError 内部服务调用异常。
    InternalError.ConfigCgwError 内部服务调用异常。
    InternalError.CvmError 内部服务调用异常。
    InternalError.EKSError 调用EKS报错。
    InternalError.KmsError 内部服务调用异常。
    InternalError.ProjectCgwError 内部服务调用异常。
    InternalError.SgError 安全组接口调用异常。
    InternalError.TKEError TKE调用出错。
    InternalError.TagError 内部服务调用异常。
    InternalError.TradeCgwError 内部服务调用异常。
    InternalError.VpcCgwError 内部服务调用异常。
    InternalError.VpcError 内部服务调用异常。
    InternalError.WoodServerError 内部服务调用异常。
    InvalidParameter 参数错误。
    InvalidParameter.AppIdResourceNotMatch 参数错误。
    InvalidParameter.InvalidAppId 无效参数,AppId。
    InvalidParameter.InvalidClickHouseCluster 无效的ClickHouse集群。
    InvalidParameter.InvalidClientToken 无效的ClientToken。
    InvalidParameter.InvalidClusterId 无效参数,ClusterId。
    InvalidParameter.InvalidCoreCount Core节点数量无效。
    InvalidParameter.InvalidCount 扩容数量必须大于0。
    InvalidParameter.InvalidCountNum 同一请求只能扩容Task或者Core节点。
    InvalidParameter.InvalidCustomizedPodParam 错误信息:Invalid PodParameter。
    InvalidParameter.InvalidEksInstance 无效的EKS实例。
    InvalidParameter.InvalidInstanceName 无效的集群名称。
    InvalidParameter.InvalidJobFlow 无效的流程任务。
    InvalidParameter.InvalidPaymode 无效的付费类型。
    InvalidParameter.InvalidResourceSpec 无效的资源规格。
    InvalidParameter.InvalidSercurityGrpupId 无效的安全组ID。
    InvalidParameter.InvalidServiceNodeInfo 参数ServiceNodeInfo无效或错误。
    InvalidParameter.InvalidSoftDeployInfo 参数InvalidSoftDeployInfo无效或错误。
    InvalidParameter.InvalidTaskCount task的数量不能超过20。
    InvalidParameter.InvalidTimeSpan 无效的timespan。
    InvalidParameter.InvalidTimeUnit 无效的TimeUnit。
    InvalidParameter.InvalidTkeInstance 无效的Tke集群ID,或Tke集群不符合条件。
    InvalidParameterValue.InvalidTkeInstance 无效的Tke集群ID,或Tke集群不符合条件。
    ResourceInUse.InstanceInProcess 实例在流程中。
    ResourceInsufficient.DiskInsufficient 硬盘规格不满足。
    ResourceInsufficient.InstanceInsufficient 不支持或售罄的节点规格。
    ResourceNotFound.ClusterNotFound 无法找到该实例。
    ResourceNotFound.InstanceNotFound 无法找到该实例。
    ResourceNotFound.TKEPreconditionNotFound tke集群前置组件未部署。
    ResourceNotFound.TagsNotFound 没有查找到指定标签。
    ResourceUnavailable.ResourceSpecNotDefaultSpec 当前资源规格不存在默认规格。
    ResourcesSoldOut 资源售罄。
    ResourcesSoldOut.CbsSoldOut CBS资源售罄。
    ResourcesSoldOut.CvmSoldOut 云服务器已售罄。