1. 接口描述
接口请求域名： emr.tencentcloudapi.com 。
安装组件。对于依赖元数据库的组件，有可能会需要下单一个cdb。可根据InstallSoftWareInfo查看当前集群可安装的组件，以及哪些组件有可能需要cdb。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：InstallSoftware。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-03。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群实例号 示例值：emr-331dcki |
| SoftInfo.N | 是 | Array of String | 组件版本号，例如presto-0.161，可根据InstallSoftWareInfo查看当前集群可安装的组件 示例值：["sqoop-1.4.6\r\n"] |
| CdbAutoRenew | 否 | String | 如果需要购买CDB，如果是包年包月集群，是否为这个cdb自动续费，默认AUTO_RENEW,如不自动续费新增的CDB，则填入NOT_AUTO_RENEW 示例值：AUTO_RENEW |
| MetaType | 否 | String | hive共享元数据库类型。取值范围： 示例值：EMR_DEFAULT_META |
| UnifyMetaInstanceId | 否 | String | EMR-MetaDB实例 示例值：cab-fasdf232 |
| MetaDBInfo | 否 | CustomMetaInfo | 自定义MetaDB信息 |
| ExternalService.N | 否 | Array of ExternalService | 共用组件信息 |
| Tags.N | 否 | Array of Tag | 标签信息 |
| CloudResources.N | 否 | Array of CloudResource | 角色的Pod规格信息 |
| ServiceDeployInfoList.N | 否 | Array of ServiceDeployInfo | 自定义部署信息 |
| DefaultMetaVersion | 否 | String | 数据库版本 示例值：mysql8 |
| NeedCdbAudit | 否 | Integer | 是否开通审计 示例值：0 |
| ContainerExtraConf | 否 | ContainerExtraConf | 额外容器相关配置 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ErrorMessages | Array of String | 校验错误信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：["missing key"] |
| FlowId | Integer | 流程id 示例值：21 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 安装服务
输入示例
POST / HTTP/1.1
Host: emr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InstallSoftware
<公共请求参数>
{
"ExternalService": [],
"InstanceId": "emr-16ybdkys",
"SoftInfo": [
"delta-2.2.0"
]
}输出示例
{
"Response": {
"ErrorMessages": null,
"RequestId": "a7f4bda9-8fc5-4b32-9cc2-7178200d4719"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.InsufficientAccountBalance | 余额不足 |
| InternalError | 内部错误。 |
| InternalError.AccountCgwError | 内部服务调用异常。 |
| InternalError.CamCgwError | 内部服务调用异常。 |
| InternalError.CamError | 内部服务调用异常。 |
| InternalError.CbsCgwError | 内部服务调用异常。 |
| InternalError.CbsError | 内部服务调用异常。 |
| InternalError.CdbCgwError | 内部服务调用异常。 |
| InternalError.CdbError | 内部服务调用异常。 |
| InternalError.CheckQuotaErr | cvm或cbs资源不够或软件不合法。 |
| InternalError.ConfigCgwError | 内部服务调用异常。 |
| InternalError.CvmError | 内部服务调用异常。 |
| InternalError.KmsError | 内部服务调用异常。 |
| InternalError.ProjectCgwError | 内部服务调用异常。 |
| InternalError.SgError | 安全组接口调用异常。 |
| InternalError.TagError | 内部服务调用异常。 |
| InternalError.TradeCgwError | 内部服务调用异常。 |
| InternalError.VpcCgwError | 内部服务调用异常。 |
| InternalError.VpcError | 内部服务调用异常。 |
| InternalError.WoodServerError | 内部服务调用异常。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidAppId | 无效参数，AppId。 |
| InvalidParameter.InvalidClassification | Classification参数值无效。 |
| InvalidParameter.InvalidClusterId | 无效参数，ClusterId。 |
| InvalidParameter.InvalidConfigType | 无效的下发配置文件类型。 |
| InvalidParameter.InvalidCoreCount | Core节点数量无效。 |
| InvalidParameter.InvalidCosFileURI | CosFileUri参数值无效。 |
| InvalidParameter.InvalidCount | 扩容数量必须大于0。 |
| InvalidParameter.InvalidCountNum | 同一请求只能扩容Task或者Core节点。 |
| InvalidParameter.InvalidDownloadObj | 下载对象参数值无效。 |
| InvalidParameter.InvalidExportConfContexts | 指定的将导出配置文件参数有误。 |
| InvalidParameter.InvalidExtendField | CustomConfig参数值无效。 |
| InvalidParameter.InvalidExtendNameService | NameServiceName参数值无效。 |
| InvalidParameter.InvalidFilePath | 文件路径参数值无效。 |
| InvalidParameter.InvalidIpList | 指定的销毁IP无效。 |
| InvalidParameter.InvalidJobFlow | 无效的流程任务。 |
| InvalidParameter.InvalidMetaType | 无效的元数据表类型。 |
| InvalidParameter.InvalidModifySpec | 变配规格无效。 |
| InvalidParameter.InvalidNodeType | 无效的NodeType。 |
| InvalidParameter.InvalidParamterInvalidSoftInfo | 无效的SoftInfo。 |
| InvalidParameter.InvalidPassword | 无效密码。 |
| InvalidParameter.InvalidPaymode | 无效的付费类型。 |
| InvalidParameter.InvalidPodNum | PodNum参数无效。 |
| InvalidParameter.InvalidRegion | Region参数值无效。 |
| InvalidParameter.InvalidResType | ResType值无效。 |
| InvalidParameter.InvalidResourceId | 无效资源ID。 |
| InvalidParameter.InvalidRouterCount | 扩容Router节点数量无效。 |
| InvalidParameter.InvalidServiceName | 服务名无效。 |
| InvalidParameter.InvalidSoftDeployInfo | 参数InvalidSoftDeployInfo无效或错误。 |
| InvalidParameter.InvalidSoftInfo | 无效的SoftInfo。 |
| InvalidParameter.InvalidSoftWareName | 软件名无效。 |
| InvalidParameter.InvalidSoftWareVersion | 软件版本无效。 |
| InvalidParameter.InvalidTaskCount | task的数量不能超过20。 |
| InvalidParameter.InvalidTimeSpan | 无效的timespan。 |
| InvalidParameter.InvalidTimeUnit | 无效的TimeUnit。 |
| InvalidParameter.InvalidUnifyMeta | 无效的统一元数据库。 |
| InvalidParameter.InvalidWriteFile | cosFileUri中的WriteFile参数值无效。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded.PodCpuLimitExceededAvailableCpu | Pod Cpu请求数量超过集群限制。 |
| LimitExceeded.PodCpuLimitExceededNodeAvailableCpu | Pod Cpu请求数量超过节点限制。 |
| MissingParameter | 缺少参数错误。 |
| ResourceInUse.InstanceInProcess | 实例在流程中。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
| ResourceNotFound.MetricsMetaNotFound | 无法找到监控元数据。 |
| ResourceNotFound.OptionalSpecFound | 该集群没有备选规格。 |
| ResourceNotFound.ServiceConfNotFound | 无法找到服务组件配置。 |
| ResourceNotFound.ServiceGroupNotFound | 无法找到该服务组件。 |
| ResourceNotFound.ServiceNodeNotFound | 服务节点没有找到。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation.CheckCamAuth | 校验账号操作无权限。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
