ListRules - 智能推荐

描述

查询规则列表。

方法

GET

URI

openapi/instances/{instanceId}/rules GET

请求参数

参数	类型	是否必需	描述
instanceId	String	是	通过实例ID查询
ruleType	String	是	selection 选品规则 operation 运营规则
sceneId	String	是	指定场景id，全局运营规则是关键字 global
status	Sring	否	DRAFT 草稿状态 EFFECTIVE 生效状态 PUBLISHING 发布中状态 INEFFECTIVE 已失效状态 FAILED 未生效状态
page	Integer	否	指定页码，默认为：1
size	Integer	否	指定每页展示条数，默认为10，限制:[1-50]
startTime	Long	否	开始时间（秒级时间戳）
endTime	Long	否	结束时间（秒级时间戳）

返回参数

参数	类型	描述
RequestId	String	当前请求的RequestID
Result	List	规则列表
Headers	Map	头信息详情
└X-Total-Count	Integer	规则总数量

示例

请求示例

GET /openapi/instances/{airec-xxxx}/rules?ruleType=xxx&sceneId=1234&page=1&size=10

返回示例

JSON 格式

// 选品规则
{
    "Result":[
        {
            "Status":"DRAFT",
            "GmtCreate":"2020-04-27T06:38:28.000Z",
            "GmtModified":"2020-04-27T06:38:28.000Z",
            "RuleId":"98493A14-D619-4E88-9F8D-108939817F9F",
            "RuleMeta":{
                "RuleMetaType":"SELECTION",
                "SceneId":"123",
                "PubState":"PUBLISHING",
                "SelectionParams":[
                    {
                        "SelectType":"QUERY_ITEM_TYPE",
                        "SelectionOperation":"OPERATOR_EQUAL",
                        "SelectValue":"atrical,image"
                    }
                ]
            }
        }
    ],
    "RequestId":"76E2C51D-A2D7-4775-9FD8-2AB84B2A0CEF",
    "Headers":{
        "X-Total-Count":19
    }
}
// 运营规则
{
    "Result":[
        {
            "Status":"DRAFT",
            "GmtCreate":"2020-04-27T03:17:21.000Z",
            "GmtModified":"2020-04-27T03:17:21.000Z",
            "RuleId":"123456789001122",
            "RuleMeta":{
                "RuleMetaType":"OPERATION",
                "SceneId":"123",
                "PubState":"PUBLISHING",
                "OperationParams":[
                    {
                        "OperationType":"MIX",
                        "Settings":[
                            {
                                "Name":"image",
                                "Value":10
                            }
                        ]
                    },
                    {
                        "OperationType":"DIVERSIFY",
                        "CategoryIndex":1,
                        "Window":2,
                        "Status":true,
                        "DiversifyType":"TYPE_SHOP"
                    },
                    {
                        "OperationType":"EXPOSURE",
                        "ExposureSettings":[
                            {
                                "DurationSeconds":1234000,
                                "Status":true,
                                "ExposureType":"TYPE_EXPOSE",
                                "ScenarioBased":true
                            },
                            {
                                "DurationSeconds":123400,
                                "Status":true,
                                "ExposureType":"TYPE_CLICK",
                                "ScenarioBased":true
                            }
                        ]
                    }
                ]
            }
        }
    ],
    "RequestId":"76E2C51D-A2D7-4775-9FD8-2AB84B2A0CEF",
    "Headers":{
        "X-Total-Count":19
    }
}

无结果

{
    "RequestId":"8F81A922-6C81-46D6-B78C-CC35E16B1691",
    "Result":[]
}

异常返回示例

JSON 格式

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