Help Center> RES> API Reference> API> Scheduling> Executing a Scenario
View PDF

Executing a Scenario

Function

This API is used to execute all jobs and services in a scenario.

URI

POST /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/schedule-scene

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.

resource_id

Yes

String

Resource ID (data source ID or scenario ID)

workspace_id

Yes

String

Workspace ID
Table 2 Query parameters

Parameter

Mandatory

Type

Description

action

No

String

Action type. The options are: START: A job starts running. STOP: A job stops running.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Content type. The value is application/json.

X-Auth-Token

Yes

String

User token. For details on how to obtain the user token, see Obtaining a User Token Through Password Authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

is_success

Boolean

Whether the request is successful

message

String

Response message

error_code

String

Error code (This parameter is not returned when the request is successful.)

Example Requests

This API is used to schedule a specified scenario.

/v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/resources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/schedule-scene?action=START

-

Example Responses

Status code: 200

OK

{
  "is_success" : true,
  "message" : "Succeed to schedule scene jobs."
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Scheduling