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`: 네트워크 아이디 `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	-	네트워크 아이디
`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
}