Retrieves preview results.
Operation description
To use the scene management feature, use the console instead of calling this API operation. For more information, see .
Try it now
Test
RAM authorization
Request syntax
GET /v2/openapi/instances/{instanceId}/scenes/{sceneId}/items HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
Yes |
The ID of the instance. |
airec-cn-o400whm78004 |
| sceneId |
string |
Yes |
The ID of the scene. |
testid |
| operationRuleId |
string |
No |
The ID of the operation rule. |
1 |
| selectionRuleId |
string |
No |
The ID of the selection rule. |
1 |
| page |
integer |
No |
The page number. Default value: 1. |
1 |
| size |
integer |
No |
The number of entries per page. Default value: 10. Valid values: 1 to 50. |
10 |
| previewType |
string |
No |
The preview type. Valid values: PREVIEW_ITEM Preview the results of a single product selection rule PREVIEW_QUERY Previews the overall configuration results. |
PREVIEW_ITEM |
| queryCount |
integer |
No |
The number of queries. |
20 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| result |
object |
The details of the result. |
|
| total |
object |
The statistics. |
|
| totalCount |
integer |
The total number of items in the instance. |
1000 |
| sceneWeightItem |
integer |
The number of weighted items in the current scene. |
1000 |
| sceneRecommendItem |
integer |
The number of recommendable items in the current scene. |
1000 |
| weightItem |
integer |
The number of weighted items in the instance. |
1000 |
| instanceRecommendItem |
integer |
The number of recommendable items in the instance. |
1000 |
| detail |
array<object> |
The details. |
|
|
object |
|||
| title |
string |
The title. |
title |
| categoryPath |
string |
The category path. |
12_34 |
| itemId |
string |
The item ID. |
123 |
| itemType |
string |
The item type. |
video |
| status |
string |
Indicates whether the item is recommendable. Valid values: 1 (recommendable) and 0 (not recommendable). |
1 |
| brandId |
string |
The brand ID. |
123 |
| shopId |
string |
The shop ID. |
123 |
| pubTime |
string |
The time when the item was published. |
1612687809 |
| channel |
string |
The channel. |
娱乐 |
| duration |
string |
The duration of stay. |
300 |
| author |
string |
The author. |
zhangsan |
| expireTime |
string |
The expiration time. |
1612687809 |
| code |
string |
The error code. |
InternalServerError |
| requestId |
string |
The ID of the request. |
8F81A922-6C81-46D6-B78C-CC35E16B1691 |
| message |
string |
The error details. |
An internal server error occurred |
Examples
Success response
JSON format
{
"result": {
"total": {
"totalCount": 1000,
"sceneWeightItem": 1000,
"sceneRecommendItem": 1000,
"weightItem": 1000,
"instanceRecommendItem": 1000
},
"detail": [
{
"title": "title",
"categoryPath": "12_34",
"itemId": "123",
"itemType": "video",
"status": "1",
"brandId": "123",
"shopId": "123",
"pubTime": "1612687809",
"channel": "娱乐",
"duration": "300",
"author": "zhangsan",
"expireTime": "1612687809"
}
]
},
"code": "InternalServerError",
"requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
"message": "An internal server error occurred"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.