CreateInstance - 创建flink全托管工作空间

创建一个包年包月或者按量付费flink全托管工作空间。

接口说明

请确保在使用该接口前,已充分了解 Flink 全托管产品的收费方式和价格

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
stream:CreateVvpInstancecreate
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceNamestring

工作空间名称。

rtc-e2e-test-pre
ChargeTypestring

付费类型,取值如下:

  • POST:按量付费
  • PRE:包年包月
PRE
Regionstring

地域。

cn-beijing
VpcIdstring

专有网络 VPC ID。

vpc-2ze9xoh8qyt1rnxfmfcdi
VSwitchIdsarray

虚拟交换机 ID 组。

string

虚拟交换机 ID。

vsw-m5esz02px6qxiu28x7c2i
ResourceSpecobject

资源规格。

说明 当 ChargeType 配置为 PRE 时,资源规格参数必填。
Cpuinteger

CPU 数量。

说明
  • 在包年包月的工作空间下,CPU 数量必填。在按量付费的工作空间下,可以不用填写 CPU 数量。- 创建的目标项目空间的 CPU 数量要小于工作空间中剩余 CPU 数量(工作空间购买的总 CPU 数量减去其他项目空间已分配 CPU 数量),否则会报错。
  • 30
    MemoryGBinteger

    内存大小。单位为 GB。

    说明 内存大小必须为 CPU 数量的 4 倍。
    120
    PricingCyclestring

    指定预付费实例为包年或包月类型,取值范围如下:

    • year:年
    • month:月
    说明 若付费类型为 PrePaid,该参数为必传参数。
    Month
    Durationinteger

    订购周期数量。

    说明 当 ChargeType 配置为 PRE 时,Duration 参数必填。
    1
    AutoRenewboolean

    是否自动续费。取值:

    • true:自动续费
    • false:不自动续费(默认)
    说明 按量付费时,该参数无效。
    true
    Storageobject

    存储参数。

    Ossobject

    OSS 存储。

    Bucketstring

    OSS 的 Bucket 名称。

    oss-flink-cn-shanghai-260343971602724445
    PromotionCodestring

    优惠券 code。

    500043499350689
    ResourceGroupIdstring

    优惠券 code

    Extrastring

    优惠券 code

    ArchitectureTypestring

    优惠券 code

    Tagarray<object>

    标签列表,最多包含 20 个子项

    object
    Keystring

    标签键

    Valuestring

    标签值

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 id。

    67F33190-946B-1105-B6A1-E2DF0426DD51
    Successboolean

    是否成功。

    true
    OrderInfoobject

    订单信息。

    OrderIdlong

    订单 id。

    210406354694567
    InstanceIdstring

    订单实例 id。

    f-cn-zvp2q0zik06
    StorageOrderIdlong

    存储订单 id

    StorageInstanceIdstring

    存储实例 id

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "67F33190-946B-1105-B6A1-E2DF0426DD51",
      "Success": true,
      "OrderInfo": {
        "OrderId": 210406354694567,
        "InstanceId": "f-cn-zvp2q0zik06",
        "StorageOrderId": 0,
        "StorageInstanceId": ""
      }
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-07-31OpenAPI 返回结构发生变更查看变更详情
    2024-04-18OpenAPI 入参发生变更查看变更详情
    2024-03-07OpenAPI 入参发生变更查看变更详情