MENU
      testConnectExternalHiveMetaStore

        testConnectExternalHiveMetaStore


        Article summary

        Available in VPC

        Check whether the Cloud Hadoop Hive metastore can be connected to the Cloud DB for MySQL (VPC) database created in a user account.

        Only 1 connected account per cluster can be added in the unit of USER_ID + HOST(IP).

        Connection is available only in MySQL version 5.7.x and the feature is supported only when Cloud DB for MySQL (VPC) is in operation.
        When performing the test connection feature, a database in the form of hive_*_CHadoop is created.
        The metastore connected account supports only the DDL permission.

        For preparations, ACGs used in Cloud Hadoop need to be added to Cloud DB for MySQL (VPC) ACG and all communications need to be allowed for valid connections.

        Requests

        Request Parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        regionCodeNoString- Region code
        - Able to determine a region to test whether the Hive metastore can be connected
        - The regionCode can be obtained by the getRegionList action.
        - Default: the first Region of the getRegionList search results is selected.
        cloudHadoopInstanceNoYesString- The instance number of Cloud Hadoop
        The cloudHadoopInstanceNo can be obtained by the getCloudHadoopInstanceList action.
        cloudMysqlInstanceNoYesString- The instance number of Cloud DB for MySQL (VPC) to test connection availability of the Hive metastore
        - The cloudMysqlInstanceNo can be obtained by the getCloudHadoopMysqlInstanceList action.
        cloudMysqlUserNameYesString- Access user name of Cloud DB for MySQL (VPC) to test connectivity to the Hive metastore
        - The cloudMysqlUserName can be obtained by the getCloudHadoopMysqlUserList action.
        cloudMysqlUserPasswordYesStringIt must have at least 1 of each of English letter, special character, and number.
        The following characters cannot be used in the password: ` & + \ " ' / space
        Min: 8
        Max: 20
        - Access user password of Cloud DB for MySQL (VPC) to test connectivity to the Hive metastore
        responseFormatTypeNoString- Format type of the response result
        - Options: xml | json
        - Default: xml

        Request bodies

        {
          "regionCode": "string",
          "cloudHadoopInstanceNo": "string",
          "cloudMysqlInstanceNo": "string",
          "cloudMysqlUserName": "string",
          "cloudMysqlUserPassword": "string",
          "responseFormatType": "string"
        }
        JSON

        Responses

        Response bodies

        {
          "testConnectExternalHiveMetaStoreResponse": {
            "requestId": "string",
            "returnCode": "string",
            "returnMessage": "string"
          }
        }
        JSON

        Errors

        See Cloud Hadoop(VPC) overview.

        Examples

        Request Examples

        GET {API_URL}/testConnectExternalHiveMetaStore
        ?regionCode=KR
        &cloudHadoopInstanceNo=821***
        &cloudMysqlInstanceNo=823***
        &cloudMysqlUserName=test**
        &cloudMysqlUserPassword=******
        HTTP

        Response examples

        {
          "testConnectExternalHiveMetaStoreResponse": {
            "requestId": "668a5ab5-ee01-4340-86ac-625948079674",
            "returnCode": "0",
            "returnMessage": "success"
          }
        }
        JSON
        <testConnectExternalHiveMetaStoreResponse>
            <requestId>65544ec3-8da6-4bf1-9b0c-5957d110bd42</requestId>
            <returnCode>0</returnCode>
            <returnMessage>success</returnMessage>
        </testConnectExternalHiveMetaStoreResponse>
        XML

        Error examples

        {
          "responseError": {
            "returnCode": "5001342",
            "returnMessage": "The access to the DB server from Cloud Hadoop is blocked. Modify the ACG settings of Cloud DB for MySQL."
          }
        }
        JSON
        {
          "responseError": {
            "returnCode": "5001343",
            "returnMessage": "The account or password was entered incorrectly. Enter the correct account and password."
          }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.