VNNOX_API
Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

概要

此文档描述了Vnnox系统的REST API(v1)，如果您在使用中有任何问题请及时联系

  • 版本
  • 请求简述
  • 参数说明
  • 服务地址
  • 错误调试
  • HTTP方法
  • 认证
  • 分页
  • 指定用户代理
  • 次数限制

版本说明

默认情况下当客户端访问https://cn.vnnox.com时，系统将使用V1 版REST API提供服务，我们建议您在http请求的heaer中的`Accept`字段加上服务版本号。格式如下：

Accept
Accept:application/nova.vnnox.v1+json

注：为了不影响第三方功能对接，当前v1版本的REST API接口及接口中的数据会以增量方式更新。

请求简述

所有请求均通过HTTPS协议，API请求链接为https://cn.vnnox.com，所有数据的请求及相应均通过json格式。

Response数据结构

data structure 
{
    "http_code": 200,            //http状态码
    "data": {...some data...},   //数据部分
    "status": [10000001]         //业务相关状态码
}

请求列表

通过GET请求获取资源信息时，如果未指定资源唯一ID，则请求的为资源的列表，返回的数据list中包含了符合查询规则的集合list

list users 
{
    "http_code": 200,
    "data": {
        "userList": [
            {
                "uid": "2",
                "oid": "6",
                "wid": "311",
                "enable": "1",
                "org_reg": "0",
                "uName": "user1",
                "user_conf": {...},
                "user_statistic": {... },
                "workgroup": {... },
                "role": [...]
            },
            {
                "uid": "20",
                "oid": "6",
                "wid": "3113",
                "enable": "1",
                "org_reg": "0",
                "uName": "user2",
                "user_conf": {...},
                "user_statistic": {...},
                "workgroup": {... },
                "role": [... ]
            }
        ],
        "count": "3"
    },
    "status": [
        10000001
    ]
}


请求详情

如果在资源请求中指定唯一ID,则请求的为单个资源，返回的数据只包含当前资源

user 
{
    "http_code": 200,
    "data": {
        "uid": "2567",
        "oid": "67",
        "wid": "3114",
        "enable": "1",
        "org_reg": "0",
        "uName": "lileilei_3",
        "user_conf": {...},
        "role": [...],
        "workgroup": [...],
        "systemMediaApprove": "0"
    },
    "status": [
        10405001
    ]
}


参数说明

服务地址

错误调试

HTTP方法

认证

分页

指定用户代理

次数限制



  • No labels