getCloudMssqlTargetVpcList

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET \| POST	/vmssql/v2/getCloudMssqlTargetVpcList

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	照会対象の VPCのリージョンコード getRegionListを参照 `getRegionList`照会結果の最初のリージョン(デフォルト)
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmssql/v2/getCloudMssqlTargetVpcList
?regionCode=KR
&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}'

レスポンス

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

レスポンスボディ

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

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

Cloud DB for MSSQL (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud DB for MSSQL (VPC)のレスポンスステータスコードをご参照ください。

レスポンス例

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

responseFormatType=jsonの場合

{
    "getCloudMssqlTargetVpcListResponse": {
        "totalRows": 2,
        "targetVpcList": [
            {
                "vpcNo": "69***",
                "vpcName": "vpc",
                "ipv4Cidr": "**.**.**.**/**",
                "regionCode": "KR",
                "createdDate": "2024-06-13T13:39:51+0900"
            },
            {
                "vpcNo": "59***",
                "vpcName": "vpc",
                "ipv4Cidr": "**.**.**.**/**",
                "regionCode": "KR",
                "createdDate": "2024-03-28T13:40:23+0900"
            }
        ],
        "requestId": "d980314e-****-****-****-f4bffdb87394",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

responseFormatType=xml(デフォルト)の場合

<?xml version="1.0" encoding="UTF-8"?>
<getCloudMssqlTargetVpcListResponse>
    <requestId>d980314e-****-****-****-f4bffdb87394</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>2</totalRows>
    <targetVpcList>
        <targetVpc>
            <vpcNo>69***</vpcNo>
            <vpcName>vpc</vpcName>
            <ipv4Cidr>**.**.**.**/**</ipv4Cidr>
            <regionCode>KR</regionCode>
            <createdDate>2024-06-13T13:39:51+0900</createdDate>
        </targetVpc>
        <targetVpc>
            <vpcNo>59***</vpcNo>
            <vpcName>vpc</vpcName>
            <ipv4Cidr>**.**.**.**/**</ipv4Cidr>
            <regionCode>KR</regionCode>
            <createdDate>2024-03-28T13:40:23+0900</createdDate>
        </targetVpc>
    </targetVpcList>
</getCloudMssqlTargetVpcListResponse>