Updated on 2023-11-23 GMT+08:00

Enabling a System Subscription Event

Function

This API is used to enable a system subscription event.

URI

POST /v2/{project_id}/routemgr/exchanger/systemevents/{event_id}/start

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

event_id

Yes

String

System subscription event ID.

Request

Table 2 Parameters in the request header

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.

ief-instance-id

No

String

Platinum edition instance ID. This parameter is left blank for a professional edition instance.

Content-Type

Yes

String

Message body type (format). The default value is application/json.

Response

None

Example Request

None

Example Response

None

Status Codes

Status Code

Description

200

Enabled.

Error Codes

For details, see Error Codes.