Available in VPC
Get the list of admin passwords using the authentication key of a server instance (VM).
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | POST | /vserver/v2/getRootPasswordServerInstanceList |
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 Server APIs, see Server request headers.
Request query parameters
You can use the following query parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
regionCode |
String | Optional | Region code
|
rootPasswordServerInstanceList.N.serverInstanceNo |
String | Required | Server instance number
|
rootPasswordServerInstanceList.N.privateKey |
String | Required | Authentication key (private key)
|
responseFormatType |
String | Optional | Format of the response data
|
Request example
The request example is as follows:
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}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
getRootPasswordServerInstanceListResponse |
Object | - | Response result |
getRootPasswordServerInstanceListResponse.requestId |
String | - | ID for the request
|
getRootPasswordServerInstanceListResponse.returnCode |
String | - | Response code |
getRootPasswordServerInstanceListResponse.returnMessage |
String | - | Response message |
Response status codes
For information about the response status codes common to all Server APIs, see Server response status codes.
Response example
The response example is as follows:
{
"getRootPasswordServerInstanceListResponse": {
"totalRows": 1,
"rootPasswordServerInstanceList": [
{
"serverInstanceNo": "*****8773",
"rootPassword": "A9@8qc******"
}
],
"requestId": "47ec5027-acf5-4594-bdb7-6e340d80c520",
"returnCode": "0",
"returnMessage": "success"
}
}