8. システム構成インターフェース
8.1 NTP設定のQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | NTPの時刻同期の設定をQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1291” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
ntp_cycle | int | 同期サイクル 範囲は[1分,30分]、デフォルト値:10分 |
ntp_disable | string | NTPを無効にするか。有効にするか。 0:NTPを無効にしない 1:NTPを無効にする |
port | int | NTPサーバのポート番号 |
url | string | NTPサーバのURL |
リクエストの例
レスポンスの例
8.2 NTP設定の変更
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | NTPの時刻同期の設定を変更します。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1290” | Yes | |
url | string | NTPサーバーのURL
デフォルト値: | No | |
ntp_cycle | string | 同期サイクル 範囲は[1分,30分]、デフォルト値:10分 | No | 10 |
ntp_disable | string | NTPを無効にするか。有効な値 0:NTPを無効にしない、1:NTPを無効にする デフォルト値:1 | No |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | Null |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.3 バージョン情報のQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | バージョン情報をQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1281” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
device_id | string | デバイスID |
serial_id | string | SN |
version | string | サーバのバージョン |
web_version | string | Webのバージョン |
リクエストの例
レスポンスの例
8.4 ストレージプランのQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | ストレージプランをQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1288” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
cur_storage | int | 占有している保存スペース |
max_storage | int | 最大保存域 |
storage_strategy | int | 有効な値 1:古いレコードから上書き 2:レコードを停止 |
リクエストの例
レスポンスの例
8.5 ストレージプランの変更
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | ストレージを変更します。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1287” | Yes | |
storage_strategy | int | 有効な値 1:古いレコードから上書き 2:レコードを停止 | Yes | 1 or 2 |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | Null |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.6 システム時刻のQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | システム時刻をQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1283” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
sys_time | string | システム時刻 |
time_format | string | 時刻のフォーマット |
time_zone | string | タイムゾーン |
リクエストの例
レスポンスの例
8.7 システム時刻の設定
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | システム時刻を設定します。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1282” | Yes | |
sys_time | string | システム時刻 | Yes | 2019-01-14 12:23:45 |
time_zone | string | タイムゾーン | Yes | GMT+08:00 |
time_format | string | 時刻のフォーマット yyyy-mm-dd、dd-mm-yyyy、またはmm-dd-yyyyのいずれかが可能です。 | No | yyyy-MM-dd HH:mm:ss |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | Null |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.8 ネットワーク構成のQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | ネットワーク構成をQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1297” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
default_info | json | 戻りデータ |
ethernet | json list | ネットワーク構成 |
フィールド情報(default_info)
パラメーター | 型 | 説明 |
dns_method | string | DNS取得方法 |
ethname | string | ネットワークインターフェースカード(NIC)名 |
first_dns | string | プライマリDNS |
second_dns | string | セカンダリDNS |
フィールド情報(ethernet)
パラメーター | 型 | 説明 |
ethname | string | ネットワークインターフェースカード(NIC)名 |
gateway | string | ゲートウェイ |
hw_addr | string | MACアドレス |
ip | string | IPアドレス |
ip_method | string | IPアドレスの取得方法 スタティックまたはDHCPを選択可能 |
ip_version | string | IPバージョン |
netmask | string | サブネットマスク |
リクエストの例
レスポンスの例
8.9 ネットワーク設定の構成
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | ネットワーク設定を構成します。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1296” | Yes | |
ethname | string | ネットワークインターフェースカード(NIC)名 | Yes | |
ip | string | IP アドレス | Yes | |
ip_method | string | IP取得方法 | Yes | 静的またはDHCP |
netmask | string | サブネットマスク | Yes | |
gateway | string | ゲートウェイ | Yes | |
ip_version | string | IPバージョン | Yes | IPv4またはIPv6 |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | Null |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.10 デフォルトのネットワークポートの設定
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | デフォルトのネットワークポートを設定します。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1295” | Yes | |
dns_method | string | DNS取得方法 | Yes | 静的またはDHCP |
first_dns | string | プライマリDNS | No | |
second_dns | string | セカンダリDNS | No | |
ethname | string | ネットワークインターフェースカード(NIC)名 | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | Null |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.11 ストレージモードのQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | ストレージモードをQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1900” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
capture | string | データベースに入って画像を保存するかどうか。 0番目の文字はデータベースに入ることを意味し、最初の文字は画像を保存することを意味します。0は保存されません、1は保存されます。 |
biometric | string | 顔データベースが画像を保存するかどうか。 0は保存されません、1は保存されます。 |
リクエストの例
レスポンスの例
8.12 ストレージモードの設定
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | ストレージモードを設定します。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1901” | Yes | |
capture | string | データベースに入ってキャプチャ画像を保存する 11はデータベースに入力してキャプチャ画像を保存することを意味し、00は保存しないことを意味する | Yes | 11 |
biometric | string | データベースに入力して画像を保存するか 1はデータベースに入力して画像を保存、0は保存しない | Yes | 1 |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | Null |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.13 ソフトウェアのアップグレード
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | FORM |
インターフェースの説明 | ソフトウェアをアップグレードします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1292” | Yes | |
file | file | ファイル | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | Null |
msg | string | 結果の説明 |
ソフトウェアのアップグレードが完了した後、システムが自動的に再起動するまでお待ちください。
リクエストの例
レスポンスの例
8.14 システム再起動
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | システムを再起動します。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1294” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.15 システムのシャットダウン
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | システムをシャットダウンします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1337” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.16 デバイスIDのQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | デバイスIDをQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1301” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
device_id | string | デバイスID |
リクエストの例
レスポンスの例
8.17 デバイスIDの変更
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | デバイスIDを変更します。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1300” | Yes | |
device_id | string | デバイスID | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | Null |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.18 システムログファイルのエクスポート
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | システムログファイルをエクスポートします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1331” | Yes | |
start_time | string | ログの開始時刻 現在のシステムログでは、日単位でのエクスポートしかサポートしていません。Start_timeはxxxx-xx-xx 00:00:00のような形式で表示されます。 | Yes | “2019-08-29 00:00:00” |
stop_time | string | ログの停止時刻 現在のシステムログでは、日単位でのエクスポートしかサポートしていません。Stop_timeはxxxx-xx-xx 23:59:59のような形式で表示されます。 | Yes | “2019-08-29 23:59:59” |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | string | ログの停止時刻 現在のシステムログでは、日単位でのエクスポ圧縮されたログファイルのウェブパスを出力 例: |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.19 ユーザー操作ログのQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | ユーザー操作ログをQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1318” | Yes | |
start_no | int | 開始番号 int、1から | No | デフォルト値 1 |
qry_len | int | Query数 整数、最大 50 | No | デフォルト値 10 |
user_name | string | ユーザー名 | No | |
log_type | int | ログタイプ 1:ログイン 2:ログアウト 3:機能操作 整数 | No | |
start_time | string | 開始時刻 時刻のフォーマット:yyyy-mm-dd HH: mm: SS | No | 2019-09-02 10:10:10 |
stop_time | string | 停止時刻 時刻のフォーマット:yyyy-mm-dd HH: mm: SS | No | 2019-09-02 20:20:20 |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
record | json list | 戻りデータ |
result_num | int | Query結果の数 |
total_num | int | 総レコード数 |
フィールド情報(レコード)
パラメーター | 型 | 説明 |
func_module | int | 機能モジュール |
msg_id | int | メッセージID |
user_name | string | ユーザー名 |
op_desc | string | 操作説明 |
log_type | int | ログタイプ パラメータは正である必要があります。 |
op_result | int | 操作結果 |
op_time | string | 操作時刻 |
リクエストの例
レスポンスの例
8.20 システム状況ログのQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | システム状況ログをQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1319” | Yes | |
start_no | int | 開始番号 int、1から | No | デフォルト値 1 |
qry_len | int | Query数 整数、最大 50 | No | デフォルト値 10 |
log_type | int | ログタイプ 1:起動 2:シャットダウン 3:再起動 4:ネットワークポートの状態 | No | |
start_time | string | 開始時刻 時刻のフォーマット: yyyy-mm-dd HH: mm: SS | No | 2019-09-02 10:10:10 |
stop_time | string | 終了時刻 時刻のフォーマット:YYYY-MM-DD HH:MM:SS | No | 2019-09-02 20:20:20 |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
record | json list | 戻りデータ |
result_num | int | Query結果の数 |
total_num | int | 総レコード数 |
フィールド情報(レコード)
パラメーター | 型 | 説明 |
log_type | int | ログタイプ |
log_code | int | ログコード |
log_desc | string | ログの説明 |
log_time | string | ログの時刻 |
リクエストの例
レスポンスの例
8.21 デフォルトの設定に戻す
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | 初期設定に戻します 一般設定、ネットワーク設定、セキュリティ設定は除きます、その他のモデルは初期設定に戻されます |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1317” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | string | Null |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.22 Webアクセス機能のオープン
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | Webアクセス機能を開きます。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1315” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | string | Null |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.23 Webアクセス機能のクローズ
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | Webアクセス機能をクローズします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1316” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | string | Null |
msg | string | 結果の説明 |
リクエストの例
レスポンスの例
8.24 CPU情報のQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | CPU情報をQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1313” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
cpu_type | string | CPU 型 |
cpu_usage | double | CPU使用率 |
kernel_num | int | CPUカーネル番号 |
リクエストの例
レスポンスの例
8.25 メモリ情報のQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | メモリ情報をQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1314” | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
code | int | 結果コード(0:成功) |
data | json | 戻りデータ |
msg | string | 結果の説明 |
フィールド情報(データ)
パラメーター | 型 | 説明 |
memory_usage | double | メモリ使用量 |
total_memory | int | 総メモリ容量 |
リクエストの例
レスポンスの例
8.26 ユーザーデータ保存期間の設定
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | ユーザーデータの保存期間を設定します。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1902” | Yes | |
store_obj | int | 保存されたオブジェクトのタイプ 1つの画像ライブラリ、33のキャプチャ画像。 | Yes | |
saved_time | int | 画像の保存期間 [0~360] | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
msg_id | string | メッセージID |
result | int | ユーザーデータ保存期間の設定の結果 0:OK その他:エラー |
リクエストの例
レスポンスの例
8.27 ユーザデータ保存期間のQuery
インターフェースの説明
インターフェースのURL |
|
リクエストメソッド | POST |
リクエストパラメーター形式 | JSON |
インターフェースの説明 | ユーザデータ保存期間をQueryします。 |
リクエストパラメーター
パラメーター | 型 | 説明 | 必須 | 例 |
msg_id | string | “1903” | Yes | |
store_obj | int | 保存された画像のタイプ 1:顔データベース 33:キャプチャ画像 | Yes |
レスポンスパラメーター
パラメーター | 型 | 説明 |
msg_id | string | “1903” |
result | int | ユーザデータ保存期間のQuery結果 0:OK その他:エラー |
store_obj | int | 保存された画像のタイプ 1:顔データベース 33:キャプチャ画像 |
saved_time | int | 画像の保存期間 [0~360] |
リクエストの例
レスポンスの例
Last updated