Performing Operations on a Professional Event Stream Job

Function

This API is used to perform operations on a professional event stream job.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1/{project_id}/eventrouter/jobs/{job_id}/action

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

Request Parameters

**Table 2** 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 3** Request body parameters
Parameter	Mandatory	Type	Description
operation	Yes	String	Operation type.
config	No	OperateConfig object	Additional parameters of the operation.

**Table 4** OperateConfig
Parameter	Mandatory	Type	Description
switch_now	No	Boolean	Whether to perform switch source and target immediately. The default value is false.
sink_address	No	String	Target IP address after the switchover. Multiple IP addresses are separated by commas (,). If the source IP address of the current job is matched, a switchover is performed. If the target IP address of the current job is matched, no switchover is performed. Otherwise, an error is reported.

Response Parameters

Status code: 200

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

**Table 6** Response body parameters
Parameter	Type	Description
job_id	String	Job ID.

Example Requests

Start the professional event stream job whose ID is 123.

POST https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/123/action

{
  "operation" : "START"
}

Example Responses

Status code: 200

Request succeeded.

{
  "job_id" : "fac59513-6c18-4266-bc81-5d412dfc1925"
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Professional Event Stream Job Management

Previous topic: Updating a Professional Event Stream Job

Next topic: Verifying Professional Event Stream Jobs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot