All Products
Search
Document Center

ModifyScene

Last Updated: Mar 29, 2021

We recommend that you do not call an API operation to manage scenes. Go to the Scene Management page in the AIRec console to manage scenes. For more information, see Create a recommendation scene by configuring item selection rules.

Description

Modifies information of a scene.

Method

PUT

URI

openapi/instances/{instanceId}/scenes/{sceneId}

Request parameters

Parameter

Type

Required

Description

status

Enmu

No

The status of the scene. Valid values: DRAFT, PUBLISHING, and FROZEN.

sceneName

String

No

The name of the scene.

description

String

No

The description of the scene.

Response parameters

Parameter

Type

Description

RequestId

String

The ID of the request.

Result

Scene

The result that is returned.

Examples

Sample requests

PUT openapi/instances/{instanceId}/scenes/{sceneId}
{
    "sceneName":"xxx",
      "status":"xxx",
      "description":"xxx"
}

Sample success responses

JSON format

{
    "Result": {
        "Status": "RUNNING",
        "GmtCreate": "2020-04-23T06:08:48.000Z",
        "GmtModified": "2020-04-23T10:04:24.000Z",
        "SceneId": "123",
        "SceneMeta": {
            "SceneName": "xxx",
            "Description": "xxx"
        }
    },
    "RequestId": "E6535761-3448-4D6E-A791-477531763F29"
}

Sample error responses

JSON format

{
  "Code":"InternalServerError",
    "Message":"An internal server error occurred.",
    "RequestId":"829F38F6-E2D6-4109-90A6-888160BD16C2"
}