getCloudHadoopMysqlInstanceList

Prev Next

Available in VPC

Get Cloud DB for MySQL that can be integrated with a Hive metastore.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET | POST /vhadoop/v2/getCloudHadoopMysqlInstanceList
Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Cloud Hadoop APIs, see Cloud Hadoop request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
regionCode String Optional Region code
cloudHadoopInstanceNo String Required Cluster instance number
responseFormatType String Optional Format of the response data
  • xml (default) | json

Request example

The request example is as follows:

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}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
CloudMysqlInstanceListForHiveMetaStoreResponse Object - Response result
CloudMysqlInstanceListForHiveMetaStoreResponse.totalRows Integer - Number of response results
CloudMysqlInstanceListForHiveMetaStoreResponse.CloudMysqlInstanceListForHiveMetaStore Array - Cloud DB for MySQL information
CloudMysqlInstanceListForHiveMetaStoreResponse.requestId String - ID for the request
  • UUID format
CloudMysqlInstanceListForHiveMetaStoreResponse.returnCode String - Response code
CloudMysqlInstanceListForHiveMetaStoreResponse.returnMessage String - Response message

CloudMysqlInstanceListForHiveMetaStore

The following describes CloudMysqlInstanceListForHiveMetaStore.

Field Type Required Description
cloudMysqlInstanceNo String - Cloud DB for MySQL instance number
cloudMysqlInstanceName String - Cloud DB for MySQL instance name
vpcName String - VPC name

Response status codes

For response status codes common to all Cloud Hadoop APIs, see Cloud Hadoop response status codes.

Response example

The response example is as follows:

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