get-ssl-vpn-account-list

Prev Next

VPC環境で利用できます。

Data Boxに登録されている SSL VPNアカウントリストを照会します。

リクエスト

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

メソッド URI
GET /api/v1/export/get-ssl-vpn-account-list

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
dataBoxFrameNo Integer Required Data Box Frame番号
dataBoxNo Integer Required Data Box番号

リクエスト例

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

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/export/get-ssl-vpn-account-list?dataBoxFrameNo=83&dataBoxNo=381' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
content Array - SSL VPNアカウントリスト

content

contentの説明は次の通りです。

フィールド タイプ 必須の有無 説明
sslVpnNo String - SSL VPN ID番号
vpnId String - VPN ID
email String - VPN IDに登録されたメールアドレス
  • マスキング処理されて表示
countryCode String - 国コード
phoneNumber String - VPN IDに登録されている電話番号
  • マスキング処理されて表示

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

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

レスポンス例

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

{
    "content": [
        {
            "sslVpnNo": "776",
            "vpnId": "**********",
            "email": "n*******@navercorp.com",
            "countryCode": "82",
            "phoneNumber": "01040*******"
        }
    ]
}