Help Center/ EventGrid/ API Reference/ APIs/ Professional Event Stream Job Management/ Performing Operations on a Professional Event Stream Job
Updated on 2025-03-31 GMT+08:00

Performing Operations on a Professional Event Stream Job

Function

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

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.