getRootPasswordServerInstanceList

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET \| POST	/vserver/v2/getRootPasswordServerInstanceList

参考

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getRootPasswordServerInstanceList
?regionCode=KR
&rootPasswordServerInstanceList.1.serverInstanceNo=***8773
&rootPasswordServerInstanceList.1.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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "getRootPasswordServerInstanceListResponse": {
        "totalRows": 1,
        "rootPasswordServerInstanceList": [
            {
                "serverInstanceNo": "*****8773",
                "rootPassword": "A9@8qc******"
            }
        ],
        "requestId": "47ec5027-acf5-4594-bdb7-6e340d80c520",
        "returnCode": "0",
        "returnMessage": "success"
    }
}