getCloudMssqlConfigGroupList

Prev Next

Available in VPC

Views a list of available Cloud DB for MSSQL Config Group

Commands

The text of the command is as follows:

ncloud vmssql getCloudMssqlConfigGroupList [regionCode] [configGroupNo] [configGroupName] [cloudMssqlInstanceNo] [cloudMssqlServiceName] [output]

Parameter

The following is a description on parameters.

Parameter Type Requirement status Description Restrictions
regionCode String N Region code
- regionCode can be obtained via the getRegionList action
- Default: selects the first region of the getRegionList search results
-
configGroupNo String N Cloud DB for MSSQL config group Number -
configGroupName String N Cloud DB for MSSQL config group name -
cloudMssqlInstanceNo String N Cloud DB for MSSQL instance number
- cloudMssqlInstanceNo can be obtained via the getCloudMssqlInstanceList action
-
cloudMssqlServiceName String N Cloud DB for MSSQL service name -
output String N Format type of the response result
- options: xml | json
- default: json
-

Responses

Response data type

  • CloudMssqlConfigGroupList type

    CloudMssqlConfigGroupList extends CommonResponse Description
    private Integer totalRows; Total number of items viewed
    private List<CloudMssqlConfigGroup> cloudMssqlConfigGroupList = new ArrayList<>(); Cloud DB for MSSQL config group list
  • CloudMssqlConfigGroup type

    CloudMssqlConfigGroup Description
    private String configGroupNo; Cloud DB for MSSQL config group Number
    private String configGroupName; Cloud DB for MSSQL config group name
    private String configGroupDescription; Cloud DB for MSSQL config group description
    private CommonCode configGroupType; Cloud DB for MSSQL config group type
    private String configGroupStatusName; Cloud DB for MSSQL config group status
    private CommonCode configGroupStatus; Cloud DB for MSSQL config group status name
    private Date createDate; Cloud DB for MSSQL config group creation date and time
    private Date modifyDate; Cloud DB for MSSQL config group last edit date and time
    private List<Integer> cloudMssqlInstanceNoList; Cloud DB for MSSQL Instance number list using Cloud DB for MSSQL config group

Examples

Describes examples of recalls and responses.

Recall examples

The following are examples of recalls.

ncloud vmssql getCloudMssqlConfigGroupList --regionCode KR --cloudMssqlInstanceNo ****590

Response examples

The following are examples of responses.

If the response shows that format type (output) is json

The following is when the response shows that format type (output) is json.

{
  "getCloudMssqlConfigGroupListResponse": {
    "requestId": "f8883b8a-d4b0-486d-8c6f-163a76c62209",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 2,
    "cloudMssqlConfigGroupList": [
      {
        "configGroupNo": "0",
        "configGroupName": "mssql_2019_default",
        "configGroupType": {
          "code": "SYSTEM",
          "codeName": "Config Group System Type"
        },
        "configGroupStatusName": "running",
        "configGroupStatus": {
          "code": "RUN",
          "codeName": "CONFIG GROUP Running State"
        },
        "createDate": "2018-02-10T17:03:55+0900",
        "modifyDate": "2018-02-10T17:03:55+0900",
        "cloudMssqlInstanceNoList": [
          1698967
        ]
      },
      {
        "configGroupNo": "**9",
        "configGroupName": "cfg-***-test",
        "configGroupDescription": "ConfigGroup Description",
        "configGroupType": {
          "code": "USER",
          "codeName": "Config Group User Type"
        },
        "configGroupStatusName": "running",
        "configGroupStatus": {
          "code": "RUN",
          "codeName": "CONFIG GROUP Running State"
        },
        "createDate": "2021-03-04T11:49:55+0900",
        "modifyDate": "2021-03-04T11:49:55+0900"
      }
    ]
  }
}

If the response shows that format type (responseFormatType) is xml

The following is when the response shows that format type (responseFormatType) is xml:

<getCloudMssqlConfigGroupListResponse>
    <requestId>f8883b8a-d4b0-486d-8c6f-163a76c62209</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <cloudMssqlConfigGroupList>
        <CloudMssqlConfigGroup>
            <configGroupNo>0</configGroupNo>
            <configGroupName>mssql_2019_default</configGroupName>
            <configGroupType>
                <code>SYSTEM</code>
                <codeName>Config Group System Type</codeName>
            </configGroupType>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <createDate>2018-02-10T17:03:55+0900</createDate>
            <modifyDate>2018-02-10T17:03:55+0900</modifyDate>
            <cloudMssqlInstanceNoList>
                <int>1698967</int>
            </cloudMssqlInstanceNoList>
        </CloudMssqlConfigGroup>
        <CloudMssqlConfigGroup>
            <configGroupNo>**9</configGroupNo>
            <configGroupName>cfg-***-test</configGroupName>
            <configGroupDescription>ConfigGroup Description</configGroupDescription>
            <configGroupType>
                <code>USER</code>
                <codeName>Config Group User Type</codeName>
            </configGroupType>
            <configGroupStatusName>running</configGroupStatusName>
            <configGroupStatus>
                <code>RUN</code>
                <codeName>CONFIG GROUP Running State</codeName>
            </configGroupStatus>
            <createDate>2021-03-04T11:49:55+0900</createDate>
            <modifyDate>2021-03-04T11:49:55+0900</modifyDate>
        </CloudMssqlConfigGroup>
    </cloudMssqlConfigGroupList>
</getCloudMssqlConfigGroupListResponse>