校验专业版事件流作业 - ValidateEventRouterJob
功能介绍
校验专业版事件流作业
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/eventrouter/jobs/validation
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户资源空间ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
validate_type |
否 |
String |
校验的类型 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
cluster_id |
是 |
String |
集群ID |
|
source_config |
否 |
EventRouterJobSource object |
专业版事件流作业源端配置 |
|
sink_config |
否 |
EventRouterJobSink object |
专业版事件流作业目标端配置 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
source_kafka |
否 |
KafkaParameters object |
kafka配置 |
|
source_rocketmq |
否 |
RocketmqParameters object |
rocketmq配置 |
|
source_dcs |
否 |
DcsParameters object |
dcs配置 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
sink_kafka |
否 |
KafkaParameters object |
kafka配置 |
|
sink_rocketmq |
否 |
RocketmqParameters object |
rocketmq配置 |
|
sink_dcs |
否 |
DcsParameters object |
dcs配置 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
config_type |
是 |
String |
实例类型 CLOUD：云服务DMS kafka实例 |
|
region |
是 |
String |
区域ID |
|
project_id |
是 |
String |
资源空间ID |
|
instance_id |
否 |
String |
kafka实例ID，配置类型选择CLOUD时必填 |
|
cluster_alias |
是 |
String |
kafka集群别名 |
|
address |
否 |
String |
kafka地址 |
|
authenticate_mode |
否 |
String |
kafka认证方式 |
|
sasl_mechanism |
否 |
String |
SASL认证机制 |
|
user_name |
否 |
String |
用户名，开启SASL_SSL时必填 |
|
password |
否 |
String |
用户密码，开启SASL_SSL时必填 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
config_type |
是 |
String |
实例类型。 CLOUD：云服务DMS Rocketmq实例 |
|
region |
是 |
String |
区域id |
|
project_id |
是 |
String |
资源空间ID |
|
instance_id |
否 |
String |
rocketmq实例ID，配置类型选择CLOUD时必填 |
|
cluster_alias |
是 |
String |
rocketmq集群别名 |
|
address |
否 |
String |
rocketmq地址 |
|
ssl_open |
否 |
String |
rocketmq SSL开关 true: 开启 false: 关闭 |
|
acl_open |
否 |
Boolean |
rocketmq ACL开关 true: 开启 false: 关闭 |
|
user_name |
否 |
String |
用户名，开启ACL时必填 |
|
password |
否 |
String |
用户密码，开启ACL时必填 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
请求ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
results |
Array of ValidateResult objects |
作业校验结果列表 |
请求示例
校验jobid=123的专业版事件流作业
POST https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/validation?validate_type=SOURCE_NETWORK&job_id=123
{
"cluster_id" : "fac59513-6c18-4266-bc81-5d412dfc1926",
"source_config" : {
"source_dcs" : {
"config_type" : "CLOUD",
"region" : "roma-dev-1",
"project_id" : "cb13a5c409fe40599271f44bbea5a2ad",
"instance_id" : "228cdb80-fabb-4490-83bd-0a91e8bef9b4",
"password" : null
}
}
}
响应示例
状态码：200
请求成功
{
"results" : [ {
"check_item_name" : "SOURCE_NETWORK",
"name" : "源端连通性",
"content" : "检查数据传输服务器是否能够连通源端服务",
"status" : "SUCCESS",
"error_code" : null,
"reason" : null,
"solution" : null
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
错误码
请参见错误码。
