すべてのプロダクト
Search

このプロダクト

    VPN Gateway:DescribeSslVpnServers

    ドキュメントセンター

    VPN Gateway:DescribeSslVpnServers

    最終更新日:Jun 25, 2026

    DescribeSslVpnServers 操作を呼び出して作成された SSL サーバーを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    vpc:DescribeSslVpnServers

    list

    SslVpnServer

    acs:vpc:{#regionId}:{#accountId}:sslvpnserver/*

    SslVpnServer

    acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    SSL サーバーのリージョン ID。

    DescribeRegions 操作を呼び出してリージョン ID をクエリできます。

    cn-hangzhou
    SslVpnServerId

    string

    任意

    SSL サーバーの ID。

    vss-bp15j3du13gq1dgey****
    VpnGatewayId

    string

    任意

    VPN ゲートウェイの ID。

    vpn-bp1on0xae9d771ggi****
    Name

    string

    任意

    SSL サーバーの名前。

    名前は 1～100 文字で、http:// または https:// で始めることはできません。

    test
    PageNumber

    integer

    任意

    ページ番号。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。

    10
    ResourceGroupId

    string

    任意

    SSL サーバーが属するリソースグループの ID。

    SSL サーバーは、関連付けられた VPN ゲートウェイインスタンスと同じリソースグループに属します。 DescribeVpnGateway 操作を呼び出して VPN ゲートウェイインスタンスのリソースグループ ID をクエリできます。

    rg-acfmzs372yg****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    PageSize

    integer

    ページングクエリにおける 1 ページあたりのエントリ数。

    10
    RequestId

    string

    リクエスト ID。

    D350187B-EA41-4577-950B-95434C8302E1
    PageNumber

    integer

    ページ番号。

    1
    TotalCount

    integer

    返されたエントリの総数。

    1
    SslVpnServers

    object

    SslVpnServer

    array<object>

    SSL サーバーの詳細。

    object

    InternetIp

    string

    VPN ゲートウェイのパブリック IP アドレスです。

    47.5.XX.XX
    IDaaSInstanceId

    string

    IDaaS EIAM インスタンスの ID です。

    idaas-cn-hangzhou-****
    CreateTime

    integer

    SSL-VPN サーバーが作成された際に生成されたタイムスタンプです。

    1613800884000
    VpnGatewayId

    string

    VPN ゲートウェイの ID です。

    vpn-bp1on0xae9d771ggi****
    IDaaSRegionId

    string

    IDaaS EIAM インスタンスのリージョン ID です。

    cn-hangzhou
    Compress

    boolean

    データ圧縮が有効かどうかを示します。有効な値は次のとおりです。

    • true

    • false（デフォルト）

    false
    Port

    integer

    SSL-VPN サーバーで使用されるポートです。

    1194
    LocalSubnet

    string

    ローカル CIDR ブロックです。

    192.168.0.0/24
    RegionId

    string

    SSL サーバーのリージョン ID です。

    cn-hangzhou
    Cipher

    string

    暗号化アルゴリズムです。

    AES-128-CBC
    Connections

    integer

    現在の接続数の合計です。

    0
    SslVpnServerId

    string

    SSL サーバーの ID です。

    vss-bp15j3du13gq1dgey****
    MaxConnections

    integer

    最大接続数です。

    5
    Name

    string

    SSL サーバーの名前です。

    test
    EnableMultiFactorAuth

    boolean

    二要素認証が有効かどうかを示します。

    • true

    • false（デフォルト）

    true
    ClientIpPool

    string

    クライアント CIDR ブロックです。

    10.10.1.0/24
    Proto

    string

    SSL サーバーで使用されるプロトコルです。

    UDP
    ResourceGroupId

    string

    SSL サーバーのリソースグループ ID です。

    ListResourceGroups 操作を呼び出して、リソースグループをクエリできます。

    rg-acfmzs372yg****
    IDaaSApplicationId

    string

    IDaaS アプリケーションの ID です。

    app_my6g4qmvnwxzj2f****
    IDaaSInstanceVersion

    string

    IDaaS EIAM インスタンスのバージョンです。

    • このパラメーターは、SSL サーバーが IDaaS EIAM 2.0 インスタンスに関連付けられている場合にのみ返されます。返される値は EIAM 2.0 のみです。

    • SSL サーバーが IDaaS EIAM 1.0 インスタンスに関連付けられている場合は、値は返されません。

    EIAM 2.0
    DnsServers

    string

    例

    成功レスポンス

    JSONJSON

    {
  "PageSize": 10,
  "RequestId": "D350187B-EA41-4577-950B-95434C8302E1",
  "PageNumber": 1,
  "TotalCount": 1,
  "SslVpnServers": {
    "SslVpnServer": [
      {
        "InternetIp": "47.5.XX.XX",
        "IDaaSInstanceId": "idaas-cn-hangzhou-****",
        "CreateTime": 1613800884000,
        "VpnGatewayId": "vpn-bp1on0xae9d771ggi****",
        "IDaaSRegionId": "cn-hangzhou",
        "Compress": false,
        "Port": 1194,
        "LocalSubnet": "192.168.0.0/24",
        "RegionId": "cn-hangzhou",
        "Cipher": "AES-128-CBC",
        "Connections": 0,
        "SslVpnServerId": "vss-bp15j3du13gq1dgey****",
        "MaxConnections": 5,
        "Name": "test",
        "EnableMultiFactorAuth": true,
        "ClientIpPool": "10.10.1.0/24",
        "Proto": "UDP",
        "ResourceGroupId": "rg-acfmzs372yg****",
        "IDaaSApplicationId": "app_my6g4qmvnwxzj2f****",
        "IDaaSInstanceVersion": "EIAM 2.0",
        "DnsServers": ""
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user.
    403 Forbidden User not authorized to operate on the specified resource.
    404 InvalidRegionId.NotFound The specified region is not found during access authentication.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。