使用须知

RESTful接口可以对集团服务进行相关操作，如查询产品信息、查询SN信息、激活授权码等。

调用说明

1. 请求头参数格式

   application/json：返回json

   其它：返回xm

安全验证

调用RESTful接口时必须使用安全口令进行访问。

认证方式有两种：

• 将口令写在URL里。示例：ip:port/rest/<pwd>/product，其中<pwd>就是口令。

• 将口令写在HTTP请求头里。示例：Authorization:<pwd\>

  HTTP请求头的优先级高于URL参数。

口令的生成方式有两种：

1. 通过修改bit_service.xml文件

打开集团服务安装目录下的 bit_service.xml 文件，添加 RESTful 访问密码，此密码会在 URL 中用到，将红色字体的代码拷贝到 bit_service.xml 文件中，然后重启集团服务。

<?xml version="1.0" encoding="UTF-8"?>
<BitAnswerSrvConfig>
  <Users/>
  <RestFul>
    <License did="0" pid="0">bitanswer</License>
  </RestFul>
</BitAnswerSrvConfig>

2. 通过命令行设置安全口令

命令：-r [-d <productId>] [-p <path>] [-s <show>] [-c <clear>] [-a <pwd>]

参数说明：

• 随机生成一串口令：bit_service -r
• 将生成的口令保存到文件：bit_service -r -p /xxx/
• 显示已有口令：bit_service -r -s
• 清空已有口令：bit_service -r -c
• 添加自定义口令：bit_service -r -a xxxx

示例：

./bit_service -r -a bitanswer

注意事项

需要先在集团授权管理中心中开启详细日志（参见用量数据），用户使用信息和出错信息才会保存到日志中。

产品管理API

获取产品列表

1. 接口概述：查询产品的基础信息。
2. 请求URI：GET ip:port/rest/<pwd>/product

• 路径参数

3. 请求参数

   无

4. 响应参数

6. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/product' \

7. 响应示例

<response>
  <status><code>0</code></status><data>
    <product>
      <name>Bitanswer</name>
      <pid>URHQ-O5JQ</pid>
      <version>13.8.5.0</version>
    </product>
  </data>
</response>

授权管理API

获取授权码列表

1. 接口概述：查询授权码信息，支持按产品、SN筛选。
2. 请求URI：GET ip:port/rest/<pwd>/sn

• 路径参数

3. 请求参数

4. 响应参数

5. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/sn'

6. 响应格式

<response>
  <status><code>0</code></status><data>
    <snInfo>
      <activateDate>2025-06-10 14:37:52</activateDate>
      <endDate>2025-07-10 14:37:52</endDate>
      <onlineUsers>0</onlineUsers>
      <product>Bitanswer</product>
      <sn>65JR5RNQGY3NYVNL</sn>
      <status>0</status>
      <users>100</users>
    </snInfo>
  </data>
</response>

获取特征项列表

说明：建议升级为获取特征项列表并可查峰值信息接口

1. 接口概述：查询特征项信息，支持按产品筛选。
2. 请求URI：GET ip:port/rest/<pwd>/feature

• 路径参数

3. 请求参数

4. 响应参数

5. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/feature'

6. 响应示例

<response>
  <status><code>0</code></status><data>
    <feature>
      <endDate>2025-07-10 14:37:52</endDate>
      <id>150</id>
      <name>视频内容1</name>
      <onlineUsers>0</onlineUsers>
      <product>Bitanswer</product>
      <sn>65JR5RNQGY3NYVNL</sn>
      <snStatus>0</snStatus>
      <users>100</users>
      <version />
    </feature>
  </data>
</response>

获取特征项列表并可查峰值信息

1. 接口概述：查询指定产品下特征项信息和峰值信息，支持按SN筛选。（13.7.0.8及以上版本的集团服务支持）
2. 请求URI：GET ip:port/rest/<pwd>/product/<productId>/featuresV2

• 路径参数

3. 请求参数

说明：以上3个参数均为可选参数，不输入则返回特征项列表，和获取特征项列表接口的返回结果类似，唯一区别是在只指定产品ID时返回聚合的特征项列表。建议用户使用此接口代替获取特征项列表接口

4. 响应参数

5. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/product/URHQO5JQ

6. 响应示例

<response>
<response>
    <status><code>0</code></status><data>
        <feature>
            <endDate>2025-07-10 14:37:52</endDate>
            <id>201</id>
            <name>节点计算2021-2022</name>
            <onlineUsers>1</onlineUsers>
            <peaks>
                <peak date="2025-06">1</peak>
            </peaks>
            <product />
            <users>100</users>
            <version />
        </feature>
    </data>
</response>

获取设备码

