Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
DataArts Fabric
IoT
IoT Device Access
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
Huawei Cloud Astro Canvas
Huawei Cloud Astro Zero
CodeArts Governance
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance (CCI)
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Cloud Transformation
Well-Architected Framework
Cloud Adoption Framework
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Blockchain
Blockchain Service
Web3 Node Engine Service
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ EventGrid/ API Reference/ APIs/ Professional Event Stream Job Management/ Verifying Professional Event Stream Jobs

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
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback