モジュール名: proxy

機能名 説明
get プロキシの情報を取得します
set プロキシの情報を変更します

機能名: get

説明

プロキシの情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/proxy/get
リクエストパラメーター

なし

リクエスト例
GET /mcapi/proxy/get HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとプロキシの情報が返ります。
HTTPプロキシとHTTPSプロキシの情報としては次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "http": {
                "serverName": "test.proxy.com",
                "port": 2021,
                "realm": "http",
                "userName": "test"
            },
            "https": {
                "serverName": "test.proxy.com",
                "port": 20433,
                "realm": "https",
                "userName": "test2"
            }
        }
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 ファイルの読み込みでエラーが発生した場合
5003 ファイルの解析でエラーが発生した場合
5301 復号化でエラーが発生した場合

▲ このページのトップへ

機能名: set

説明

プロキシの情報を変更します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/proxy/set
リクエストパラメーター
なし

リクエスト例
設定する情報は、getで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
ただし、パスワードを変更する場合、パスワード(password)は必須となります。
POST /mcapi/proxy/set HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 255

{
    "http": {
        "serverName": "test.proxy.com",
        "port": 2021,
        "realm": "http",
        "userName": "test",
        "password": "test"
    },
    "https": {
        "serverName": "test.proxy.com",
        "port": 20433,
        "realm": "https",
        "userName": "test2",
        "password": "test2"
    }
}
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとプロキシの情報を変更します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
400 Bad Request 2101 Jsonデータの値が正しくなかった場合
2102 Jsonデータの必須項目が入力されなかった場合
2103 Jsonデータの値のデータ型が正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 ファイルの読み込みでエラーが発生した場合
5002 ファイルの書き込みでエラーが発生した場合
5003 ファイルの解析でエラーが発生した場合
5302 暗号化でエラーが発生した場合

▲ このページのトップへ