Help Center> RES> API Reference> APIs (Old Version)> Global Configuration-related APIs> Adding Scenarios
View PDF

Adding Scenarios

Function

This API is used to add scenarios.

URI

POST /v1/{project_id}/scene

Table 1 describes the URI parameters.
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter

Mandatory

Type

Description

scene_name

Yes

String

Scenario name

Response

Table 3 describes the response parameters.

Table 3 Response parameters

Parameter

Type

Description

is_success

Boolean

Whether the request is successful

message

string

Response message

error_code

String

Error code that indicates a request has failed. This parameter is unavailable when a request is successful.

error_msg

String

Error message that indicates a request has failed. This parameter is unavailable when a request is successful.

Example

  • Example request 
    {
"scene_name": "Scenario 9"
}
  • Example of a successful response 
    {
    "is_success": true,
    "message": "Succeed to add the global setting."
}
{
    "is_success": true,
    "message": "Succeed to add the scene information."
}
  • Example of a failed response 
    {
    "is_success": false,
    "error_code": "res.6046",
    "error_msg": "This scenario name already exists."
}

Status Code

For details about status codes, see Status Codes.