1. 接口概述：查询指定产品下设备码信息。
2. 请求URI：GET ip:port/rest/<pwd>/product/<productId>/deviceCode

• 路径参数

3. 请求参数

   无

4. 响应参数

5. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/product/URHQ-O5JQ/deviceCode'

6. 响应示例

{
    "data": {
        "code": "BRW125-32DCFF0C6-86129387B-8A079CF21-866DB8B48-91C951F9D-957F8102E-A28089F68"
    },
    "status": 0
}

在线激活

1. 接口概述：在线激活授权码。
2. 请求URI：GET ip:port/rest/<pwd>/product/<productId>/activate/<sn>

• 路径参数

3. 请求参数

   无

4. 请求头参数格式

   text/plain;charset=utf-8（工具不用配置）

5. 请求参数

   无

6. 响应参数

7. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/product/URHQ-O5JQ/activate/2FUMR5NFPI3NYZ2G'

6. 请求示例

{
    "status": 0
}

在线升级

1. 接口概述：在线升级授权码。
2. 请求URI：GET ip:port/rest/<pwd>/product/<productId>/update/<sn>

• 路径参数

3. 请求参数

   无

4. 响应参数

5. 请求示例

   GET 'http://192.168.0.49:8274/rest/bitanswer/product/URHQ-O5JQ/update/2FUMR5NFPI3NYZ2G'

6. 响应示例

{
    "status": 0
}

获取请求文件

1. 接口概述：离线激活/升级授权码时，调用接口产生一个请求文件，请求文件中会包含机器的硬件指纹（如CPU、MAC）等信息。
2. 请求URI：GET ip:port/rest/<pwd>/product/<productId>/requestCode/<sn>

• 路径参数

3. 请求参数

   无

4. 响应参数

5. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/product/URHQ-O5JQ/requestCode/2FUMR5NFPI3NYZ2G'

6. 响应示例

{
    "data": "<requestInfo>……</requestInfo>",
    "status": 0
}

使用升级文件

1. 接口概述：使用包含授权信息的升级文件，离线升级授权码。
2. 请求URI：POST ip:port/rest/<pwd>/ product/<productId>/applyUpdateCode

• 路径参数

3. 请求参数

• Body

  格式：application/x-www-form-urlencoded

4. 响应参数

5. 请求示例

POST 'http://192.168.0.49:8274/rest/bitanswer/product/URHQ-O5JQ/applyUpdateCode' 
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'code=<updateInfo>……</updateInfo>'

6. 响应示例

{
    "data": "<receipt><receiptInfo>……</receiptInfo></receipt>",
    "status": 0
}

获取借出串

1. 接口概述：获取离线获取永久借出串。

注意：借出的授权码在比特授权云平台已经勾选“授权分发”选项。

2. 请求URI：POST ip:port/rest/<pwd>/product/<productId>/borrow

• 路径参数

3. 请求参数

• Body

  格式：application/x-www-form-urlencoded

4. 响应参数

5. 请求示例

POST 'http://192.168.0.49:8274/rest/bitanswer/product/URHQ-O5JQ/borrow'
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'borrowRequest=<borrowRequest>……</borrowRequest>' \
--data-urlencode 'referenceId=bitanswerdemo_01'

6. 响应示例

<response>
    <status><code>0</code></status><data>
        <borrowResponse>
            <version>3</version>
            <type>CHECKOUT</type>
            <code>……</code>
            <sign>……</sign>
            <package>
                ……
            </package>
            <description>
                <product name="Bitanswer" />
                <activateDate>2025-07-02 06:02:50</activateDate>
                <sn>5G7YBW3LFU3NZEQO</sn>
                <clientVersion>13805</clientVersion>
                <ip>192.168.0.49</ip>
                <machine mid="0162EA5C6A03C6F0CF2D044E28DC17099D1F951C0A689F0828" />
                <referenceId>bitanswerdemo_01</referenceId>
                <borrowTime>144000</borrowTime>
            </description>
        </borrowResponse>
    </data>
</response>

获取分发的设备信息

1. 接口概述：查询分发的设备的信息。
2. 请求URI：GET ip:port/rest/<pwd>/product/<productId>/borrowclient

• 路径参数

3. 请求参数

4. 响应参数

5. 请求示例

GET 'http://192.168.0.116:8274/rest/1234qwer/product/URHQ-O5JQ/borrowclient?startTime=2025-07-01%2000:00:00&endTime=2025-07-10%2000:00:00'

6. 响应示例

