testConnectExternalHiveMetaStore

Prev Next

VPC環境で利用できます。

Cloud DB for MySQLと Cloud Hadoop Hiveメタストアは連携可能か確認します。

参考

testConnectExternalHiveMetaStore APIを呼び出す際は、下記をご参照ください。

  • クラスタごとに USER_ID + HOST(IPアドレス)単位でアカウント1個のみ連携可能
  • クラスタと MySQLは同じ VPCに位置している必要があり、MySQL 8.0.xバージョンのみサポート
  • メタストア連携アカウントに DDL権限が必要
  • Cloud DB for MySQL ACGに Cloud Hadoop ACGを追加する事前作業の先行作業が必要
  • 連携テスト時、hive_*_CHadoop形式のデータベースを作成

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
cloudHadoopInstanceNo String Required クラスタインスタンス番号
cloudMysqlInstanceNo String Required Cloud DB for MySQLインスタンス番号
cloudMysqlUserName String Required データベースユーザー ID
cloudMysqlUserPassword String Required データベースユーザーアカウントのパスワード
  • 英数字、記号を組み合わせて8~20文字以内で入力
  • 使用できない記号: '、"、`、&、+、/、\、スペース
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "testConnectExternalHiveMetaStoreResponse": {
        "requestId": "668a5ab5-****-****-****-625948079674",
        "returnCode": "0",
        "returnMessage": "success"
    }
}