移動

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

サーバー構成の取得

get

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

必要なロール: Administrator、SuperUser、DetailMonitoringOperator、MonitoringOperator、CommandLineOperator

Veridataサーバー構成プロパティをキーと値のペアとして取得します。

リクエスト

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

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

サーバー構成が正常に取得されました

本文()

ルート・スキーマ: ServerParams

タイプ: object

ソースの表示

• serverParameters: array serverParameters

{
    "type":"object",
    "properties":{
        "serverParameters":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServerMetadata"
            }
        }
    }
}

ネストされたスキーマ: serverParameters

タイプ: array

ソースの表示

• 配列: object ServerMetadata

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServerMetadata"
    }
}

ネストされたスキーマ: ServerMetadata

タイプ: object

ソースの表示

• databaseSupported: array databaseSupported
• defaultValue: string
• description: string
• isDefault: boolean
• max: integer
• min: integer
• name: string
• supportedValues: array supportedValues
• type: string
  指定できる値: [ "BOOLEAN", "ENUM", "INTEGER", "STRING" ]
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "defaultValue":{
            "type":"string"
        },
        "isDefault":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/ConfigType"
        },
        "supportedValues":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "databaseSupported":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "min":{
            "type":"integer"
        },
        "max":{
            "type":"integer"
        }
    }
}

ネストされたスキーマ: databaseSupported

タイプ: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: supportedValues

タイプ: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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"
}

先頭に戻る