認証キーリストの照会

Prev Next

VPC環境で利用できます。

Search Engineクラスタのマネージャノードに SSH接続時に使用される認証キーを照会します。

リクエスト

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

メソッド URI
GET /api/v2/cluster/getLoginKeyList (韓国リージョン)
GET /api/sgn-v2/cluster/getLoginKeyList (シンガポールリージョン)
GET /api/jpn-v2/cluster/getLoginKeyList (日本リージョン)

リクエストヘッダ

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

リクエスト例

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

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}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.loginKeyList Array - 認証キーリスト
result.totalRows Integer - レスポンス結果数
requestId String - リクエスト ID
  • UUID形式

result.loginKeyList

result.loginKeyListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
keyName String - 認証キー名

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "loginKeyList": [
            {
                "keyName": "a123"
            },
            {
                "keyName": "apitest"
            },
            ...
        ],
        "totalRows": 9
    },
    "requestId": "ffb5a6ea-****-****-****-dac08ec62e2b"
}