Networkリストの照会

VPC環境で利用できます。

ブロックチェーンネットワークのリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/networks

リクエストヘッダ

Blockchain Service APIで共通して使用されるヘッダの詳細は、Blockchain Serviceの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`page`	Integer	Optional	ページ番号 0(デフォルト)
`size`	Integer	Optional	照会結果リストのサイズ 20(デフォルト)
`sort`	String	Optional	ソートの基準昇順(デフォルト) `networkId` \| `networkName` \| `nksClusterName` \| `networkStatus` \| `createDt` \| `updateDt` `networkId`: ネットワーク ID `networkName`: ネットワーク名 `nksClusterName`: Ncloud Kubernetes Serviceクラスタ名 `networkStatus`: ネットワークの状態 `createDt`: ネットワークの作成日時 `updateDt`: ネットワークの更新日時

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks?page=0&size=20&sort=networkName' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`content`	Array	-	Contentの詳細情報
`totalElements`	Long	-	ブロックチェーンネットワークの総数
`totalPages`	Integer	-	ページの総数

`content`

contentの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`networkId`	Long	-	ネットワーク ID
`networkName`	String	-	ネットワーク名
`nksClusterName`	String	-	Ncloud Kubernetes Serviceクラスタ名
`status`	String	-	ネットワークの状態 `ACTIVE` \| `DEPLOY` \| `DELETE` `ACTIVE`: 運用中 `DEPLOY`: デプロイ中 `DELETE`: 削除中
`createDate`	LocalDateTime	-	ネットワークの作成日時(YYYY-MM-DDTHH:MM:SS+0000)
`updateDate`	LocalDateTime	-	ネットワークの更新日時(YYYY-MM-DDTHH:MM:SS+0000)

レスポンスステータスコード

Blockchain Service APIで共通して使用されるレスポンスステータスコードの詳細は、Blockchain Serviceの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "content": [
        {
            "networkId": 1630,
            "networkName": "******-blockchain-test1",
            "nksClusterName": "blockchain-test (1.28.10)",
            "status": "ACTIVE",
            "createDate": "2024-07-29T07:25:39+0000",
            "updateDate": "2024-07-29T07:30:59+0000"
        },
        {
            "networkId": 1635,
            "networkName": "******-blockchain-test2",
            "nksClusterName": "blockchain-test (1.28.10)",
            "status": "DEPLOY",
            "createDate": "2024-08-06T06:27:24+0000",
            "updateDate": "2024-08-06T06:27:24+0000"
        }
    ],
    "totalElements": 2,
    "totalPages": 1
}