帮你快速理解、总结文档立即下载
文档中心>流计算 Oceanus>API 文档>集群接口>创建Oceanus集群

创建Oceanus集群

最近更新时间：2026-07-16 02:42:38

我的收藏

本页目录：

1. 接口描述

接口请求域名： oceanus.tencentcloudapi.com 。

创建Oceanus集群

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateOceanusCluster。
Version 是 String 公共参数，本接口取值：2019-04-22。
Region 是 String 公共参数，详见产品支持的 地域列表。
ClusterName 是 String

集群名称

入参限制：支持1-50个英文、汉字、数字、连接线-或下划线_


示例值：*_cluster
RegionId 是 Integer

地域Id，可通过地域管理系统 DescribeRegions查询Product参数设置 oceanus


示例值：1
ZoneId 是 Integer

可用区Id，可通过地域管理系统 DescribeZones查询
Product参数设置 oceanus


示例值：110001
LoginPassword 是 String

FlinkUI访问密码

用户名与密码将用于登录查看作业的 Flink UI 界面，集群用户名:admin


示例值：*
VpcDescriptions.N 是 Array of VPCDescription

流计算通过 VPC 和弹性网卡来访问同地域中的其他云产品资源，并需要占用一定的子网 IP 数量，请确保所选子网的可用 IP 数量充足 如现有网络不符合您的要求，请前往 VPC 控制台新建私有网络 或 新建子网
DefaultCOSBucket 是 String

流计算使用对象存储 COS 来保存作业的 checkpoint、jar 包、或投递日志等，如本地域无可用存储桶，请前往对象存储控制台新建 为了保证您的正常使用，对应COS的生命周期配置请参考文档


示例值：autotest-*
CU 否 Integer

集群CU数， 12 CU 是流计算的最小计算资源和计费单位，1CU 包含1个 CPU 和 4GB 内存。 当CU数大于等于 48 时，减免管理节点费用。


示例值：12
Remark 否 String

集群描述

入参限制：支持1-50个英文、汉字、数字、连接线-或下划线_


示例值：create_cluster
Period 否 Integer

购买时长，以月为单位

取值范围：[1, 48]


示例值：1
InstanceChargeType 否 String

集群计费类型

枚举值：

  • PREPAID： 包年包月
  • POSTPAID_BY_SECOND： 按量计费

默认值：POSTPAID_BY_SECOND


示例值：PREPAID
ClusterType 否 String

集群类型

枚举值：

  • MULTI_AZ_CLUSTER： 多可用区集群

示例值：MULTI_AZ_CLUSTER
RenewFlag 否 String

自动续费标识

枚举值：

  • NOTIFY_AND_MANUAL_RENEW： 通知并手动续费
  • NOTIFY_AND_AUTO_RENEW： 通知并自动续费
  • DISABLE_NOTIFY_AND_MANUAL_RENEW： 不通知并不自动续费

默认值：NOTIFY_AND_MANUAL_RENEW

InstanceChargeType设置PREPAID时，对应包年包月集群，需要设置自动续费标识，按量计费集群不需要设置


示例值：NOTIFY_AND_AUTO_RENEW
FlinkWebUINetworkAccessType 否 String

Flink UI访问类型设置

枚举值：

  • NetworkAccess_INTERNAL： 内网访问
  • NetworkAccess_EXTERNAL： 公网访问

默认值：NetworkAccess_EXTERNAL


示例值：NetworkAccess_EXTERNAL
SlaveVpcDescriptions.N 否 Array of SlaveVpcDescriptions

多可用区VPC
CUMemory 否 Integer

核心内存比值，只支持 [0，2，4，8]


示例值：4

3. 输出参数

参数名称 类型 描述
ClusterId String

创建的集群ID

参数格式：cluster-xxx


示例值：cluster-****
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建Oceanus集群

创建Oceanus集群

输入示例

POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateOceanusCluster
<公共请求参数>

{
    "ClusterName": "*****_cluster",
    "RegionId": 1,
    "ZoneId": 100002,
    "CU": 12,
    "LoginPassword": "*********",
    "VpcDescriptions": [
        {
            "VpcId": "vpc-cp******",
            "SubnetId": "subnet-5b******"
        }
    ],
    "DefaultCOSBucket": "autotest-*************",
    "InstanceChargeType": "PREPAID",
    "Remark": "create_cluster",
    "Period": 1,
    "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
    "FlinkWebUINetworkAccessType": "NetworkAccess_EXTERNAL"
}

输出示例

{
    "Response": {
        "ClusterId": "cluster-********",
        "RequestId": "fc61dd48-34a6-4ed1-832f-e515c39756a0"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure.CAMNotAuthorized 权限未授权
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
中国站