この操作では、Smart Access Gateway (SAG) デバイスのLANポート設定を照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
アクション String 任意 DescribeSagLanList

実行する操作です。

値をDescribeSagLanListに設定します。

RegionId String 必須 cn-shanghai

SAGインスタンスがデプロイされているリージョンのID。
SmartAGId String 必須 sag-whfn****

SAGインスタンスのID。
SmartAGSn String 必須 sag32a30****

SAGインスタンスに関連付けられているSAGデバイスのシリアル番号。

レスポンスパラメーター

パラメーター データ型 例 説明
ラン 配列

LANポートの情報リスト。
EndIp String 192.XX.XX.254

Dynamic Host Configuration Protocol (DHCP) プールの最後のIPアドレス。
IP String 192.XX.XX.1

LANポートのIPアドレス。
IPType String DHCP

LANポートの接続タイプ。

DHCP: 動的IPアドレス。 DHCPを使用して、接続されたデバイスにIPアドレスを動的に割り当てます。

STATIC: 静的IPアドレス。 LANポートの静的IPアドレスを指定します。

リース String 7

DHCPを介して割り当てられた後、IPアドレスが保持される期間。 単位: 分。
マスク String 255.255.255.0

LANポートIPアドレスのサブネットマスク。
ポート名 String 0

LANポートの名前。
StartIp String 192.XX.XX.2

DHCPプールの最初のIPアドレス。
RequestId String 1120228A-E5E1-4E9C-B56D-96887E1A2B2F

リクエストの ID です。
タスクステータス 配列

クエリタスクの状態。
CreateTime String 1586852928000

クエリタスクが作成された時刻。
ErrorCode String 200

エラーコードを示します。 200は、クエリタスクが成功したことを示します。
ErrorMessage String Successful

エラーメッセージを示します。 成功は、クエリタスクが成功したことを示します。
ステータス String Succeed

非同期タスクのステータス。 設定可能な値は以下のとおりです。

  • Initialized: クエリタスクは初期化されます。
  • オフライン: SAGデバイスがAlibaba Cloudから切断され、Alibaba CloudはSAGデバイスにクエリタスクを割り当てていません。 SAGデバイスがAlibaba Cloudに接続されている場合、Alibaba Cloudは引き続きクエリタスクをSAGデバイスに割り当てます。
  • 成功: Alibaba CloudがクエリタスクをSAGデバイスに割り当てました。
  • 処理: Alibaba CloudはクエリタスクをSAGデバイスに割り当てています。
  • VersionNotSupport: 現在のバージョンのSAGデバイスではサポートされていません。
  • BuildRequestError: クラウドのコントロールおよび管理センターではサポートされていません。
  • HardwareError: SAGデバイスに障害があるため、Alibaba CloudはSAGデバイスへのクエリタスクの割り当てに失敗しました。
  • TaskNotExist: クエリタスクは存在しません。
  • OfflineNotConfiged: SAGデバイスがAlibaba Cloudから切断され、Alibaba CloudがSAGデバイスにクエリタスクを割り当てていません。 SAGデバイスがAlibaba Cloudに接続されている場合、Alibaba CloudはクエリタスクをSAGデバイスに割り当てません。

例

リクエストの例

4http(s)://[Endpoint]/? アクション=DescribeSagLanList
&RegionId=cn-上海
&SmartAGId=sag-whfn ****
&SmartAGSn=sag32a30 ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<DescribeSagLanListResponse>
  <RequestId>ADDEF8CA-D96F-4002-812A-36FDF4114135</RequestId>
  <タスクステータス>
        <State> 成功 </State>
        <CreateTime>1586869664000</CreateTime>
        <ErrorCode>200</ErrorCode>
        <エラーメッセージ> 成功。 </ErrorMessage>
  </TaskStates>
  <ラン>
        <IPType>STATIC</IPType>
        <IP>192.XX. XX.1</IP>
        <マスク> 255.255.255.0</マスク>
        <PortName>0</PortName>
  </Lans>
  <ラン>
        <IPType>STATIC</IPType>
        <IP>172.XX. XX.10</IP>
        <マスク> 255.255.255.0</マスク>
        <PortName>4</PortName>
  </Lans>
</DescribeSagLanListResponse>

JSON 形式 

{
    "RequestId": "ADDEF8CA-D96F-4002-812A-36FDF4114135" 、
    "TaskStates": [
        {
            "状態": "成功" 、
            "CreateTime": 1586869664000、
            "ErrorCode": "200" 、
            "エラーメッセージ": "成功"
        }
    ],
    "Lans": [
        {
            "IPType": "STATIC" 、
            "IP": "192.XX. XX.1" 、
            "マスク": "255.255.255.0" 、
            "PortName": "0"
        },
        {
            "IPType": "STATIC" 、
            "IP": "172.XX. XX.10" 、
            "マスク": "255.255.255.0" 、
            "PortName": "4"
        }
    ]
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 SAG.InstanceNoFound 指定されたSAGインスタンスは存在しません。 指定されたSAGインスタンスは存在しません。
400 SAG.SoftwareNotSupport 指定されたSAGソフトウェアエディションインスタンスはACLをサポートしていません。 SAG APPインスタンスは、アクセス制御リスト (ACL) をサポートしていません。
500 SmartAccessGatewayInArrears 指定されたSmart Access Gatewayの有効期限が切れています。 指定されたSAGインスタンスの有効期限が切れ、実行が停止しました。 SAGインスタンスを更新します。
500 SmartAccessGatewayNotActivated 指定されたSmart Access Gatewayは有効化されていません。 指定されたSAGインスタンスは有効化されていません。 SAGインスタンスをアクティブ化します。
403 SmartAccessGatewayNotOnline 指定されたスマートアクセスゲートウェイがオンラインではありません。 指定されたSAGデバイスがAlibaba Cloudに接続されていないため、システムはリクエストの処理に失敗しました。
500 SmartAccessGatewayOffline リクエストを完了できません。 Smart Access Gatewayはオフラインです。 指定されたSAGデバイスがAlibaba Cloudに接続されていないため、システムはリクエストの処理に失敗しました。
400 InstanceNotExit 指定されたインスタンスは存在しません。 指定されたSAGインスタンスは存在しません。
400 ConfigUnsynchronized ネットワーク設定が同期されていません。 ネットワーク設定が同期されていません。
403 FeatureNotSupport スマートアクセスゲートウェイの現在のエディションは、この機能をサポートしていません。 現在のバージョンのSAGデバイスはこの機能をサポートしていません。
403 FeatureNotSupportForActiveSmartAG アクティブなスマートアクセスゲートウェイの現在のエディションは、この機能をサポートしていません。 現在のバージョンのアクティブSAGデバイスは、この機能をサポートしていません。
403 FeatureNotSupportForStandBySmartAG スタンバイスマートアクセスゲートウェイの現在のエディションは、この機能をサポートしていません。 スタンバイSAGデバイスの現在のバージョンは、この機能をサポートしていません。

エラーコードリストについては、「API エラーセンター」をご参照ください。