Documentation Index

Fetch the complete documentation index at: https://cli-fin.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudMssqlInstanceList

Prev Next

Cloud DB for MSSQL 인스턴스 목록을 조회합니다.

구문

getCloudMssqlInstanceList 구문은 다음과 같습니다.

./ncloud vmssql getCloudMssqlInstanceList \
    [--zoneCode <zone-code>] \
    [--vpcNo <vpc-no>] \
    [--subnetNo <subnet-no>] \
    [--cloudMssqlServiceName <service-name>] \
    [--cloudMssqlInstanceNoList <instance-no-list>] \
    [--cloudMssqlServerName <server-name>] \
    [--cloudMssqlServerInstanceNoList <server-instance-no-list>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <FKR>] \
    [--output <json|xml>]

옵션

getCloudMssqlInstanceList 실행 시 지정할 수 있는 옵션을 설명합니다.

필수 옵션

getCloudMssqlInstanceList의 필수 옵션입니다.

옵션 타입 필수 여부 설명
--pageSize Integer Conditional 페이지당 항목 수
  • pageNo 입력 시 필수 입력

선택 옵션

getCloudMssqlInstanceList의 선택 옵션입니다. 지정하지 않은 옵션에는 기본값이 적용됩니다.

옵션 타입 필수 여부 설명
--zoneCode String Optional 존 코드
--vpcNo String Optional VPC 번호
--subnetNo String Optional Subnet 번호
--cloudMssqlServiceName String Optional Cloud DB for MSSQL 서비스 이름
--cloudMssqlInstanceNoList List Optional Cloud DB for MSSQL 인스턴스 번호 목록
  • 공백으로 구분하여 여러 개 입력 가능 (예시: --cloudMssqlInstanceNoList 1234 2345)
--cloudMssqlServerName String Optional Cloud DB for MSSQL 서버 이름
--cloudMssqlServerInstanceNoList List Optional Cloud DB for MSSQL 서버 인스턴스 번호 목록
  • 공백으로 구분하여 여러 개 입력 가능 (예시: --cloudMssqlServerInstanceNoList 1234 2345)
--pageNo Integer Optional 페이지 번호
  • 0~N

공통 옵션

vmssql 명령에서 공통으로 사용하는 옵션에 대한 정보는 Cloud DB for MSSQL 옵션을 참조해 주십시오.

예시

Cloud DB for MSSQL 인스턴스 목록 조회 요청이 성공하면 각 인스턴스의 구성 정보와 상태가 반환됩니다.

명령

명령 예시는 다음과 같습니다.

./ncloud vmssql getCloudMssqlInstanceList \
    --zoneCode FKR-1 \
    --vpcNo 12345678 \
    --subnetNo 23456789 \
    --cloudMssqlServiceName test-mssql-01 \
    --cloudMssqlInstanceNoList 141402185 \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode FKR \
    --output json

출력

출력 예시는 다음과 같습니다.

{
  "getCloudMssqlInstanceListResponse": {
    "totalRows": 1,
    "cloudMssqlInstanceList": [
      {
        "cloudMssqlInstanceNo": "141402185",
        "cloudMssqlServiceName": "test-mssql-01",
        "cloudMssqlInstanceStatusName": "running",
        "cloudMssqlInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created 상태"
        },
        "cloudMssqlInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "generationCode": "G2",
        "cloudMssqlServerInstanceList": [
          {
            "cloudMssqlServerInstanceNo": "141402194",
            "cloudMssqlServerName": "m-141402185-001",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296
          },
          {
            "cloudMssqlServerInstanceNo": "141402197",
            "cloudMssqlServerName": "m-141402185-002",
            "cloudMssqlServerInstanceStatusName": "running",
            "cloudMssqlServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
            },
            "cloudMssqlServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
            },
            "vpcNo": "12345678",
            "subnetNo": "23456789",
            "dataStorageSize": 107374182400,
            "cpuCount": 2,
            "memorySize": 4294967296
          }
        ]
      }
    ],
    "requestId": "3df5e096-c1d0-43f0-87b2-0433ae175cdb",
    "returnCode": "0",
    "returnMessage": "success"
  }
}