IoT Connect Gateway コンフィグマネージャー APIリファレンス (1.0.0)

Download OpenAPI specification:Download

IoT Connect Gateway コンフィグマネージャー APIリファレンス

デバイスエンドポイント（バージョン指定なし）

コンフィグとコンフィグステータスを取得するためのデバイス用API。デバイスからのIPアドレス情報をもとにSIMを判別し、レスポンスを生成する。

コンフィグを取得する

エントリポイントfull_pathのコンフィグを取得する。

本APIは/v1/{full_path}にリダイレクトされる。

path Parameters

full_path

required

string

Example: apache.conf

エントリーポイント

header Parameters

content-length

string

Example: 0

Responses

200

404

Not Found

get/{full_path}

http://config-an1.icgw.ntt.com/{full_path}

Response samples

Content type

text/plain

Copy

A Sample Config

コンフィグステータスを取得する

エントリポイントfull_pathのコンフィグステータスを取得する。

本APIは/v1/status/{full_path}にリダイレクトされる。

path Parameters

full_path

required

string

Example: apache.conf

エントリーポイント

header Parameters

content-length

string

Example: 0

Responses

200

404

Not Found

get/status/{full_path}

http://config-an1.icgw.ntt.com/status/{full_path}

Response samples

Content type

Copy

Expand all Collapse all


{"updatedAt": "2021-12-09T02:49:19.526000",
"url": "http://config-an1.icgw.ntt.com/v1/apache.conf",
"isFetched": false,
"fetchedAt": "2021-12-09T02:59:19.526000"
}

コンフィグステータスの一覧を取得する

デバイスが利用可能なコンフィグステータスの一覧を取得する。

本APIは/v1/statusにリダイレクトされる。

header Parameters

content-length

string

Example: 0

Responses

200

404

Not Found

get/status

http://config-an1.icgw.ntt.com/status

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"config policy 1": 
{"updatedAt": "2021-12-09T02:49:19.526000",
"url": "http://config-an1.icgw.ntt.com/v1/apache.conf",
"isFetched": false,
"fetchedAt": null
},
"config policy 2": 
{"updatedAt": "2021-12-09T04:49:19.526000",
"url": "http://config-an1.icgw.ntt.com/v1/httpd.conf",
"isFetched": true,
"fetchedAt": "2022-11-14T15:33:33.428000"
}
}

デバイスエンドポイント（v1）

コンフィグとコンフィグステータスを取得するためのデバイス用API。デバイスからのIPアドレス情報をもとにSIMを判別し、レスポンスを生成する。

コンフィグを取得する

エントリポイントfull_pathのコンフィグを取得する。

path Parameters

full_path

required

string

Example: apache.conf

エントリーポイント

header Parameters

content-length

string

Example: 0

Responses

200

404

Not Found

get/v1/{full_path}

http://config-an1.icgw.ntt.com/v1/{full_path}

Response samples

Content type

text/plain

Copy

A Sample Config

コンフィグステータスを取得する

エントリポイントfull_pathのコンフィグステータスを取得する。

path Parameters

full_path

required

string

Example: apache.conf

エントリーポイント

header Parameters

content-length

string

Example: 0

Responses

200

404

Not Found

get/v1/status/{full_path}

http://config-an1.icgw.ntt.com/v1/status/{full_path}

Response samples

Content type

Copy

Expand all Collapse all


{"updatedAt": "2021-12-09T02:49:19.526000",
"url": "http://config-an1.icgw.ntt.com/v1/apache.conf",
"isFetched": false,
"fetchedAt": "2021-12-09T02:59:19.526000"
}

コンフィグステータスの一覧を取得する

デバイスが利用可能なコンフィグステータスの一覧を取得する。

header Parameters

content-length

string

Example: 0

Responses

200

404

Not Found

get/v1/status

http://config-an1.icgw.ntt.com/v1/status

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"config policy 1": 
{"updatedAt": "2021-12-09T02:49:19.526000",
"url": "http://config-an1.icgw.ntt.com/v1/apache.conf",
"isFetched": false,
"fetchedAt": null
},
"config policy 2": 
{"updatedAt": "2021-12-09T04:49:19.526000",
"url": "http://config-an1.icgw.ntt.com/v1/httpd.conf",
"isFetched": true,
"fetchedAt": "2022-11-14T15:33:33.428000"
}
}