移動

• リクエスト
• レスポンス

サーバー構成の更新

patch

http://{host}:{port}/veridata/v1/services/server/configuration

必要なロール: Administrator

キーと値のペアを使用してVeridataサーバー構成プロパティを更新します。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• coos.join.strategy: string
  例: nokey
• database.hash: boolean
  データベースでデータ・ハッシュを実行するかどうかを定義します。

  例: false
• mail.alert.only: boolean
  trueの場合、アラート電子メールのみを送信します(完了ではない)。

  例: true
• mail.enabled: boolean
  電子メール通知を有効化/無効化します。

  例: false
• mail.from: string
  例: [e-mail]
• mail.smtp.connection.ssl.tls: boolean
  例: false
• mail.smtp.port: integer
  SMTPサーバー・ポート。

  例: 25
• mail.smtp.server: string
  SMTPサーバーのホスト名。

  例: smtp.host.com
• mail.to: string
  例: [e-mail], [e-mail]
• max_lob_key_len: integer
  例: 0
• repair.oracle.tag: string
  例: 9A
• repair.oracle.tag.enable: boolean
  例: true
• server.convert_empty_to_null: boolean
  例: true
• server.encryption: string
  例: true
• server.encryption.bits: integer
  例: 128
• server.mapped_sort_buffers: boolean
  例: true
• server.max_concurrent_comparison_threads: integer
  例: 4
• server.max_sort_memory: string
  例: 1000M
• server.memory_mapped_sort_directory: string
  例:
• server.meta_session_handle_timeout: integer
  メタセッションハンドルのタイムアウト(秒)。

  例: 900
• server.number_sort_threads: integer
  すべての比較の合計ソート・メモリーを設定します。

  例: 4
• server.veridata_data: string
  Veridataサーバー・データ・ディレクトリへのパス。

  例: /scratch/nextgen/veridata_server_backup
• skiprows.enabled: boolean
  例: true
• socket.timeout.mins: integer
  例: 0
• truncate_spaces_len: integer
  例: 1
• zlib.buffer.flush.size: integer
  例: 100000

{
    "type":"object",
    "properties":{
        "server.veridata_data":{
            "type":"string",
            "example":"/scratch/nextgen/veridata_server_backup",
            "description":"Path to the Veridata server data directory."
        },
        "server.encryption":{
            "type":"string",
            "example":"true"
        },
        "server.encryption.bits":{
            "type":"integer",
            "example":128
        },
        "database.hash":{
            "type":"boolean",
            "example":"false",
            "description":"Defines whether data hashing is done in the database."
        },
        "server.max_concurrent_comparison_threads":{
            "type":"integer",
            "example":4
        },
        "server.memory_mapped_sort_directory":{
            "type":"string",
            "example":""
        },
        "server.meta_session_handle_timeout":{
            "type":"integer",
            "example":900,
            "description":"Timeout (in seconds) for meta-session handle."
        },
        "server.max_sort_memory":{
            "type":"string",
            "example":"1000M"
        },
        "server.number_sort_threads":{
            "type":"integer",
            "example":4,
            "description":"Sets total sort memory for all comparisons."
        },
        "mail.enabled":{
            "type":"boolean",
            "example":"false",
            "description":"Enables/disables email notifications."
        },
        "mail.alert.only":{
            "type":"boolean",
            "example":"true",
            "description":"If true, send only alert emails (not completion)."
        },
        "mail.smtp.server":{
            "type":"string",
            "example":"smtp.host.com",
            "description":"SMTP server hostname."
        },
        "mail.smtp.port":{
            "type":"integer",
            "example":25,
            "description":"SMTP server port."
        },
        "mail.smtp.connection.ssl.tls":{
            "type":"boolean",
            "example":"false"
        },
        "mail.from":{
            "type":"string",
            "example":"[e-mail]"
        },
        "mail.to":{
            "type":"string",
            "example":"[e-mail], [e-mail]"
        },
        "max_lob_key_len":{
            "type":"integer",
            "example":0
        },
        "server.convert_empty_to_null":{
            "type":"boolean",
            "example":true
        },
        "socket.timeout.mins":{
            "type":"integer",
            "example":0
        },
        "truncate_spaces_len":{
            "type":"integer",
            "example":1
        },
        "server.mapped_sort_buffers":{
            "type":"boolean",
            "example":true
        },
        "repair.oracle.tag.enable":{
            "type":"boolean",
            "example":true
        },
        "repair.oracle.tag":{
            "type":"string",
            "example":"9A"
        },
        "coos.join.strategy":{
            "type":"string",
            "example":"nokey"
        },
        "skiprows.enabled":{
            "type":"boolean",
            "example":true
        },
        "zlib.buffer.flush.size":{
            "type":"integer",
            "example":100000
        }
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200 レスポンス

サーバー構成が正常に更新されました

本文()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• message: string
  例: Configurations updated successfully

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "example":"Configurations updated successfully"
        }
    }
}

400 レスポンス

不正なリクエスト

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 レスポンス

権限がありません

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 レスポンス

ロールが見つかりません

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

409レスポンス

競合

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

429レスポンス

リクエストが多すぎます

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 レスポンス

サーバー・エラー

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

先頭に戻る