edit-icon download-icon

DescribeSslVpnServers

最終更新日: May 05, 2018

説明

SSL-VPN サーバーのリストを照会します。

リクエストパラメーター

名前必須かどうか説明
ActionStringはい

実行するアクション。

有効値:DescribeSslVpnServers

RegionIdStringはい

SSL-VPN サーバーのリージョン。

リージョン ID を取得するには、DescribeRegions API を呼び出します。

VpnGatewayIdStringいいえVPN Gateway の ID。
SslVpnServerIdStringいいえSSL-VPN サーバーの ID。
NameStringいいえSSL-VPN サーバーの名前。
PageNumberIntegerいいえ戻されるページ数。デフォルト値は 1 です。
PageSizeIntegerいいえ1 ページあたりの行数。最大値は 50、デフォルト値は 10 です。

レスポンスパラメーター

名前説明
SslVpnServersJSON StringSSL-VPN サーバーのリスト。
TotalCountInteger照会されたエントリの数。
PageNumberInteger現在のページ数。
PageSizeInteger現在のページのエントリ数。
SslVpnServers オブジェクト
名前説明
RegionIdStringSSL-VPN サーバーのリージョン。
SslVpnServerIdStringSSL-VPN サーバーの ID。
VpnGatewayIdStringVPN Gateway インスタンスの ID。
NameStringSSL-VPN サーバーの名前。
ClientIpPoolLongクライアントの IP アドレスプール。
LocalSubnetLongVPN Gateway の有効期限。
ProtoStringSSL-VPN サーバーによって使用されるプロトコル。
PortIntegerSSL-VPN サーバーによって使用されるポート。
CipherString使用された暗号化アルゴリズム。
CompressBoolean圧縮するかどうか。
CreateTimeString作成時間。
ConnectionsInteger現在のコネクションの数。
MaxConnectionsIntegerコネクションの最大数。
InternetIpStringパブリック IP。

エラーコード

VPC API Error Center」をご参照ください。

リクエストの例

  1. https://vpc.aliyuncs.com/?Action=DescribeSslVpnServers
  2. &RegionID=cn-beijing
  3. &VpnGatewayId=vpn-bp1q8bgx4xnkm2ogj0fiu
  4. &<CommonParameters>

レスポンスの例

XML 形式

  1. <DescribeSslVpnServersResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>1</TotalCount>
  4. <PageSize>10</PageSize>
  5. <SslVpnServers>
  6. <SslVpnServer>
  7. <RegionId>cn-hanghzou</RegionId>
  8. <SslVpnServerId>vss-bp18q7hzj6largv4vk2fe</SslVpnServerId>
  9. <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj0fiu</VpnGatewayId>
  10. <Name>test</Name>
  11. <CLientIpPool>10.10.10.20/24</CLientIpPool>
  12. <LocalSubnet>10.10.10.10/24</LocalSubnet>
  13. <Proto>UDP</Proto>
  14. <Port>1194</Port>
  15. <Cipher>AES-128-CBC</Cipher>
  16. <Compress>true</Compress>
  17. <CreateTime>1492753580000</CreateTime>
  18. <Connections>0</Connections>
  19. <MaxConnections>5</MaxConnections>
  20. <InternetIp>47.98.xx.xx</InternetIp>
  21. </SslVpnServer>
  22. </SslVpnServers>
  23. <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
  24. </DescribeSslVpnServersResponse>

JSON 形式

  1. {
  2. "PageNumber": "1",
  3. "TotalCount": "1",
  4. "PageSize": "10",
  5. "SslVpnServers": {
  6. "SslVpnServer": {
  7. "RegionId": "cn-hanghzou",
  8. "SslVpnServerId": "vss-bp18q7hzj6largv4vk2fe",
  9. "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj0fiu",
  10. "Name": "test",
  11. "CLientIpPool": "10.10.10.20/24",
  12. "LocalSubnet": "10.10.10.10/24",
  13. "Proto": "UDP",
  14. "Port": "1194",
  15. "Cipher": "AES-128-CBC",
  16. "Compress": "true",
  17. "CreateTime": "1492753580000",
  18. "Connections": "0",
  19. "MaxConnections": "5",
  20. "InternetIp": "47.98.xx.xx"
  21. }
  22. },
  23. "RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65"
  24. }