移動

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

コントロール・プレーン構成の作成または更新

post

/api/v1/configuration/cpConfig/list

指定したコントロール・プレーン構成をすべて作成または更新します。

リクエスト

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

• application/json

本文()

JSONのリクエスト・ペイロード

ルート・スキーマ: schema

型: array

ソースの表示

• 配列: object CpConfigDetail
  コントロール・プレーン構成の詳細

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CpConfigDetail"
    }
}

ネストしたスキーマ: CpConfigDetail

型: object

コントロール・プレーン構成の詳細

ソースの表示

• cpConfigName: string
• cpConfigValue: string

{
    "description":"Control plane configuration details",
    "type":"object",
    "properties":{
        "cpConfigName":{
            "type":"string"
        },
        "cpConfigValue":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

400レスポンス

不正なリクエスト

401レスポンス

未認可

409レスポンス

操作の競合

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors: array errors
  エラーのリスト
• message(必須): string
  判読可能なエラー文字列。
• status(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings: array warnings
  警告のリスト

{
    "description":"Error information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"List of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"List of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"List of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"List of warnings",
    "items":{
        "type":"string"
    }
}

500レスポンス

サービス使用不可

先頭に戻る

例

このエンドポイントは、Blockchain Platform内の指定されたコントロール・プレーン構成を更新するために使用します。

次の例では、cURLを使用してRESTリソースに対するPOSTリクエストを発行し、コントロール・プレーン構成の名前を更新する方法を示します。

curl -X POST \
  http://<hostname>:<port>/api/v1/configuration/cpConfig/list \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate' \
  -H 'Authorization: Basic b2JwdXNlcjphd2RyVEhVSzEh' \
  -H 'Connection: keep-alive' \
  -H 'Content-Length: 94' \
  -H 'Content-Type: application/json' \
  -H 'Host: localhost:17070' \
  -H 'User-Agent: PostmanRuntime/7.15.2' \
  -d '<Request Body>'

リクエスト本文の例

JSON形式のリクエスト本文のコンテンツの例を次に示します。

[
    {
        "cpConfigName": "testCPconfig",
        "cpConfigValue": "newCPconfig"
    }
]

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "status": "200",
    "message": "Configuration Saved successfully"
}

先頭に戻る