<response>
  <status><code>0</code></status><data>
    <record>
      <computerName>DESKTOP-GOMFH6C</computerName>
      <custom />
      <durationDays>100</durationDays>
      <featureId>0</featureId>
      <featureName />
      <featureVer />
      <id>1</id>
      <mid>0162EA5C6A03C6F0CF2D044E28DC17099D1F951C0A689F0828</mid>
      <referenceId />
      <sn>5G7YBW3LFU3NZEQO</sn>
      <time>2025-07-02 05:57:27</time>
      <userName>dyw</userName>
    </record>
  </data>
</response>

踢出

1. 接口概述：踢出指定用户，被踢出的用户为退出登录状态，需要重新登录。
2. 请求URI：POST ip:port/rest/<pwd>/product/<productId>/killList

• 路径参数

3. 请求参数

• Body

  格式：application/x-www-form-urlencoded

4. 响应参数

5. 请求示例

POST 'http://192.168.0.49:8274/rest/bitanswer/product/URHQ-O5JQ/killList'
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'users=192.168.0.49'

6. 响应示例

<response>
    <status><code>0</code></status>
</response>

用户状态监控API

获取当前在线用户和排队用户信息

1. 接口概述：查询当前在线或排队的用户信息，支持按产品、特征项或特征项版本等筛选。
2. 请求URI：GET ip:port/rest/<pwd>/user

• 路径参数

3. 请求参数

4. 响应参数

5. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/user'

6. 响应示例

<response>
    <status><code>0</code></status><data>
        <machine>
            <account />
            <computerName>DESKTOP-GOMFH6C</computerName>
            <featureName>-</featureName>
            <featureVer>-</featureVer>
            <id>7450547815447C3I6I7VA5K7347X37KC37NOZM5FPVOBT</id>
            <ip>192.168.0.49</ip>
            <loginTime>2025-07-02 06:24:18</loginTime>
            <product>Bitanswer</product>
            <sn>6KZWXQDHYU3NYUU7</sn>
            <status>online</status>
            <userName>dyw</userName>
        </machine>
    </data>
</response>

获取用户使用信息（废弃）

1. 接口概述：查询数据库中的用户使用信息，支持按产品、特征项或特征项版本等筛选。

说明：

建议升级为获取log信息接口。

此信息的保存时间为两个月，每次调用接口显示最多不超过50000条数据。

2. 请求URI：GET ip:port/rest/<pwd>/statistics

• 路径参数

3. 请求参数

5. 响应参数

5. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/statistics'

6. 响应示例

<response>
  <status><code>0</code></status><data>
    <record>
      <account />
      <computerName>DESKTOP-GOMFH6C</computerName>
      <consumeFeatureVer>2021.11</consumeFeatureVer>
      <featureId>400</featureId>
      <featureName>PROCESSMANAGEMENT</featureName>
      <featureVer />
      <id>284845</id>
      <ip>192.168.0.49</ip>
      <loginTime>2025-07-01 09:02:47</loginTime>
      <logoutTime>2025-07-01 09:03:46</logoutTime>
      <pid>URHQ-O5JQ</pid>
      <sn>2FUMR5NFPI3NYZ2G</sn>
      <type>Query</type>
      <userName>dyw</userName>
      <userNumber>1</userNumber>
    </record>
  </data>
</response>

获取log信息

1. 接口概述：查询数据库中的日志信息，支持按产品、特征项、信息类型等筛选。

注意：此信息的保存时间为两个月，每次调用接口显示最多不超过10000条数据。

2. 请求URI：GET ip:port/rest/<pwd>/log

• 路径参数

3. 请求参数

注意：featureName和features为两种不同的筛选feature的方式，不支持同时传入。

5. 响应参数

5. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/log?featureName=PROCESSMANAGEMENT'

6. 响应示例

<response>
  <status><code>0</code></status><data>
    <record>
      <computerName>DESKTOP-GOMFH6C</computerName>
      <customComment />
      <featureId>400</featureId>
      <featureName>PROCESSMANAGEMENT</featureName>
      <featureVer>2021.11</featureVer>
      <id>284844</id>
      <ip>192.168.0.49</ip>
      <parentId>284843</parentId>
      <pid>URHQ-O5JQ</pid>
      <platformName>Windows</platformName>
      <sn>2FUMR5NFPI3NYZ2G</sn>
      <time>2025-07-01 09:02:47</time>
      <type>Query</type>
      <userName>dyw</userName>
    </record>
  </data>
</response>

删除log信息

1. 接口概述：删除数据库中的日志信息，支持按产品、时间段筛选删除。
2. 请求URI：POST ip:port/rest/<pwd>/log

• 路径参数

3. 请求参数

• Body

  格式：application/x-www-form-urlencoded

4. 响应参数

5. 请求示例

