更新时间:2024-12-10 GMT+08:00
分享

获取可视化应用列表

功能

获取可视化应用列表。

表1 SLA项

SLA项

定义

请求成功率

>=99.9%

可用性

Tair1

数据一致性

最终一致,不一致时长<1分钟

吞吐量

4000tps

TP50请求时延

3000ms

TP99.9请求时延

3000ms

注意事项

调用方法

GET

URI

/rest/mogaiaservice/v1.0/visuals

路径参数

查询参数
表2 查询参数

参数

是否必选

类型

值域

说明

type

string

  • list
  • card

呈现方式。 list-列表,card-卡片

name

string

名称

start

string

起始页

limit

string

1000~1

分页

category

string

  • report
  • screen

类型,报表-report,大屏-screen

managed_status

string

  • 0
  • 2

类型,0-创建,2-发布

project_id

string

归属项目

sort_key

string

  • created_date
  • name
  • last_updated_date

排序字段名称,支持的合法取值:created_date, name, last_updated_date

sort_order

string

  • asc
  • desc

排序顺序,支持的取值:asc(升序)、desc(降序),默认:desc。

is_preset

string

  • 0
  • 1

是否预置,预置-1,非预置-0

created_user_name

string

创建人

catalog_id

string

所属类型id

请求

  • 请求header参数

    请参见请求示例中header描述。

  • 请求body参数

  • 请求示例
    GET /rest/mogaiaservice/v1.0/visuals?type=xxx&name=xxx&start=xxx&limit=xxx&category=xxx&managed_status=xxx&project_id=xxx&sort_key=xxx&sort_order=xxx&is_preset=xxx&created_user_name=xxx&catalog_id=xxx HTTP/1.1 
    Host: example.com 
    Content-Type: application/json 
    Accept: application/json

响应

  • 响应参数
    • 响应状态码200:返回VisualsListResponse。
      表3 VisualsListResponse对象属性

      参数

      是否必选

      类型

      值域

      说明

      Visuals

      表4

      项目列表

      total

      integer

      项目总数

      表4 VisualsInfo对象属性

      参数

      是否必选

      类型

      值域

      说明

      id

      string

      可视化ID

      name

      string

      名称

      description

      string

      描述

      owner

      string

      数据Owner

      category

      string

      归属类别, report-报表, screen-大屏

      security_level

      string

      密级: open-公开 secret-秘密 top-机密

      managed_status

      integer

      状态 0-创建,1-删除,2-发布

      from_project_id

      string

      归属的OCC项目ID

      from_project_name

      string

      归属的OCC项目名称

      template_id

      string

      模板ID

      snapshot_id

      string

      快照ID

      thumbnail

      string

      缩略图的地址

      created_date

      int64

      创建时间

      created_by

      string

      创建者

      created_user_name

      string

      创建者名字

      last_updated_date

      int64

      最近更新时间

      last_updated_by

      string

      最近更新者

      iam_project_id

      string

      IAM中project ID

      domain_id

      string

      domain

      share

      string

      分析ID

      workspace_id

      string

      工作空间ID

      nav_catalog_id

      string

      分类ID

      nav_catalog_name

      string

      分类名称

      nav_catalog_name_en

      string

      分类英文名称

      subscribed_sum

      int32

      默认值:0

      已订阅数量

      x_language

      string

      国际化字段

      is_preset

      int32

      默认值:0

      是否预置数据

      conflict_name

      string

      冲突名字

      parent_id

      string

      父id

      format

      integer

      格式:1-文档,2-幻灯片

      scope

      integer

      使用域:1-通用,2-专用

      manager

      string

      管理者(该参数用于存用户id,以“,”方式分隔)

      published_date

      int64

      发布时间

      dv_token

      string

      dv_token

      dv_password

      string

      dv_password

      dv_expiration_date

      string

      dv_expiration_date

      dv_is_auth

      string

      dv_is_auth

      dv_type

      string

      dv_type

      dv_snap_shot_id

      string

      dv_snap_shot_id

      dv_current_time

      int64

      dv_current_time

  • 响应示例
    HTTP/1.1 200 OK 
    Date:Wed,19 Jul 2023 14:15:28 GMT 
    Server: example.com 
    Content-Type: application/json;charset=UTF8

状态码

表5 状态码

状态码

说明

200

操作成功。

400

参数错误。

403

鉴权失败。

404

rest接口没找到。

500

默认ServiceException异常码,应用内部错误。

操作危险级别

Minor

相关文档