getCloudMssqlTargetSubnetList

Prev Next

VPC環境で利用できます。

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

リクエスト

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

メソッド URI
GET, POST /getCloudMssqlTargetSubnetList

リクエストヘッダ

Cloud DB for MSSQL (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MSSQL (VPC)のリクエストヘッダをご参照ください。

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の Subnetのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
vpcNo String Required VPC番号でフィルタリング
cloudMssqlImageProductCode String Required Cloud DB for MSSQLイメージ商品コードでフィルタリング
isPublic Boolean Optional Public Subnetかどうかでフィルタリング
  • true (デフォルト) | false
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlTargetSubnetList
?regionCode=KR
&vpcNo=59***
&cloudMssqlImageProductCode=SW.VMSSL.OS.WND64.WINNT.SVR2016.MSSQL.15043261.EE.B100
&isPublic=true
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

レスポンスボディの詳細は、TargetSubnetListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

  • responseFormetType=jsonの場合

    {
        "getCloudMssqlTargetSubnetListResponse": {
            "totalRows": 3,
            "targetSubnetList": [
                {
                    "subnetNo": "140***",
                    "subnetName": "subnet",
                    "vpcNo": "59***",
                    "vpcName": "vpc",
                    "zoneCode": "KR-1",
                    "subnet": "10.0.252.0/25",
                    "isPublic": true,
                    "createdDate": "2024-03-29T11:20:34+0900"
                },
                {
                    "subnetNo": "139***",
                    "subnetName": "subnet",
                    "vpcNo": "59***",
                    "vpcName": "vpc",
                    "zoneCode": "KR-1",
                    "subnet": "10.0.0.0/17",
                    "isPublic": true,
                    "createdDate": "2024-03-28T14:38:54+0900"
                },
                {
                    "subnetNo": "158***",
                    "subnetName": "subnet",
                    "vpcNo": "59***",
                    "vpcName": "vpc",
                    "zoneCode": "KR-2",
                    "subnet": "10.0.255.0/25",
                    "isPublic": true,
                    "createdDate": "2024-07-01T11:50:09+0900"
                }
            ],
            "requestId": "eee062fb-****-****-****-cd8649151fef",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormetType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMssqlTargetSubnetListResponse>
        <requestId>eee062fb-****-****-****-cd8649151fef</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>3</totalRows>
        <targetSubnetList>
            <targetSubnet>
                <subnetNo>140***</subnetNo>
                <subnetName>subnet</subnetName>
                <vpcNo>59***</vpcNo>
                <vpcName>vpc</vpcName>
                <zoneCode>KR-1</zoneCode>
                <subnet>10.0.252.0/25</subnet>
                <isPublic>true</isPublic>
                <createdDate>2024-03-29T11:20:34+0900</createdDate>
            </targetSubnet>
            <targetSubnet>
                <subnetNo>139***</subnetNo>
                <subnetName>subnet</subnetName>
                <vpcNo>59***</vpcNo>
                <vpcName>vpc</vpcName>
                <zoneCode>KR-1</zoneCode>
                <subnet>10.0.0.0/17</subnet>
                <isPublic>true</isPublic>
                <createdDate>2024-03-28T14:38:54+0900</createdDate>
            </targetSubnet>
            <targetSubnet>
                <subnetNo>158***</subnetNo>
                <subnetName>subnet3</subnetName>
                <vpcNo>59***</vpcNo>
                <vpcName>vpc</vpcName>
                <zoneCode>KR-2</zoneCode>
                <subnet>10.0.255.0/25</subnet>
                <isPublic>true</isPublic>
                <createdDate>2024-07-01T11:50:09+0900</createdDate>
            </targetSubnet>
        </targetSubnetList>
    </getCloudMssqlTargetSubnetListResponse>