getRootPassword

Prev Next

VPC環境で利用できます。

サーバインスタンス(VM)の認証キーを使用して管理者パスワードを照会します。

リクエスト

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

メソッド URI
GET | POST /vserver/v2/getRootPassword
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
serverInstanceNo String Required サーバインスタンス番号
privateKey String Required 認証キー(秘密鍵)
  • 作成するか、外部から取得した PEMファイルの内容を入力
  • 改行は\nを利用
  • GETメソッドで呼び出す場合、URLエンコードが必要
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getRootPassword
?regionCode=KR
&serverInstanceNo=***8773
&privateKey=-----BEGIN RSA PRIVATE KEY-----\n{Private Key}\n-----END RSA PRIVATE KEY-----\n
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "getRootPasswordResponse": {
        "rootPassword": "A9@8qc******",
        "requestId": "534a37d8-325b-4e93-b318-829326f3fe03",
        "returnCode": "0",
        "returnMessage": "success"
    }
}