getCloudHadoopTargetSubnetList

Prev Next

VPC環境で利用できます。

Cloud Hadoopで使用されている Subnetリストを照会します。

リクエスト

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

メソッド URI
GET | POST /vhadoop/v2/getCloudHadoopTargetSubnetList
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • 照会対象 Subnetのリージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
vpcNo String Required VPC番号で絞り込み
cloudHadoopImageProductCode String Required クラスタイメージコードで絞り込み
isPublic Boolean Optional Public Subnetかどうかで絞り込み
  • true | false
    • true: Public Subnet
    • false: Private Subnet
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vhadoop/v2/getCloudHadoopTargetSubnetList?regionCode=KR&vpcNo=*****&cloudHadoopImageProductCode=SW.VCHDP.LNX64.CNTOS.0708.HDP.21.B050&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}'

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
getCloudHadoopTargetSubnetListResponse Object - レスポンスの結果
getCloudHadoopTargetSubnetListResponse.requestId String - リクエスト ID
  • UUID形式
getCloudHadoopTargetSubnetListResponse.returnCode String - レスポンスコード
getCloudHadoopTargetSubnetListResponse.returnMessage String - レスポンスメッセージ

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

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

レスポンス例

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

{
    "getCloudHadoopTargetSubnetListResponse": {
        "totalRows": 2,
        "targetSubnetList": [
            {
                "subnetNo": "20****",
                "subnetName": "s1-hd-pri",
                "vpcNo": "9****",
                "vpcName": "vpc4hadoop",
                "zoneCode": "KR-2",
                "subnet": "**.**.**.**/**",
                "isPublic": false,
                "createdDate": "2025-02-18T11:23:41+0900"
            },
            {
                "subnetNo": "20****",
                "subnetName": "s1-hd-pub",
                "vpcNo": "9****",
                "vpcName": "vpc4hadoop",
                "zoneCode": "KR-2",
                "subnet": "**.**.**.**/**",
                "isPublic": true,
                "createdDate": "2025-02-18T11:23:22+0900"
            }
        ],
        "requestId": "26137f18-****-****-****-1311410848de",
        "returnCode": "0",
        "returnMessage": "success"
    }
}