getCloudHadoopLoginKeyList

Prev Next

VPC環境で利用できます。

SSH接続に使用される認証キーを照会します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "getCloudHadoopLoginKeyListResponse": {
        "totalRows": 4,
        "cloudHadoopLoginKeyList": [
            {
                "keyName": "auth"
            },
            {
                "keyName": "auth2"
            },
            {
                "keyName": "test"
            },
            {
                "keyName": "test1-230803"
            }
        ],
        "requestId": "c8d70b62-****-****-****-a957648cff0e",
        "returnCode": "0",
        "returnMessage": "success"
    }
}