移動

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

チャネル情報の取得

get

/console/admin/api/v2/channels/{channelName}

チャネル名で問い合せてチャネルの情報を取得できます。

リクエスト

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

• application/json

パス・パラメータ

• channelName(必須): string
  チャネル名

先頭に戻る

レスポンス

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

• application/json

200レスポンス

チャネルの情報

本文()

ルート・スキーマ: channelinfo

型: object

ソースの表示

• ACL: object ACL
• orgUnits: object orgUnits

{
    "type":"object",
    "properties":{
        "orgUnits":{
            "type":"object",
            "properties":{
                "MSPs":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "id":{
                                "type":"string"
                            }
                        }
                    }
                },
                "anchorpeers":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "example":{
                "MSPs":[
                    {
                        "id":"org1MSP"
                    }
                ],
                "anchorpeers":[
                ]
            }
        },
        "ACL":{
            "type":"object"
        }
    }
}

ルート・スキーマ: ACL

型: object

ルート・スキーマ: orgUnits

型: object

ソースの表示

• anchorpeers: array anchorpeers
• MSPs: array MSPs

{
    "type":"object",
    "properties":{
        "MSPs":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string"
                    }
                }
            }
        },
        "anchorpeers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "example":{
        "MSPs":[
            {
                "id":"org1MSP"
            }
        ],
        "anchorpeers":[
        ]
    }
}

例:

{
    "MSPs":[
        {
            "id":"org1MSP"
        }
    ],
    "anchorpeers":[
    ]
}

ルート・スキーマ: anchorpeers

型: array

ソースの表示

• 配列: string

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

ルート・スキーマ: MSPs

型: array

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: items

型: object

ソースの表示

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

400レスポンス

無効な引数

本文()

ルート・スキーマ: 400errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

例:

{
    "respMesg":"invalid argument"
}

401レスポンス

未認可

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: 500errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

デフォルト・レスポンス

予期しないエラー

本文()

ルート・スキーマ: errorModel

型: object

ソースの表示

• code(必須): integer(int32)
• message(必須): string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る