Smart Access Gateway (SAG) デバイスに関するリモートログオン情報を照会します。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 任意 DescribeSagRemoteAccess

実行する操作です。

値をDescribeSagRemoteAccessに設定します。

RegionId String 必須 cn-shanghai

SAGインスタンスがデプロイされているリージョンのID。

SerialNumber String 必須 sage62x022502****

SAGデバイスのシリアル番号。

SmartAGId String 必須 sag-1um5x5nwhilymw****

SAGインスタンスのID。

レスポンスパラメーター

パラメーター データ型 説明
Code String 200

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

Message String successful

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

RemoteAccess RemoteAccessの配列

SAGデバイスに関するリモートログイン情報。

RemoteAccess
RemoteAccessIp String 192.XX.XX.1

リモートログインが開始されるプライベートIPアドレス。

SerialNumber String sage62x022502****

SAGデバイスのシリアル番号。

RequestId String E38E950D-28A4-4C41-9428-A8908EC6AE5C

リクエストの ID です。

SmartAGId String sag-1um5x5nwhilymw****

SAGインスタンスのID。

Success Boolean true

クエリタスクが成功したかどうかを示します。 設定可能な値は以下のとおりです。

  • true: クエリタスクは成功です。
  • false: クエリタスクが失敗しました。

リクエストの例

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

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

XML 形式

<DescribeSagRemoteAccessResponse>
  <SmartAGId>sag-kxe2cv7hot7qrv ****</SmartAGId>
  <RemoteAccess>
        <RemoteAccess>
              <RemoteAccessIp></RemoteAccessIp>
              <SerialNumber>sage62x022502 ****</SerialNumber>
        </RemoteAccess>
  </RemoteAccess>
  <Message> successful </ Message>
  <RequestId>2E2A56D0-D2BD-4D0B-9314-D355A5C67EBA</RequestId>
  <Success>true</Success>
  <Code>200</Code>
</DescribeSagRemoteAccessResponse>

JSON 形式

{
"SmartAGId": "sag-kxe2cv7hot7qrv ****" 、"RemoteAccesses": {
"RemoteAccess": [
{
"RemoteAccessIp": "" 、"SerialNumber": "sage62x022502 ****"
}
]
},
"メッセージ": "成功" 、"RequestId": "2E2A56D0-D2BD-4D0B-9314-D355A5C67EBA" 、"成功": true、"コード": "200"
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 InstanceNotExit 指定されたインスタンスは存在しません。 指定されたSAGインスタンスが存在しない場合に返されるエラーメッセージ。
400 InvalidId.SN 指定されたスマートアクセスゲートウェイのシリアル番号は存在しません。 指定されたシリアル番号が存在しない場合に返されるエラーメッセージ。
500 InternalError リクエストの処理中にエラーが発生しました。 不明なエラーが発生した場合に返されるエラーメッセージ。

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