Documentation Index

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

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

getCloudMssqlConfigGroupList

Prev Next

VPC環境で利用できます。

Cloud DB for MSSQLで使用可能な Config Groupリストを照会します。

構文

getCloudMssqlConfigGroupList構文は次の通りです。

./ncloud vmssql getCloudMssqlConfigGroupList \
    [--configGroupNo <config-group-no>] \
    [--configGroupName <config-group-name>] \
    [--cloudMssqlInstanceNo <instance-no>] \
    [--cloudMssqlServiceName <service-name>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

getCloudMssqlConfigGroupListの実行時に指定できるオプションについて説明します。

任意オプション

getCloudMssqlConfigGroupListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--configGroupNo String Optional Cloud DB for MSSQL Config Group番号
--configGroupName String Optional Cloud DB for MSSQL Config Group名
--cloudMssqlInstanceNo String Optional Cloud DB for MSSQLインスタンス番号
--cloudMssqlServiceName String Optional Cloud DB for MSSQLのサービス名

共通オプション

vmssqlコマンドで共通して使用するオプションについては、Cloud DB for MSSQL (VPC)のオプションを参照してください。

Cloud DB for MSSQL Config Groupリストの照会リクエストが成功すると、使用可能な Config Groupの構成情報と状態が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vmssql getCloudMssqlConfigGroupList \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "getCloudMssqlConfigGroupListResponse": {
    "totalRows": 1,
    "cloudMssqlConfigGroupList": [
      {
        "configGroupNo": "0",
        "configGroupName": "mssql_2019_default",
        "configGroupType": {
          "code": "SYSTEM",
          "codeName": "Config Groupタイプコード-CLOUD DATABASE(VPC)"
        },
        "configGroupStatusName": "running",
        "configGroupStatus": {
          "code": "RUN",
          "codeName": "CONFIG GROUP Running状態"
        },
        "createDate": "2026-02-12T18:09:13+0900",
        "modifyDate": "2026-02-12T18:09:13+0900",
        "cloudMssqlInstanceNoList": [
          "25280088"
        ]
      }
    ],
    "requestId": "f6a7b8c9-d0e1-2345-fabc-678901234567",
    "returnCode": "0",
    "returnMessage": "success"
  }
}