Domain name for API request: emr.intl.tencentcloudapi.com.
This API is used to install a component. For components dependent on the MetaDB, a CDB order may be required. The components that can be installed on the current cluster and the components that might require a CDB order can be viewed via InstallSoftWareInfo.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: InstallSoftware. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-03. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Cluster ID. |
| SoftInfo.N | Yes | Array of String | Component version, for example, presto-0.161. You can view the components that can be installed on the current cluster via InstallSoftWareInfo. |
| CdbAutoRenew | No | String | If you use a monthly subscription cluster and need to purchase a CDB, determine whether to enable auto-renewal for the CDB. Default value: AUTO_RENEW. If auto-renewal is disabled for the newly-added CDB, fill in NOT_AUTO_RENEW. |
| MetaType | No | String | Hive shared metadata database type. Valid values: |
| UnifyMetaInstanceId | No | String | EMR-MetaDB instance. |
| MetaDBInfo | No | CustomMetaInfo | Custom MetaDB information. |
| ExternalService.N | No | Array of ExternalService | Shared component information. |
| Tags.N | No | Array of Tag | Tag information. |
| CloudResources.N | No | Array of CloudResource | Pod specification information of the role. |
| ServiceDeployInfoList.N | No | Array of ServiceDeployInfo | Custom deployment information. |
| DefaultMetaVersion | No | String | Database version. |
| NeedCdbAudit | No | Integer | Whether to enable audit. |
| ContainerExtraConf | No | ContainerExtraConf | Additional container configuration. |
| CheckServiceDeployInfo | No | Boolean | Whether to forcibly check the validity of custom components. Currently, it is available only for the Terraform side. |
| MetaDBGroupInfo.N | No | Array of CustomMetaDBInfo | Custom MetaDB information. |
| Parameter Name | Type | Description |
|---|---|---|
| ErrorMessages | Array of String | Verification error information. |
| FlowId | Integer | Flow ID. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InstallSoftware
<Common request parameters>
{
"InstanceId": "emr-onniypag",
"SoftInfo": [
"impala-4.1.1"
],
"CdbAutoRenew": null,
"MetaType": null,
"UnifyMetaInstanceId": null,
"MetaDBInfo": {
"MetaDataJdbcUrl": null,
"MetaDataUser": null,
"MetaDataPass": null
},
"ExternalService": [
{
"ShareType": null,
"Service": null,
"InstanceId": null,
"CustomServiceDefineList": [
{
"Name": null,
"Value": null
}
]
}
],
"Tags": [
{
"TagKey": null,
"TagValue": null
}
],
"CloudResources": [
{
"ComponentName": null,
"PodNumber": null,
"LimitCpu": null,
"LimitMemory": null,
"Service": null,
"VolumeDir": {
"VolumeType": null,
"HostPath": {
"Path": null,
"Type": null
}
},
"ExternalAccess": {
"Type": null,
"CLBServer": {
"CLBType": null,
"VPCSettings": {
"VpcId": null,
"SubnetId": null
}
}
},
"Affinity": {
"RequiredDuringSchedulingIgnoredDuringExecution": {
"NodeSelectorTerms": [
{
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
}
]
},
"PreferredDuringSchedulingIgnoredDuringExecution": [
{
"Weight": null,
"Preference": {
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
}
}
]
},
"Disks": [
{
"DiskType": null,
"DiskCapacity": null,
"DiskNumber": null
}
],
"Tolerations": [
{
"Key": null,
"Value": null,
"Operator": null,
"Effect": null,
"TolerationSeconds": null
}
],
"PodAffinity": {
"RequiredDuringSchedulingIgnoredDuringExecution": [
{
"LabelSelector": {
"MatchLabels": [
{
"Key": null,
"Value": null
}
],
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
},
"Namespaces": [
null
],
"TopologyKey": null,
"NamespaceSelector": {
"MatchLabels": [
{
"Key": null,
"Value": null
}
],
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
}
}
],
"PreferredDuringSchedulingIgnoredDuringExecution": [
{
"Weight": null,
"PodAffinityTerm": {
"LabelSelector": {
"MatchLabels": [
{
"Key": null,
"Value": null
}
],
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
},
"Namespaces": [
null
],
"TopologyKey": null,
"NamespaceSelector": {
"MatchLabels": [
{
"Key": null,
"Value": null
}
],
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
}
}
}
]
},
"PodAntiAffinity": {
"RequiredDuringSchedulingIgnoredDuringExecution": [
{
"LabelSelector": {
"MatchLabels": [
{
"Key": null,
"Value": null
}
],
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
},
"Namespaces": [
null
],
"TopologyKey": null,
"NamespaceSelector": {
"MatchLabels": [
{
"Key": null,
"Value": null
}
],
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
}
}
],
"PreferredDuringSchedulingIgnoredDuringExecution": [
{
"Weight": null,
"PodAffinityTerm": {
"LabelSelector": {
"MatchLabels": [
{
"Key": null,
"Value": null
}
],
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
},
"Namespaces": [
null
],
"TopologyKey": null,
"NamespaceSelector": {
"MatchLabels": [
{
"Key": null,
"Value": null
}
],
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
}
}
}
]
},
"TopologySpreadConstraints": [
{
"MaxSkew": null,
"TopologyKey": null,
"WhenUnsatisfiable": null,
"LabelSelector": {
"MatchLabels": [
{
"Key": null,
"Value": null
}
],
"MatchExpressions": [
{
"Key": null,
"Operator": null,
"Values": [
null
]
}
]
},
"MinDomains": null,
"NodeAffinityPolicy": null,
"NodeTaintsPolicy": null,
"MatchLabelKeys": [
null
]
}
],
"PodLabels": [
{
"Key": null,
"Value": null
}
],
"EnableDefaultRayCluster": null,
"ImageInfoV2": {
"ImageMode": null,
"Region": null,
"LegacyCCR": null,
"FullImageUrl": null,
"MainVersion": null,
"RegistryUrl": null,
"NamespaceName": null,
"RepoName": null,
"Tag": null,
"Username": null,
"Password": null,
"ImagePullSecret": {
"SourceNamespace": null,
"SecretNames": [
null
]
},
"ImagePullPolicy": null
},
"DynamicInstanceForm": {
"DynamicInstanceName": null,
"Namespace": null,
"SupportHA": null,
"CustomImage": {
"ImageSourceType": null,
"ImageInfo": {
"Region": null,
"RegistryId": null,
"DomainName": null,
"NamespaceName": null,
"RepositoryName": null,
"ImageVersion": null,
"ImagePullPolicy": null,
"Image": null
},
"ImagePullSecret": {
"SourceNamespace": null,
"SecretNames": [
null
]
}
},
"DynamicInstanceGroups": [
{
"GroupType": null,
"GroupName": null,
"PodCpu": null,
"PodMem": null,
"PodGpuType": null,
"PodGpu": null,
"PodNum": null,
"MinPodNum": null,
"MaxPodNum": null,
"SupportPV": null,
"CBSVolumes": [
{
"VolumeName": null,
"DiskType": null,
"DiskSize": null,
"DiskCount": null
}
],
"CFSVolumes": [
{
"VolumeName": null,
"FileSystemId": null,
"FSId": null,
"Host": null,
"SubPath": null
}
],
"COSVolumes": [
{
"VolumeName": null,
"Secret": null,
"Region": null,
"Bucket": null,
"SubPath": null
}
],
"VolumeMounts": [
{
"MountName": null,
"MountPath": null,
"SubPathMode": null,
"SubPath": null,
"MountMode": null
}
],
"Labels": [
{
"Name": null,
"Value": null
}
],
"Tolerations": [
{
"Key": null,
"Value": null,
"Operator": null,
"Effect": null,
"TolerationSeconds": null
}
],
"Envs": [
{
"Name": null,
"Value": null
}
],
"SchedulingPolicy": null,
"ResourceLabel": null,
"PodGpuResourceKey": null,
"CFSTurboVolumes": [
{
"VolumeName": null,
"FileSystemId": null,
"FSId": null,
"Host": null,
"SubPath": null,
"RootDir": null
}
],
"GooseFSVolumes": [
{
"VolumeName": null,
"ClusterId": null,
"Namespace": null,
"SubPath": null,
"FuseVersion": null,
"ClientVersion": null,
"MountOptions": null,
"JvmOptions": null
}
],
"PreStartCommand": null,
"RayStartParams": null
}
],
"SupportPV": null,
"CBSVolumes": [
{
"VolumeName": null,
"DiskType": null,
"DiskSize": null,
"DiskCount": null
}
],
"CFSVolumes": [
{
"VolumeName": null,
"FileSystemId": null,
"FSId": null,
"Host": null,
"SubPath": null
}
],
"COSVolumes": [
{
"VolumeName": null,
"Secret": null,
"Region": null,
"Bucket": null,
"SubPath": null
}
],
"VolumeMounts": [
{
"MountName": null,
"MountPath": null,
"SubPathMode": null,
"SubPath": null,
"MountMode": null
}
],
"Labels": [
{
"Name": null,
"Value": null
}
],
"Tolerations": [
{
"Key": null,
"Value": null,
"Operator": null,
"Effect": null,
"TolerationSeconds": null
}
],
"Envs": [
{
"Name": null,
"Value": null
}
],
"DependServices": [
{
"ServiceName": null,
"InstanceId": null
}
],
"SupportToken": null,
"CFSTurboVolumes": [
{
"VolumeName": null,
"FileSystemId": null,
"FSId": null,
"Host": null,
"SubPath": null,
"RootDir": null
}
],
"ImageInfoV2": {
"ImageMode": null,
"Region": null,
"LegacyCCR": null,
"FullImageUrl": null,
"MainVersion": null,
"RegistryUrl": null,
"NamespaceName": null,
"RepoName": null,
"Tag": null,
"Username": null,
"Password": null,
"ImagePullSecret": {
"SourceNamespace": null,
"SecretNames": [
null
]
},
"ImagePullPolicy": null
},
"GooseFSVolumes": [
{
"VolumeName": null,
"ClusterId": null,
"Namespace": null,
"SubPath": null,
"FuseVersion": null,
"ClientVersion": null,
"MountOptions": null,
"JvmOptions": null
}
]
}
}
],
"ServiceDeployInfoList": [
{
"ServiceName": "impala-4.1.1",
"ComponentDeployInfoList": [
{
"ComponentName": "Impala-Catalog",
"DeployHostUuidList": [
"9ad16989-7b4e-47aa-8c77-ee01b6582a76"
]
},
{
"ComponentName": "Impala-Daemon",
"DeployHostUuidList": [
"3bb6382e-1e5d-48c7-9817-dde061a7a5b1"
]
},
{
"ComponentName": "Impala-Statestore",
"DeployHostUuidList": [
"9ad16989-7b4e-47aa-8c77-ee01b6582a76"
]
}
]
}
],
"DefaultMetaVersion": null,
"NeedCdbAudit": null,
"ContainerExtraConf": {
"JobAccessProxyType": null
},
"CheckServiceDeployInfo": true
}{
"Response": {
"Error": {
"Code": "FailedOperation.FlowRejected",
"Message": "[Add Service] rejected. The flow [Uninstall Service IMPALA] is being executed."
},
"RequestId": "eaf2447c-e7bb-49fb-8177-bbb86527fdf2"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InsufficientAccountBalance | Insufficient balance. |
| InternalError | Internal error. |
| InternalError.AccountCgwError | Internal service call exception. |
| InternalError.CamCgwError | Internal service call exception. |
| InternalError.CamError | Internal service call exception. |
| InternalError.CbsCgwError | Internal service call exception. |
| InternalError.CbsError | Internal service call exception. |
| InternalError.CdbCgwError | Internal service call exception. |
| InternalError.CdbError | Internal service call exception. |
| InternalError.CheckQuotaErr | Insufficient CVM or CBS resources, or invalid software. |
| InternalError.ConfigCgwError | Internal service call exception. |
| InternalError.CvmError | Internal service call exception. |
| InternalError.KmsError | Internal service call exception. |
| InternalError.ProjectCgwError | Internal service call exception. |
| InternalError.SgError | An exception occurred when the security group API is called. |
| InternalError.TagError | Internal service call exception. |
| InternalError.TradeCgwError | Internal service call exception. |
| InternalError.VpcCgwError | Internal service call exception. |
| InternalError.VpcError | Internal service call exception. |
| InternalError.WoodServerError | Internal service call exception. |
| InvalidParameter | Parameter error. |
| InvalidParameter.InvalidAppId | Invalid parameter: APPID. |
| InvalidParameter.InvalidClassification | Invalid Classification parameter value. |
| InvalidParameter.InvalidClusterId | Invalid parameter: ClusterId. |
| InvalidParameter.InvalidConfigType | The delivered configuration file type is invalid. |
| InvalidParameter.InvalidCoreCount | Invalid Core node quantity. |
| InvalidParameter.InvalidCosFileURI | Invalid CosFileUri parameter value. |
| InvalidParameter.InvalidCount | The scale-out quantity must be greater than 0. |
| InvalidParameter.InvalidCountNum | The same request can only scale out Task or Core nodes. |
| InvalidParameter.InvalidDownloadObj | Invalid download object parameter value. |
| InvalidParameter.InvalidExportConfContexts | The specified parameter for exporting configuration files is incorrect. |
| InvalidParameter.InvalidExtendField | Invalid CustomConfig parameter value. |
| InvalidParameter.InvalidExtendNameService | Invalid NameServiceName parameter value. |
| InvalidParameter.InvalidFilePath | Invalid file path parameter value. |
| InvalidParameter.InvalidIpList | The specified termination IP address is invalid. |
| InvalidParameter.InvalidJobFlow | Invalid flow task. |
| InvalidParameter.InvalidMetaType | Invalid metadata table type. |
| InvalidParameter.InvalidModifySpec | Invalid specifications for configuration change. |
| InvalidParameter.InvalidNodeType | Invalid NodeType. |
| InvalidParameter.InvalidParamterInvalidSoftInfo | The SoftInfo parameter is invalid. |
| InvalidParameter.InvalidPassword | Invalid password. |
| InvalidParameter.InvalidPaymode | Invalid payment type. |
| InvalidParameter.InvalidPodNum | Invalid PodNum parameter. |
| InvalidParameter.InvalidRegion | Invalid Region parameter value. |
| InvalidParameter.InvalidResType | Invalid ResType value. |
| InvalidParameter.InvalidResourceId | Invalid resource ID. |
| InvalidParameter.InvalidRouterCount | Invalid number of Router nodes to be scaled out. |
| InvalidParameter.InvalidServiceName | Invalid service name. |
| InvalidParameter.InvalidSoftDeployInfo | The InvalidSoftDeployInfo parameter is invalid or incorrect. |
| InvalidParameter.InvalidSoftInfo | The SoftInfo parameter is invalid. |
| InvalidParameter.InvalidSoftWareName | Invalid software name. |
| InvalidParameter.InvalidSoftWareVersion | Invalid software version. |
| InvalidParameter.InvalidTaskCount | The number of tasks cannot exceed 20. |
| InvalidParameter.InvalidTimeSpan | Invalid timespan. |
| InvalidParameter.InvalidTimeUnit | Invalid TimeUnit. |
| InvalidParameter.InvalidUnifyMeta | Invalid unified metadata database. |
| InvalidParameter.InvalidWriteFile | Invalid WriteFile parameter value in cosFileUri. |
| InvalidParameterValue | Parameter value error. |
| LimitExceeded.PodCpuLimitExceededAvailableCpu | The CPU request quantity of the Pod exceeds the cluster limit. |
| LimitExceeded.PodCpuLimitExceededNodeAvailableCpu | The CPU request quantity of the Pod exceeds the node limit. |
| MissingParameter | Missing parameter error. |
| ResourceInUse.InstanceInProcess | The instance is in process. |
| ResourceNotFound.ClusterNotFound | The instance cannot be found. |
| ResourceNotFound.InstanceNotFound | The instance cannot be found. |
| ResourceNotFound.MetricsMetaNotFound | The monitoring metadata cannot be found. |
| ResourceNotFound.OptionalSpecFound | The cluster does not have alternative specifications. |
| ResourceNotFound.ServiceConfNotFound | The service component configuration cannot be found. |
| ResourceNotFound.ServiceGroupNotFound | The service component cannot be found. |
| ResourceNotFound.ServiceNodeNotFound | The service node is not found. |
| ResourcesSoldOut | Resources have been sold out. |
| UnauthorizedOperation.CheckCamAuth | No permission to verify account operations. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | The operation is not supported. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback