getCloudHadoopMysqlInstanceList

Prev Next

VPC環境で利用できます。

Hiveメタストアと連携可能な Cloud DB for MySQLを照会します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
cloudHadoopInstanceNo String Required クラスタインスタンス番号
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
CloudMysqlInstanceListForHiveMetaStoreResponse Object - レスポンス結果
CloudMysqlInstanceListForHiveMetaStoreResponse.totalRows Integer - レスポンス結果数
CloudMysqlInstanceListForHiveMetaStoreResponse.CloudMysqlInstanceListForHiveMetaStore Array - Cloud DB for MySQL情報
CloudMysqlInstanceListForHiveMetaStoreResponse.requestId String - リクエスト ID
  • UUID形式
CloudMysqlInstanceListForHiveMetaStoreResponse.returnCode String - レスポンスコード
CloudMysqlInstanceListForHiveMetaStoreResponse.returnMessage String - レスポンスメッセージ

CloudMysqlInstanceListForHiveMetaStore

CloudMysqlInstanceListForHiveMetaStoreの説明は次の通りです。

フィールド タイプ 必須の有無 説明
cloudMysqlInstanceNo String - Cloud DB for MySQLのインスタンス番号
cloudMysqlInstanceName String - Cloud DB for MySQLのインスタンス名
vpcName String - VPC名

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

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

レスポンス例

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

{
    "CloudMysqlInstanceListForHiveMetaStoreResponse": {
        "totalRows": 1,
        "cloudMysqlInstanceListForHiveMetaStore": [
            {
                "cloudMysqlInstanceNo": "18*****",
                "cloudMysqlInstanceName": "test",
                "vpcName": "vpc4hadoop"
            }
        ],
        "requestId": "e149ea85-****-****-****-7e606f2058ef",
        "returnCode": "0",
        "returnMessage": "success"
    }
}