Verifying Professional Event Stream Jobs

Function

This API is used to verify professional event stream jobs.

URI

POST /v1/{project_id}/eventrouter/jobs/validation

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
validate_type	No	String	Verification type.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
cluster_id	Yes	String	Cluster ID.
source_config	No	EventRouterJobSource object	Source configuration of a professional event stream job.
sink_config	No	EventRouterJobSink object	Target configuration of a professional event stream job.

**Table 5** EventRouterJobSource
Parameter	Mandatory	Type	Description
source_kafka	No	KafkaParameters object	Kafka configuration.
source_rocketmq	No	RocketmqParameters object	RocketMQ configuration.
source_dcs	No	DcsParameters object	DCS configuration.

**Table 6** EventRouterJobSink
Parameter	Mandatory	Type	Description
sink_kafka	No	KafkaParameters object	Kafka configuration.
sink_rocketmq	No	RocketmqParameters object	RocketMQ configuration.
sink_dcs	No	DcsParameters object	DCS configuration.

**Table 7** KafkaParameters
Parameter	Mandatory	Type	Description
config_type	Yes	String	Instance type. CLOUD: DMS for Kafka instance.
region	Yes	String	Region ID.
project_id	Yes	String	Resource space ID.
instance_id	No	String	Kafka instance ID. This parameter is mandatory when configuration type is set to CLOUD.
cluster_alias	Yes	String	Kafka cluster alias.
address	No	String	Kafka address.
authenticate_mode	No	String	Authentication mode for Kafka.
sasl_mechanism	No	String	SASL authentication mechanism.
user_name	No	String	Username. This parameter is mandatory when SASL_SSL is enabled.
password	No	String	Password. This parameter is mandatory when SASL_SSL is enabled.

**Table 8** RocketmqParameters
Parameter	Mandatory	Type	Description
config_type	Yes	String	Instance type. CLOUD: DMS for RocketMQ instance
region	Yes	String	Region ID.
project_id	Yes	String	Resource space ID.
instance_id	No	String	RocketMQ instance ID. This parameter is mandatory when the configuration type is CLOUD.
cluster_alias	Yes	String	RocketMQ cluster alias.
address	No	String	RocketMQ address.
ssl_open	No	String	Whether to enable RocketMQ SSL. true: Enable false: Disable
acl_open	No	Boolean	Whether to enable RocketMQ ACL. true: Enable false: Disable
user_name	No	String	Username. This parameter is mandatory when ACL is enabled.
password	No	String	Password. This parameter is mandatory when ACL is enabled.

**Table 9** DcsParameters
Parameter	Mandatory	Type	Description
config_type	Yes	String	Instance type. CLOUD: DCS instance
region	Yes	String	Region ID.
project_id	Yes	String	Resource space ID.
instance_id	No	String	DCS instance ID. This parameter is mandatory when the configuration type is set to CLOUD.
address	No	String	DCS address.
password	No	String	Password.

Response Parameters

Status code: 200

**Table 10** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 11** Response body parameters
Parameter	Type	Description
results	Array of ValidateResult objects	Job verification result list.

**Table 12** ValidateResult
Parameter	Type	Description
check_item_name	String	Check item ID.
name	String	Check item name.
content	String	Check item content.
status	String	Check items status.
error_code	String	Error code corresponding to the check failure.
reason	String	Check failure cause.
solution	String	Solution to the check failure.

Example Requests

Verify the professional event stream job whose jobid is 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
    }
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "results" : [ {
    "check_item_name" : "SOURCE_NETWORK",
    "name" : "Source connectivity",
    "content" : "Check whether the data transfer server can connect to the source service.",
    "status" : "SUCCESS",
    "error_code" : null,
    "reason" : null,
    "solution" : null
  } ]
}