All Products
Search
Document Center

DescribeScene

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

Queries detailed information of a specified scene.

Method

GET

URI

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

Request parameters

Parameter

Type

Required

Description

instanceId

String

Yes

The ID of the instance.

sceneId

String

Yes

The ID of the scene.

Response parameters

Parameter

Type

Description

RequestId

String

The ID of the request.

Result

Scene

Details about the scene.

Examples

Sample requests

GET /openapi/instances/{airec-xxxx}/scenes/{sceneId}

Sample responses

JSON format

{
    "Result":
    {
            "Status":"DRAFT",
            "GmtCreate":"2020-04-23T06:08:48.000Z",
            "GmtModified":"2020-04-23T06:08:48.000Z",
            "SceneId":"123",
            "SceneMeta":{
                "SceneName":"sceneTest",
                "Description":"xxx",
                "Metric":{
                    "PvCtr":"32",
                    "Daily":"32",
                    "Weekly":"32"
                }
            }
    }
   ,
    "RequestId":"76E2C51D-A2D7-4775-9FD8-2AB84B2A0CEF"
}

Sample error responses

JSON format

{
    "Code": "InstanceNotFound",
    "Message": "The specified instance does not exist. Check the instanceId please.",
    "RequestId": "829F38F6-E2D6-4109-90A6-888160BD16C2"
}