跳至主内容

获取策略列表

此方法用于获取可用策略列表。

参数

参数

类型

可选

描述

公司ID

字符串

是

需获取策略的公司ID。默认值为生成API密钥的用户所属公司。若未传递该参数，则返回该公司可用的策略。

页码

数字

是

结果页码。默认值为1。

每页条数

数字

是

每页显示的项目数量。上限为每页100项。默认值：每页30项。

返回值

该方法返回一个包含策略对象列表的对象。结果具有以下结构：

  • 页码 - 当前显示的页码

  • 总页数 - 可用页面的总数

  • 每页条数 - 每页返回的项目总数

  • 总计 - 项目总数

  • 项目列表 - 策略列表。列表中的每个条目包含以下字段：

    • ID ，策略的唯一标识符，

    • 名称 ，策略的名称，

    • 公司ID ，拥有该策略的公司ID，

    • 公司名称 ，拥有该策略的公司名称

示例

请求 : 

{
       "params": {
           "companyId": "55896b87b7894d0f367b23c6",
           "page": 1,
           "perPage": 2
       },
       "jsonrpc": "2.0",
       "method": "getPoliciesList",
       "id": "5399c9b5-0b46-45e4-81aa-889952433d86"
  }

响应 : 

{
      "id":"5399c9b5-0b46-45e4-81aa-889952433d86",
      "jsonrpc":"2.0",
      "result": {
           page: 1,
           pagesCount: 2,
           perPage: 2,
           total: 4
           items[
               {
                   "id" : "21a295eeb1a43d8b497b23b7",
                   "name" : "策略1","companyId" : "55896b87b7894d0f367b23c6",
                   "companyName" : "测试公司"},
               {
                   "id" : "23a295d8b1a43d7c4a7b23c9",
                   "name" : "策略2","companyId" : "55896b87b7894d0f367b23c6",
                   "companyName" : "测试公司"
               }
           ]
       }
  }
本节内容 :