Available in VPC
Get the authentication key used when accessing the manager node of the search engine cluster via SSH.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /api/v2/cluster/getLoginKeyList (Korea Region) |
GET | /api/sgn-v2/cluster/getLoginKeyList (Singapore Region) |
GET | /api/jpn-v2/cluster/getLoginKeyList (Japan Region) |
Request headers
For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.
Request example
The request example is as follows:
curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getLoginKeyList' \
--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 |
---|---|---|---|
code |
Integer | - | Response code |
message |
String | - | Response message |
result |
Object | - | Response result |
result.loginKeyList |
Array | - | List of authentication keys |
result.totalRows |
Integer | - | Number of response results |
requestId |
String | - | ID for the request
|
result.loginKeyList
The following describes result.loginKeyList
.
Field | Type | Required | Description |
---|---|---|---|
keyName |
String | - | Authentication key name |
Response status codes
For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.
Response example
The response example is as follows:
{
"code": 0,
"message": "SUCCESS",
"result": {
"loginKeyList": [
{
"keyName": "a123"
},
{
"keyName": "apitest"
},
...
],
"totalRows": 9
},
"requestId": "ffb5a6ea-****-****-****-dac08ec62e2b"
}