10. https設定用インターフェース

10.1 https証明書とキーのアップロード

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/form

リクエストメソッド

POST

リクエストパラメーター形式

FORM

インターフェースの説明

https証明書とキーをアップロードします。

リクエストパラメーター

パラメーター

型

説明

必須

例

msg_id

string

“1302”

Yes

file

file

httpsファイル

Yes

file_type

string

httpsファイルタイプ

crt：証明書

key：キー

Yes

レスポンスパラメーター

パラメーター

型

説明

code

int

結果コード（0：成功）

data

json

Null

msg

string

結果の説明

リクエストの例

Input Files
{
    'file':name='server.crt'
}
data
{
    "msg_id":"1302",
    "file_type":"crt"
}

レスポンスの例

{
    "code": 0,
    "data": "",
    "msg": ""
}

リクエストの例

Input Files
{
    'file':name='server.key'
}
data
{
    "msg_id":"1302",
    "file_type":"key"
}

レスポンスの例

{
    "code": 0,
    "data": "",
    "msg": ""
}

10.2 https証明書とキーの削除

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

https証明書とキーを削除します。

リクエストパラメーター

パラメーター

型

説明

必須

例

msg_id

string

“1303”

Yes

file_type

string

httpsファイルタイプ

crt：証明書

key：キー

Yes

“crt” or “key”

レスポンスパラメーター

パラメーター

型

説明

code

int

結果コード（0：成功）

data

json

Null

msg

string

結果の説明

リクエストの例

{
    "msg_id": "1303",
    "file_type":"crt"
}

レスポンスの例

{
    "code": 0,
    "data": "",
    "msg": ""
}

リクエストの例

{
    "msg_id": "1303",
    "file_type":"key"
}

レスポンスの例

{
    "code": 0,
    "data": "",
    "msg": ""
}

10.3 HTTPS証明書とキーのQuery

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

HTTPS証明書とキーをQueryします。

リクエストパラメーター

パラメーター

型

説明

必須

例

msg_id

string

“1304”

Yes

レスポンスパラメーター

パラメーター

型

説明

code

int

結果コード（0：成功）

data

json

戻りデータ

msg

string

結果の説明

フィールド情報(データ)

パラメーター

型

説明

https_crt

string

HTTPS認証後に発行される証明書

https_key

string

HTTPSプライベートキー

リクエストの例

{
    "msg_id": "1304"
}

レスポンスの例

{
    "code": 0,
    "data": {
        "https_crt":server.crt,
        "https_key":server.key
     }
    "msg": ""
}

10.4 HTTPSまたはHTTPへの切り替え

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

HTTPSまたはHTTPに切り替えます。

リクエストパラメーター

パラメーター

型

説明

必須

例

msg_id

string

“1305”

Yes

prot_mode

string

HTTPSまたはHTTPモードへの切り替え

Yes

“http” or “https”

レスポンスパラメーター

パラメーター

型

説明

code

int

結果コード（0：成功）

data

json

Null

msg

string

結果の説明

HTTPSまたはHTTPモードに切り替えた後、システムが自動的に再起動するまで待ちます。

リクエストの例

{
    "msg_id": "1305",
    "prot_mode":"http"
}

レスポンスの例

{
    "code": 0,
    "data": ""
    "msg": ""
}

10.5 現在のモード（HTTPSまたはHTTP）のQuery

インターフェースの説明

インターフェースのURL

https://${ip}:${port}/api/json

リクエストメソッド

POST

リクエストパラメーター形式

JSON

インターフェースの説明

現在のモード（HTTPSまたはHTTP）をQueryします。

リクエストパラメーター

パラメーター

型

説明

必須

例

msg_id

string

“1306”

Yes

レスポンスパラメーター

パラメーター

型

説明

code

int

結果コード（0：成功）

data

json

返された結果

msg

string

結果の説明

フィールド情報(データ)

パラメーター

型

説明

https_stat

string

HTTPSまたはHTTP

リクエストの例

{
    "msg_id": "1306"
}

レスポンスの例

{
    "code": 0,
    "data": {
        "https_stat":"http"
    },
    "msg": ""
}
Previous9. http設定用インターフェースNext11. WebSocketによるアラート展開結果のプッシュに関連するインターフェース

Last updated