移動

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

コントロール・プレーン構成の取得

get

/api/v1/configuration/cpConfig/{configName}

指定したコントロール・プレーン構成を取得します。

リクエスト

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

• application/json

パス・パラメータ

• configName(必須): string
  一意のコントロール・プレーン構成の識別子

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: CpConfigDetail

型: object

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

ソースの表示

• cpConfigName: string
• cpConfigValue: string

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

400レスポンス

不正なリクエスト

401レスポンス

未認可

500レスポンス

サービス使用不可

先頭に戻る

例

このエンドポイントは、Blockchain Platform内の特定のコントロール・プレーン構成の詳細を取得するために使用されます。

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行し、コントロール・プレーン構成レポートを生成する方法を示しています。

curl -X GET \
  'http://<hostname>:<port>/api/v1/configuration/cpConfig/?configName=<unique LDAP config identifier>'

たとえば、

curl -X GET \
  'http://localhost:17070/api/v1/configuration/cpConfig/?configName=a455c6ab-dc36-4553-90c4-bbbb3532bc50'

レスポンス本文の例

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

{
    "activeLdapId": "a455c6ab-dc36-4553-90c4-bbbb3532bc50",
    "controlPlaneId": "MyBPM",
    "defaultUserDisabled": "false"
}

先頭に戻る