POST 'http://192.168.0.49:8274/rest/bitanswer/log'
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'method=delete' \
--data-urlencode 'product=URHQ-O5JQ' \
--data-urlencode 'startTime=2025-06-01' \
--data-urlencode 'endTime=2025-06-30'

6. 响应示例

<response>
    <status><code>0</code></status><data>
        <numDeleted>8</numDeleted>
    </data>
</response>

获取错误列表

1. 接口概述：查询数据库中的错误信息，支持按产品、特征项、特征项版本等筛选。

注意：此信息的保存时间为48小时，每次调用接口显示最多不超过10000条数据。

2. 请求URI：GET ip:port/rest/<pwd>/errors

• 路径参数

3. 请求参数

4. 响应参数

5. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/errors'

6. 响应示例

<response>
  <status><code>0</code></status><data>
    <record>
      <account />
      <computerName>DESKTOP-GOMFH6C</computerName>
      <featureId>0</featureId>
      <featureName>PROCESSMANAGEMENT</featureName>
      <featureVer>2029.11</featureVer>
      <ip>192.168.0.49</ip>
      <result>1283</result>
      <sn>2FUMR5NFPI3NYZ2G</sn>
      <time>2025-07-01 09:11:09</time>
      <type>Query</type>
      <userName>dyw</userName>
    </record>
  </data>
</response>

可能出现的错误码如下

访问控制API

添加访问规则

1. 接口概述：添加产品访问规则。
2. 请求URI：POST ip:port/rest/<pwd>/product/<productId>/rule

• 路径参数

3. 请求参数

4. 响应参数

5. 请求示例

POST 'http://192.168.0.49:8274/rest/bitanswer/product/URHQ-O5JQ/rule'

6. 响应示例

<response>
    <status><code>0</code></status>
</response>

删除访问规则

1. 接口概述：删除产品访问规则。
2. 请求URI：DELETE ip:port/rest/<pwd>/product/<productId>/rule

• 路径参数

3. 请求参数

4. 响应参数

5. 请求示例

DELETE 'http://192.168.0.49:8274/rest/bitanswer/product/URHQ-O5JQ/rule?rule=allow%20%2A'

6. 响应示例

<response>
    <status><code>0</code></status>
</response>

添加全局用户组

1. 接口概述：按群组添加白名单，控制集团服务的访问权限；若开启了白名单功能，只有白名单中放通的用户可以访问该集团服务。（集团授权管理中心界面配置方法请参见配置群组白名单规则）
2. 请求URI：POST ip:port/rest/<pwd>/ruleGroup

• 路径参数

3. 请求参数

• Body

  格式：application/x-www-form-urlencoded

4. 响应参数

5. 请求示例

POST 'http://192.168.0.49:8274/rest/bitanswer/ruleGroup'
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'name=bitanswergroup' \
--data-urlencode 'users=192.168.0.49
192.168.0.116'

6. 响应示例

<response>
    <status><code>0</code></status>
</response>

删除用户组里的用户

1. 接口概述：删除白名单中的用户。

注意：只支持对添加全局用户组接口配置的用户进行删除操作。

2. 请求URI：DELETE ip:port/rest/<pwd>/ruleGroup

• 路径参数

3. 请求参数

• Body

  格式：application/x-www-form-urlencoded

4. 响应参数

5. 请求示例

DELETE 'http://192.168.0.49:8274/rest/bitanswer/ruleGroup'
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'name=bitanswergroup' \
--data-urlencode 'users=192.168.0.47'

6. 响应示例

<response>
    <status><code>0</code></status>
</response>

查询用户组里的用户

1. 接口概述：查询白名单中的用户信息。

注意：只支持对添加全局用户组接口配置的用户进行查询操作。

2. 请求URI：GET ip:port/rest/<pwd>/ruleGroup/{name}

• 路径参数

3. 请求参数

   无

4. 响应参数

5. 请求示例

GET 'http://192.168.0.49:8274/rest/bitanswer/ruleGroup/bitanswergroup'

6. 响应示例

<response>
    <status><code>0</code></status><data>
        <users>
            <user>192.168.0.116</user>
            <user>192.168.0.49</user>
        </users>
    </data>
</response>

代理管理API

添加代理

1. 接口概述：添加代理
2. 请求URI：POST ip:port/rest/<pwd>/product/<productId>/addAgent

• 路径参数

3. 请求参数

4. 响应参数

释放代理

1. 接口概述：释放代理
2. 请求URI：POST ip:port/rest/<pwd>/product/<productId>/releaseAgent

• 路径参数

3. 请求参数

4. 响应参数

获取代理信息

1. 接口概述：获取代理信息
2. 请求URI：GET ip:port/rest/<pwd>/product/<productId>/getAgent

• 路径参数

3. 请求参数

   无

4. 响应参数