Domain name for API request: emr.tencentcloudapi.com.
This API is used to create EMR instance.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: emr.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: CreateInstance. |
| Version | Yes | String | Common parameter. The value used for this API: 2019-01-03. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| ProductId | Yes | Integer | Product ID. Different product IDs represent different EMR product versions. Valid values: |
| VPCSettings | Yes | VPCSettings | Configuration information of VPC. This parameter is used to specify the VPC ID, subnet ID, etc. |
| Software.N | Yes | Array of String | List of deployed components. Different required components need to be selected for different EMR product IDs (i.e., ProductId; for specific meanings, please see the ProductId field in the input parameter):ProductId is 1, the required components include hadoop-2.7.3, knox-1.2.0, and zookeeper-3.4.9ProductId is 2, the required components include hadoop-2.7.3, knox-1.2.0, and zookeeper-3.4.9ProductId is 4, the required components include hadoop-2.8.4, knox-1.2.0, and zookeeper-3.4.9ProductId is 7, the required components include hadoop-3.1.2, knox-1.2.0, and zookeeper-3.4.9 |
| ResourceSpec | Yes | NewResourceSpec | Node resource specification. |
| SupportHA | Yes | Integer | Whether to enable high node availability. Valid values: |
| InstanceName | Yes | String | Instance name. |
| PayMode | Yes | Integer | Instance billing mode. Valid values: |
| Placement | Yes | Placement | Instance location. This parameter is used to specify the AZ, project, and other attributes of the instance. |
| TimeSpan | Yes | Integer | Purchase duration of instance, which needs to be used together with TimeUnit.TimeUnit is s, this parameter can only be filled with 3600, indicating a pay-as-you-go instance.TimeUnit is m, the number entered in this parameter indicates the purchase duration of the monthly-subscription instance; for example, 1 means one month |
| TimeUnit | Yes | String | Time unit of instance purchase duration. Valid values:PayMode is 0, TimeUnit can only be s.PayMode is 1, TimeUnit can only be m. |
| LoginSettings | Yes | LoginSettings | Instance login settings. This parameter allows you to set the login password or key for your purchased node. |
| COSSettings | No | COSSettings | Parameter required for enabling COS access. |
| SgId | No | String | Security group to which an instance belongs in the format of sg-xxxxxxxx. This parameter can be obtained from the SecurityGroupId field in the return value of the DescribeSecurityGroups API. |
| PreExecutedFileSettings.N | No | Array of PreExecuteFileSettings | Bootstrap script settings. |
| AutoRenew | No | Integer | Whether auto-renewal is enabled. Valid values: |
| ClientToken | No | String | Client token. |
| NeedMasterWan | No | String | Whether to enable public IP access for master node. Valid values: |
| RemoteLoginAtCreate | No | Integer | Whether to enable remote public network login, i.e., port 22. When SgId is not empty, this parameter does not take effect. |
| CheckSecurity | No | Integer | Whether to enable secure cluster. 0: no; other values: yes. |
| ExtendFsField | No | String | Accesses to external file system. |
| Tags.N | No | Array of Tag | Tag description list. This parameter is used to bind a tag to a resource instance. |
| DisasterRecoverGroupIds.N | No | Array of String | List of spread placement group IDs. Only one can be specified currently. |
| CbsEncrypt | No | Integer | CBS disk encryption at the cluster level. 0: not encrypted, 1: encrypted |
| MetaType | No | String | Hive-shared metadatabase type. Valid values: |
| UnifyMetaInstanceId | No | String | EMR-MetaDB instance |
| MetaDBInfo | No | CustomMetaInfo | Custom MetaDB instance information |
| ApplicationRole | No | String | Custom application role. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://emr.tencentcloudapi.com/?Action=CreateInstance
&ProductId=4
&SupportHA=0
&InstanceName=emr test
&PayMode=0
&Placement.Zone=ap-guangzhou-3
&Placement.ProjectId=0
&AutoRenew=0
&Software.0=hadoop-2.8.4
&Software.1=zookeeper-3.4.9
&Software.2=knox-1.2.0
&ResourceSpec.MasterResourceSpec.MemSize=8192
&ResourceSpec.MasterResourceSpec.Cpu=4
&ResourceSpec.MasterResourceSpec.DiskSize=100
&ResourceSpec.MasterResourceSpec.DiskType=CLOUD_PREMIUM
&ResourceSpec.MasterResourceSpec.Spec=CVM.S2
&ResourceSpec.MasterResourceSpec.RootSize=100
&ResourceSpec.MasterResourceSpec.StorageType=5
&ResourceSpec.CoreResourceSpec.MemSize=8192
&ResourceSpec.CoreResourceSpec.Cpu=4
&ResourceSpec.CoreResourceSpec.DiskSize=100
&ResourceSpec.CoreResourceSpec.DiskType=CLOUD_PREMIUM
&ResourceSpec.CoreResourceSpec.Spec=CVM.S2
&ResourceSpec.CoreResourceSpec.RootSize=100
&ResourceSpec.CoreResourceSpec.StorageType=5
&ResourceSpec.MasterCount=1
&ResourceSpec.CoreCount=2
&VPCSettings.VpcId=vpc-ezt5qmqz
&VPCSettings.SubnetId=subnet-jhgsahx0
&LoginSettings.Password=tencent@cloud123
&TimeSpan=3600
&TimeUnit=s
&<Common request parameters>
{
"Response": {
"RequestId": "d830face-6587-4263-8ab0-56bda265787d"
}
}
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.DuplicateOrderNotAllowed | Duplicate order. Please check the EMR console. |
| InternalError | Internal error. |
| InternalError.AccountCgwError | An error occurred while calling another service API. |
| InternalError.CamCgwError | An error occurred while calling another service API. |
| InternalError.CamError | An error occurred while calling another service API. |
| InternalError.CbsCgwError | An error occurred while calling another service API. |
| InternalError.CbsError | An error occurred while calling another service API. |
| InternalError.CdbCgwError | An error occurred while calling another service API. |
| InternalError.CdbError | An error occurred while calling another service API. |
| InternalError.CheckQuotaErr | CVM or CBS resources are insufficient, or the software is invalid. |
| InternalError.ConfigCgwError | An error occurred while calling another service API. |
| InternalError.CvmError | An error occurred while calling another service API. |
| InternalError.KmsError | An error occurred while calling another service API. |
| InternalError.ProjectCgwError | An error occurred while calling another service API. |
| InternalError.SgError | An error occurred when calling a security group API. |
| InternalError.TagError | An error occurred while calling another service API. |
| InternalError.TradeCgwError | An error occurred while calling another service API. |
| InternalError.VpcCgwError | An error occurred while calling another service API. |
| InternalError.VpcError | An error occurred while calling another service API. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.IncorrectCommonCount | The number of common nodes is invalid. |
| InvalidParameter.IncorrectMasterCount | The number of master nodes is invalid. |
| InvalidParameter.InvaildCoreCount | The number of core nodes cannot exceed 20. |
| InvalidParameter.InvalidAutoRenew | Invalid auto-renewal flag. |
| InvalidParameter.InvalidClientToken | Invalid ClientToken. |
| InvalidParameter.InvalidComponent | Invalid component. |
| InvalidParameter.InvalidCoreCount | The number of core nodes is invalid. |
| InvalidParameter.InvalidInstanceName | Invalid cluster name. |
| InvalidParameter.InvalidLoginSetting | Invalid login settings. |
| InvalidParameter.InvalidPassword | Invalid password. |
| InvalidParameter.InvalidPaymode | Invalid billing mode. |
| InvalidParameter.InvalidPreExecutedFile | Invalid bootstrap script. |
| InvalidParameter.InvalidProductId | Invalid product ID. |
| InvalidParameter.InvalidProjectId | Invalid project ID. |
| InvalidParameter.InvalidResourceSpec | Invalid resource specification. |
| InvalidParameter.InvalidSercurityGrpupId | Invalid security group ID. |
| InvalidParameter.InvalidServiceName | The service name is invalid. |
| InvalidParameter.InvalidSoftDeployInfo | The InvalidSoftDeployInfo parameter is invalid or incorrect. |
| InvalidParameter.InvalidSoftInfo | Invalid SoftInfo. |
| InvalidParameter.InvalidSoftWareVersion | The software version is invalid. |
| InvalidParameter.InvalidSubnetId | Invalid subnet ID. |
| InvalidParameter.InvalidSupportHA | Invalid high availability parameter. |
| InvalidParameter.InvalidTimeSpan | Invalid timespan. |
| InvalidParameter.InvalidTimeUnit | Invalid TimeUnit. |
| InvalidParameter.InvalidVpcId | Invalid VPC ID. |
| InvalidParameter.InvalidZone | Invalid AZ. |
| InvalidParameter.NotContainMustSelectSoftware | Invalid parameter. Necessary components are missing. |
| InvalidParameter.PayModeResourceNotMatch | The billing mode and resource do not match. |
| InvalidParameter.SoftwareNotInProduct | There is an invalid product component. |
| InvalidParameter.UngrantedPolicy | The policy is not authorized. |
| InvalidParameter.UngrantedRole | The role is not authorized. |
| InvalidParameter.ZoneResourceNotMatch | The AZ and resource do not match. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| ResourceInsufficient.DiskInsufficient | The disk specification is insufficient. |
| ResourceInsufficient.InstanceInsufficient | The node specification is unsupported or has been sold out. |
| ResourceNotFound.TagsNotFound | No specified tag found. |
| ResourcesSoldOut. | The resources have been sold out. |
| ResourcesSoldOut.CbsSoldOut | The CBS resources have been sold out. |
| ResourcesSoldOut.CvmSoldOut | CVM instances have been sold out. |
| UnknownParameter | Unknown parameter. |
| UnsupportedOperation | Unsupported operation. |
Was this page helpful?