创建专业版事件流集群 - CreateEventRouterCluster
功能介绍
创建专业版事件流集群
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/eventrouter/clusters
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户资源空间ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
集群名称。约束:集群名称由大小英文字母、数字、点、中划线和下划线组成,必须以大小英文字母或数字开头,最多128个字符。 |
|
description |
否 |
String |
集群描述,约束:集群描述不能超过256位。 |
|
source_type |
是 |
String |
源端类型,可以为KAFKA/ROCKETMQ/DCS三种类型其中一种,需要与目标端类型保持一致 |
|
sink_type |
是 |
String |
目标端类型 |
|
vpc_id |
是 |
String |
虚拟私有云ID |
|
subnet_id |
是 |
String |
子网ID |
|
zone_names |
否 |
String |
可用区名称 |
|
bss_param |
否 |
bssParam object |
表示计费模式的相关参数。置空时,默认计费模式为按需计费;否则是包周期方式。 |
|
flavor |
否 |
String |
集群规格 |
|
public_access_enabled |
是 |
Boolean |
事件流集群是否开启公网访问 |
|
nat_id |
否 |
String |
集群开启公网访问时绑定的NAT实例ID |
|
eip_id |
否 |
String |
集群开启公网访问时绑定的EIP实例ID |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
请求ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cluster_id |
String |
专业版事件流集群ID |
|
name |
String |
集群名称。约束:集群名称由大小英文字母、数字、点、中划线和下划线组成,必须以大小英文字母或数字开头,最多128个字符。 |
|
description |
String |
集群描述,约束:集群描述不能超过256位。 |
|
source_type |
String |
源端类型 |
|
sink_type |
String |
目标端类型 |
|
subnet_id |
String |
子网ID |
|
vpc_id |
String |
虚拟私有云ID |
|
zone_names |
String |
可用区名称 |
|
status |
String |
作业状态 |
|
job_count |
Number |
当前集群下作业数量 |
|
flavor |
String |
规格 |
|
charging_mode |
String |
计费模式 |
|
err_code |
String |
错误码 |
|
err_message |
String |
错误原因 |
|
created_time |
String |
创建UTC时间 |
|
updated_time |
String |
更新UTC时间 |
请求示例
创建名为cluster-qapbtr95的kafka专业版事件流集群
POST https://{eg_endpoint}/v1/{project_id}/eventrouter/clusters
{
"name" : "cluster-qapbtr95",
"description" : "",
"vpc_id" : "199f632d-34e7-4915-b4d8-1bc4e2824867",
"subnet_id" : "0d1799e1-116e-4551-92dc-02dd8a860072",
"source_type" : "KAFKA",
"sink_type" : "KAFKA",
"public_access_enabled" : false
}
响应示例
状态码:200
请求成功
{
"cluster_id": "fac59513-6c18-4266-bc81-5d412dfc1925",
"name": "cluster-ifpcv5u4",
"description": "",
"source_type": "KAFKA",
"sink_type": "KAFKA",
"status": "CREATING",
"job_count": 0,
"err_code": null,
"err_message": null,
"created_time": "2024-05-16T11:46:07Z",
"updated_time": "2024-05-16T11:46:07Z",
"vpc_id": "199f632d-34e7-4915-b4d8-1bc4e2824867",
"subnet_id": "0d1799e1-116e-4551-92dc-02dd8a860072",
"zone_names": "az0",
"public_access_enabled": false
"nat_id": null,
"eip_id": null
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
错误码
请参见错误码。