您可以调用CreateInstance创建一个包年包月或者按量付费的工作空间。

说明 在使用该接口前，请确保已充分了解实时计算Flink版产品的收费方式和价格，详情请参见产品定价。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateInstance

系统规定参数。取值为CreateInstance。
CreateInstanceRequest Object 是

创建工作空间所需的请求参数。
InstanceName String 是 vvp1

工作空间名称。
ChargeType String 是 PRE

付费类型，取值如下：

  • POST：按量付费。
  • PRE：包年包月。
Region String 是 cn-beijing

工作空间所属的地域ID。
ZoneId String 是 cn-beijing-g

工作空间所属的可用区ID。
VpcId String 是 vpc-2ze9*******nxfmfcdi

VPC ID。
VSwitchIds Array of String 是 vsw-xzes****bkmuirxxpoxxv

虚拟交换机ID。
ResourceSpec Object 否

资源规格。

说明 当ChargeType配置为PRE时，资源规格参数必填。
Cpu Integer 否 10

CPU数量。
MemoryGB Integer 否 40

内存大小。单位为GB。

说明 内存数量必须为CPU数量的4倍。
PricingCycle String 否 Month

订购周期，仅支持按年（Year）和月（Month）订购。
Duration Integer 否 1

订购周期数量。

说明 当ChargeType配置为PRE时，Duration参数必填。
AutoRenew Boolean 否 true

付费类型为包年包月时，取值如下：

  • true：自动续费。
  • false：手动续费。
Storage Object 是

存储参数。
Oss Object 是

OSS存储。
Bucket String 是 oss_flink

OSS的Bucket名称。
UsePromotionCode Boolean 否 true

是否使用优惠券。取值如下：

  • true：使用。
  • false：不使用。
PromotionCode String 否 5RT******

优惠码。

返回数据

名称 类型 示例值 描述
RequestId String 67F33190-946B-1105-B6A1-E2DF0426DD51

请求ID。
Success Boolean true

是否成功，取值如下：

  • true：成功。
  • false：失败。
OrderInfo Object

订单信息。
OrderId Long 210406354694567

订单ID。
InstanceId String 8D2D5BBF-C302-1A21-80E1-27799802****

工作空间ID。

示例

请求示例

http(s)://{Endpoint}/?Action=CreateInstance
&CreateInstanceRequest={"InstanceName":"vvp1","ChargeType":"PRE","Region":"cn-beijing","ZoneId":"cn-beijing-g","VpcId":"vpc-2ze9*******nxfmfcdi","VSwitchIds":["vsw-xzes****bkmuirxxpoxxv"],"ResourceSpec":{"Cpu":10,"MemoryGB":40},"PricingCycle":"Month","Duration":1,"AutoRenew":true,"Storage":{"Oss":{"Bucket":"oss_flink"}},"UsePromotionCode":true,"PromotionCode":"5RT******"}
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateInstanceResponse>
    <RequestId>67F33190-946B-1105-B6A1-E2DF0426DD51</RequestId>
    <Success>true</Success>
    <OrderInfo>
        <OrderId>210406354694567</OrderId>
        <InstanceId>8D2D5BBF-C302-1A21-80E1-27799802****</InstanceId>
    </OrderInfo>
</CreateInstanceResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "67F33190-946B-1105-B6A1-E2DF0426DD51",
  "Success" : true,
  "OrderInfo" : {
    "OrderId" : 210406354694567,
    "InstanceId" : "8D2D5BBF-C302-1A21-80E1-27799802****"
  }
}