Networkリストの照会
    • PDF

    Networkリストの照会

    • PDF

    記事の要約

    VPC環境で利用できます。

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

    リクエスト

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

    メソッドURI
    GET/networks

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    pageIntegerOptionalページ番号
  • 0(デフォルト)
  • sizeIntegerOptional照会結果リストのサイズ
  • 20(デフォルト)
  • sortStringOptionalソートの基準
    • 昇順(デフォルト)
    • 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'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    contentArray-Contentの詳細情報
    totalElementsLong-ブロックチェーンネットワークの総数
    totalPagesInteger-ページの総数

    content

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

    フィールドタイプ必須の有無説明
    networkIdLong-ネットワーク ID
    networkNameString-ネットワーク名
    nksClusterNameString-Ncloud Kubernetes Serviceクラスタ名
    statusString-ネットワークの状態
    • ACTIVE | DEPLOY | DELETE
      • ACTIVE: 運用中
      • DEPLOY: デプロイ中
      • DELETE: 削除中
    createDateLocalDateTime-ネットワークの作成日時(YYYY-MM-DDTHH:MM:SS+0000)
    updateDateLocalDateTime-ネットワークの更新日時(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
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.