調用CreateClusterV2,創建一個Databricks 數據洞察集群。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateClusterV2 |
系統規定參數。取值:CreateClusterV2。 |
Name | String | 是 | bi_spark |
集群的名字。長度限制為 1-64 個字符,只允許包含中文、字母、數字、-、_。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。目前支持華東 1、華東 2、華南 1、華北 2、華北 3、美西、新加坡、德國。 |
ZoneId | String | 是 | cn-hangzhou-b |
可用區ID。 華東 1(杭州)支持:cn-hangzhou-b、cn-hangzhou-e、cn-hangzhou-f、cn-hangzhou-g、cn-hangzhou-h、cn-hangzhou-i。 華東 2(上海)支持:cn-shanghai-a、cn-shanghai-b、cn-shanghai-c、cn-shanghai-d、cn-shanghai-e、cn-shanghai-f、cn-shanghai-g。 華北 2(北京)支持:cn-beijing-a、cn-beijing-b、cn-beijing-c、cn-beijing-d、cn-beijing-e、cn-beijing-f、cn-beijing-g 華南 1(深圳)支持:cn-shenzhen-a、cn-shenzhen-b、cn-shenzhen-c、cn-shenzhen-d。 華北 5(呼和浩特)支持:cn-huhehaote-a、cn-huhehaote-b。 美國(弗吉尼亞)支持:us-east-1a、us-east-1b。 |
LogPath | String | 否 | oss//bucketname/path |
ath OSS日志路徑。 |
SecurityGroupId | String | 否 | sg-bp1id7ajv83kmqwq**** |
安全組 ID。可以在ECS中創建一個然后使用。需要確認的是,如果使用已有的安全組,會被增加上默認安全組策略:入只開放22端口,出開放所有端口。 |
IsOpenPublicIp | Boolean | 否 | true |
是否開啟公網IP。如果開啟,默認會帶有8MB的帶寬 |
SecurityGroupName | String | 否 | ddi-sg |
需要新建的安全組名稱。如果不指定安全組ID,那么將使用這個名字創建一個新的安全組。當集群創建完成以后,可以在集群詳情中看到創建的安全組ID。這個安全組將會帶有默認的安全組策略:入只開放22端口,出開放所有端口 |
ChargeType | String | 否 | PostPaid |
付費類型: PostPaid:按量付費。 PrePaid:包年包月。 |
Period | Integer | 否 | 30 |
包年包月時間(包月數有:1、2、3、4、5、6、7、8、9、12、24、36)。ChargeType=PrePaid 時,必填。 |
Auto | Boolean | 否 | false |
包年包月集群是否自動續費 |
AutoPayOrder | Boolean | 否 | true |
是否自動付費。 |
VpcId | String | 否 | vpc-bp1l4urd87xlh7i4b**** |
VPC ID,NetType=vpc時必填。 |
VSwitchId | String | 否 | vsw-bp10tvjyc77psy0z5**** |
交換機ID,NetType=vpc時必填。 |
NetType | String | 否 | vpc |
網絡類型。 |
UserDefinedEmrEcsRole | String | 否 | AliyunDDIAccessingOSSRole |
用于免AK訪問OSS的Role |
EmrVer | String | 是 | DDI-v1.0 |
Databricks 數據洞察版本號 |
ClusterType | String | 是 | 標準型 |
集群類型。 |
EnableHighAvailability | Boolean | 否 | true |
是否開啟高可用集群。如果開啟高可用,需要兩臺Master節點。 |
UseLocalMetaDb | Boolean | 否 | true |
是否使用本地Hive元數據庫。 |
EnableSsh | Boolean | 否 | true |
是否開啟SSH。 |
InstanceGeneration | String | 否 | ecs-3 |
ECS實例分代。 |
MasterPwd | String | 否 | pwd |
Master節點SSH訪問密碼。需要滿足ECS的密碼規則:8-30個字符,且同時包含任意三項(大、小寫字母、數字和特殊符號)。 |
KeyPairName | String | 否 | test_pair |
密鑰對。 |
MetaStoreType | String | 否 | local |
統一元數據類型。 |
MetaStoreConf | String | 否 | rds-xxx.com |
統一元數據的配置信息。 |
ClickHouseConf | String | 否 | 0 |
保留字段。 |
ExtraAttributes | String | 否 | [] |
附加屬性 |
DepositType | String | 否 | HALF_MANAGED |
托管類型。 |
MachineType | String | 否 | ECS |
機器類型。 |
UseCustomHiveMetaDB | Boolean | 否 | false |
保留字段,無需填寫。 |
InitCustomHiveMetaDB | Boolean | 否 | false |
保留字段,無需填寫。 |
Configurations | String | 否 | 0 |
保留字段,無需填寫。 |
EnableEas | Boolean | 否 | false |
是否高安全集群。 |
RelatedClusterId | String | 否 | C-D7958B72E59B**** |
當前集群是gateway時,其關聯的主集群ID。 |
WhiteListType | String | 否 | IP |
白名單類型。取值: IP:IP白名單分組。 SecurityGroup:安全組。 默認為:IP。 |
AuthorizeContent | String | 否 | 0 |
保留字段,無需填寫。 |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4p**** |
實例和節點ECS實例所在的企業資源組ID。 |
ClientToken | String | 否 | [] |
客戶端令牌。 |
UserInfo.N.Password | String | 是 | pwd |
Knox用戶的密碼。 |
UserInfo.N.UserId | String | 是 | 123456789 |
Knox用戶的用戶RAM ID。 |
UserInfo.N.UserName | String | 是 | username |
Knox用戶的用戶名。 |
HostComponentInfo.N.ComponentNameList.N | String | 否 | 無 |
組件列表 |
HostComponentInfo.N.HostName | String | 否 | ddi-header-1 |
主機名。 |
HostComponentInfo.N.ServiceName | String | 否 | SPARK |
服務名。 |
ServiceInfo.N.ServiceName | String | 否 | SPARK |
服務名。 |
ServiceInfo.N.ServiceVersion | String | 否 | 2.3.3-1.0.2 |
服務內部版本。 |
PromotionInfo.N.ProductCode | String | 否 | [] |
促銷信息,產品代碼。 |
PromotionInfo.N.PromotionOptionCode | String | 否 | [] |
促銷信息,促銷選項代碼。 |
PromotionInfo.N.PromotionOptionNo | String | 否 | [] |
促銷信息 促銷編號 |
HostGroup.N.AutoRenew | Boolean | 否 | false |
機器組機器是否自動續費。 |
HostGroup.N.ChargeType | String | 否 | PostPaid |
機器組機器付費類型。 |
HostGroup.N.ClusterId | String | 否 | 0 |
保留字段,無需填寫。 |
HostGroup.N.Comment | String | 否 | 0 |
保留字段,無需填寫。 |
HostGroup.N.CreateType | String | 否 | 0 |
保留字段,無需填寫。 |
HostGroup.N.DiskCapacity | Integer | 是 | 80 |
機器組的數據盤容量。 |
HostGroup.N.DiskCount | Integer | 是 | 4 |
機器組的數據盤數量。 |
HostGroup.N.DiskType | String | 是 | CLOUD_ESSD |
機器組的數據盤類型。 |
HostGroup.N.GpuDriver | String | 否 | cuda9 |
GPU驅動。 |
HostGroup.N.HostGroupId | String | 否 | 0 |
保留字段,無需填寫。 |
HostGroup.N.HostGroupName | String | 是 | 主實例組 |
主實例組 |
HostGroup.N.HostGroupType | String | 是 | MASTER |
機器組類型,枚舉值: MASTER Worker |
HostGroup.N.InstanceType | String | 是 | ecs.g5.2xlargeg |
機器組型號 |
HostGroup.N.NodeCount | Integer | 是 | 2 |
機器組節點數。 |
HostGroup.N.Period | Integer | 否 | 36 |
包年包月時間(包月數有1、2、3、4、5、6、7、8、9、12、24、36)。HostGroup.n.ChargeType=PrePaid時,必填。 |
HostGroup.N.SysDiskCapacity | Integer | 是 | 80 |
機器組的系統盤容量。 |
HostGroup.N.SysDiskType | String | 是 | CLOUD_SSD |
機器組的系統盤類型。 |
HostGroup.N.VSwitchId | String | 否 | vsw-bp10tvjyc77psy0z5**** |
虛擬交換機ID。 |
BootstrapAction.N.Arg | String | 否 | --a=b |
引導操作參數。 |
BootstrapAction.N.Name | String | 是 | name |
引導操作名字。 |
BootstrapAction.N.Path | String | 是 | oss://bucket/path |
引導操作腳本路徑。 |
Config.N.ConfigKey | String | 是 | fs.trash.interval |
自定義配置項的Key。 |
Config.N.ConfigValue | String | 是 | 60 |
自定義配置項的值。 |
Config.N.Encrypt | String | 否 | 0 |
保留字段,無需填寫。 |
Config.N.FileName | String | 是 | spark-site |
自定義配置項所屬文件名。 |
Config.N.Replace | String | 否 | 0 |
保留字段,無需填寫。 |
Config.N.ServiceName | String | 是 | SPARK |
自定義配置項服務名(大寫)。 |
Tag.N.Key | String | 否 | TestKey |
DDI實例和節點ECS實例的標簽鍵 |
Tag.N.Value | String | 否 | TestValue |
DDI實例和節點ECS實例的標簽值。N的取值范圍:1~20。一旦傳入該值,可以為空字符串。標簽值的取值范圍:1~128,不能以acs:開頭,不能包含http://或者https://。 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
ClusterId | String | C-D7958B72E59B**** |
集群ID。 |
CoreOrderId | String | 0 |
Core節點訂單ID。 |
EmrOrderId | String | 0 |
Databricks 數據洞察訂單ID。 |
MasterOrderId | String | 0 |
Master節點訂單ID。 |
RequestId | String | BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22 |
請求ID。 |
示例
請求示例
http(s)://[Endpoint]/?Action=CreateClusterV2
&BootstrapAction.1.1ame=name
&BootstrapAction.1.Path=oss://bucket/path
&ClusterType=標準型
&Config.1.ConfigKey=fs.trash.interval
&Config.1.ConfigValue=60
&Config.1.FileName=spark-site
&Config.1.ServiceName=SPARK
&EmrVer=DDI-v1.0
&HostGroup.1.DiskCapacity=80
&HostGroup.1.DiskCount=4
&HostGroup.1.DiskType=CLOUD_ESSD
&HostGroup.1.HostGroupName=主實例組
&HostGroup.1.HostGroupType=MASTER
&HostGroup.1.InstanceType=ecs.g5.2xlargeg
&HostGroup.1.1odeCount=2
&HostGroup.1.SysDiskCapacity=80
&HostGroup.1.SysDiskType=CLOUD_SSD
&Name=bi_spark
&RegionId=cn-hangzhou
&UserInfo.1.Password=pwd
&UserInfo.1.UserId=123456789
&UserInfo.1.UserName=username
&ZoneId=cn-hangzhou-b
&<公共請求參數>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<MasterOrderId>0</MasterOrderId>
<CoreOrderId>0</CoreOrderId>
<RequestId>BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22</RequestId>
<ClusterId>C-D7958B72E59B****</ClusterId>
<EmrOrderId>0</EmrOrderId>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"MasterOrderId" : 0,
"CoreOrderId" : 0,
"RequestId" : "BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22",
"ClusterId" : "C-D7958B72E59B****",
"EmrOrderId" : 0
}
錯誤碼
HttpCode | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ECSInfo.DiskSize.TooSmall | The disk size must be greater than or equal to 80 GB. | 磁盤容量太小,加大磁盤容量 |
400 | ECSInfo.ECSOrder.IndexMissing | The order information is invalid. | 訂購信息有誤,提工單 |
400 | ECSInfo.ECSOrder.MasterIndexMissing | The order information is invalid. | 訂購信息有誤,提工單 |
400 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤,請提工單 |
400 | ECSInfo.ECSOrder.SlaveOrderMissing | The order information is invalid. | 訂購信息有誤,提工單 |
400 | RAM.Permission.NotAllow | You are not authorized to perform the operation. | 沒有權限執行此操作,請聯系主賬號授權 |
400 | ECSInfo.ECSOrder.NodeCount.TooSmall | You must increase the number of nodes. | 節點數過少,加大節點數量 |
400 | SecurityGroup.IsEmpty | You must specify the security group name. | 安全組名稱不能為空 |
400 | User.Account.Abnormal | The user account is out of service. | 用戶賬號已經停止服務 |
400 | Master.Pwd.Cannot.Blank | You must specify Master password. | Master節點的密碼不能為空,填寫Master的密碼 |
400 | LogPath.Cannot.Blank | You must specify the log path. | 日志路徑不能為空,請填寫正確的參數 |
400 | HighAvailability.Master.NodeCount.Not.Match | The HighAvailability parameter does not match the master node count. | 高可用參數與master數量不匹配,HA集群需要master節點個數為2 |
400 | InvalidParameter.Period | The specified period is invalid. | 包年包月類型的period參數不合規范 |
400 | Balance.Not.Enough | Your account does not have enough balance. | 賬號沒有足夠的余額,賬戶至少有100元人民幣余額 |
400 | VSwitch.NotBelongTo.Zone | The specified VSwitch does not belong to the specified zone. | 指定交換機不屬于該可用區 |
400 | InsufficientBalance | Your account does not have enough balance. | 賬號沒有足夠的余額,賬號至少有100元余額 |
400 | DB.Fail | A database access error occurred. | 數據庫訪問錯誤,請重試或者提工單 |
400 | ECSInfo.ECSOrder.INVALID | The order creation parameter is invalid. | 創建訂單參數錯誤 |
400 | Ecs.InstanceType.NotSupported | The ECS instance type %s is not supported in DDI. | 實例規格不支持,選擇其它實例規格 |
400 | DiskType.Invalid | The disk type %s is invalid. | 磁盤類型不支持,更換磁盤類型 |
400 | Unsupported.DiskType | The ECS instance type %s does not support the disk type %s. | 磁盤類型不支持 |
400 | Unsupported.ZoneId | The zone %s is not supported. | DDI不支持該可用區,切換可用區 |
400 | ECSInfo.DiskSize.TooBig | The maximum size of the disk is exceeded. | 磁盤容量超過磁盤限制,減少磁盤容量 |
400 | ECSInfo.DiskCount.ExceedLimit | The maximum number of disks is exceeded. | 磁盤塊數超過限制,減少磁盤塊數 |
400 | ECSInfo.NodeType.Unsupported | The specified node type is not supported. | 指定節點類型不支持,切換節點類型 |
400 | Must.Specify.MasterNode | You must specify Master node information. | 請指定Master節點信息 |
400 | Only.Support.One.Master | Only one master node is supported in a DDI cluster. | 在DDI集群中只支持一個主節點 |
400 | Have.Orders.Wait.For.Pay | A payable order already exists. | 有另外的待付款訂單 |
400 | InvalidDataDiskSize.ValueNotSupported | The specified data disk size is invalid. | 指定的磁盤容量不在合法范圍內,請填寫正確的參數 |
400 | Cluster.WaitForPay.OverLimit | Too many clusters are waiting for payment. | 等待付款的集群過多,支付或者取消當前未支付的訂單 |
400 | User.OtherUserResource.NotAllow | You are not authorized to operate other users resource. | 不能操作其它用戶的資源 |
400 | Forbidden | You are not authorized to perform the operation. | 沒有權限操作指定資源,聯系主賬號授權 |
訪問錯誤中心查看更多錯誤碼。
訪問錯誤中心查看更多錯誤碼。