すべてのプロダクト
Search

このプロダクト

    Smart Access Gateway:DescribeSmartAccessGateways

    ドキュメントセンター

    Smart Access Gateway:DescribeSmartAccessGateways

    最終更新日:Dec 21, 2025

    Smart Access Gateway (SAG) インスタンスを照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    smartag:DescribeSmartAccessGateways

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

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

    cn-shanghai
    AssociatedCcnId

    string

    任意

    SAG インスタンスが関連付けられている CCN インスタンスの ID。

    ccn-bxuau4ezctt****
    SmartAGId

    string

    任意

    SAG インスタンスの ID。

    sag-6z21oj0vjjrx6s****
    Status

    string

    任意

    SAG インスタンスのステータス。有効な値：

    • Ordered：注文済みです。

    • Delivered：発送済みです。

    • Received：SAG デバイスを受領済みです。

    • Returning：注文は返品中です。

    • Active：SAG デバイスはアクティブです。

    • init：SAG デバイスは初期化中です。

    • Offline：SAG デバイスは切断されています。

    Active
    Name

    string

    任意

    SAG インスタンスの名前。

    名前は、長さが 2～128 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。先頭は文字である必要があります。

    nametest
    PageSize

    integer

    任意

    各ページに返すエントリ数。デフォルト値：10。有効な値：1～50。

    10
    PageNumber

    integer

    任意

    返すページ番号。デフォルト値：1。

    1
    SerialNumber

    string

    任意

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

    sag32a3****
    AclIds

    string

    任意

    SAG インスタンスが関連付けられている ACL の ID。

    acl-xhwhyuo43l0n****
    UnboundAclIds

    string

    任意

    ACL ルールの ID。

    ACL に関連付けられていない SAG インスタンスを照会することを指定します。複数の ACL ID はコンマ (,) で区切ります。

    acl-sjfbgngj****
    InstanceType

    string

    任意

    SAG インスタンスのタイプ。有効な値：

    • software：SAG アプリアンスタンス

    • hardware：SAG CPE インスタンス

    hardware
    CanAssociateQos

    boolean

    任意

    SAG インスタンスを QoS (Quality of Service) ポリシーに関連付けることができるかどうかを指定します。有効な値：

    • true：はい

    • false：いいえ

    QoS ポリシーに関連付けることができない SAG インスタンスを照会するかどうかを指定します。

    false
    HardwareType

    string

    任意

    SAG デバイスのモデル。有効な値：

    • sag-1000

    • sag-100wm

    sag-100wm
    SoftwareVersion

    string

    任意

    SAG デバイスのソフトウェアバージョン。

    2.3.0.0
    VersionComparator

    string

    任意

    バージョンフィルター。有効な値：

    • greater：現在のバージョンより後

    • less：現在のバージョンより前

    • equals：現在のバージョンと同じ

    equals
    BusinessState

    string

    任意

    SAG インスタンスのビジネスステータス。有効な値：

    • Normal：正常に実行されています。

    • Arrearage：支払い遅延のためロックされています。

    Normal
    ResourceGroupId

    string

    任意

    SAG インスタンスが属するリソースグループの ID。

    rg-acfm2iu4fnc****
    SmartAGIds

    array

    任意

    SAG インスタンスの ID。

    string

    任意

    SAG インスタンスの ID。

    sag-6z21oj0vjjrx6s****
    AssociatedCcnName

    string

    任意

    関連付けられている CCN インスタンスの名前。

    名前は、長さが 2～100 文字で、文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。先頭は文字である必要があります。

    ccn

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答。

    TotalCount

    integer

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

    1
    PageSize

    integer

    ページごとに返されるエントリ数。

    10
    RequestId

    string

    リクエスト ID。

    ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F
    PageNumber

    integer

    返されたページのページ番号。

    1
    SmartAccessGateways

    object

    SmartAccessGateway

    array<object>

    SAG インスタンスのリスト。

    array<object>

    SAG インスタンスに関する情報。

    SerialNumber

    string

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

    sage6gsdllbid****,sage6nniq3dqa****
    Status

    string

    SAG インスタンスのステータス。有効な値：

    • Ordered：注文済みです。

    • Delivered：発送済みです。

    • Received：SAG デバイスを受領済みです。

    • Returning：注文は返品中です。

    • Active：SAG デバイスはアクティブです。

    • init：SAG デバイスは初期化中です。

    • Offline：SAG デバイスは切断されています。

    Active
    UpBandwidth4G

    integer

    SAG デバイスによって確立された 4G ネットワーク接続の最大アップストリーム帯域幅。単位：Mbit/s。

    3
    BackupStatus

    string

    SAG バックアップデバイスのステータス。

    Active
    IdaasApplicationId

    string

    SAG インスタンスに関連付けられている Identity as a Service (IDaaS) アプリケーションの ID。

    idaas-cn-hangzhou-l7j0wf0crzea****
    SoftwareVersion

    string

    アクティブな SAG デバイスのソフトウェアバージョン。

    2.3.0.0
    CreateTime

    integer

    SAG インスタンスが作成されたときのタイムスタンプ。単位：ミリ秒。

    この値は、エポックタイム 1970年1月1日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。

    1622617250000
    SmartAGId

    string

    SAG インスタンスの ID。

    sag-6z21oj0vjjrx6s****
    UpBandwidthWan

    integer

    SAG デバイスの WAN ポートで確立されたネットワーク接続の最大アップストリーム帯域幅。単位：Mbit/s。

    2
    City

    string

    SAG デバイスがデプロイされている都市の ID。

    cn-shanghai
    AclIds

    string

    SAG インスタンスが関連付けられている ACL の ID。

    acl-shfhfhhfbnvkdg****
    QosIds

    string

    SAG インスタンスに関連付けられている QoS ポリシーの ID。

    qos-djh****
    IRIds

    string

    SAG インスタンスに関連付けられているインテリジェントルーティングポリシーの ID。

    ir-7unf5nom01ygrg****
    CidrBlock

    string

    オンプレミスネットワークまたはクライアントが通信する必要がある宛先ネットワークのプライベート CIDR ブロック。

    10.0.9.0/24
    Description

    string

    SAG インスタンスの説明。

    docdesc
    IpsecStatus

    string

    IPsec-VPN 接続のステータス。有効な値：

    • up：正常

    • down：異常

    up
    EnterpriseCode

    string

    SAG インスタンスに関連付けられているエンタープライズコードの ID。

    12P****
    DpiStatus

    string

    ディープパケットインスペクション (DPI) 機能のステータス。有効な値：

    • On：有効

    • Off：無効

    Off
    AssociatedCcnId

    string

    SAG インスタンスが関連付けられている CCN インスタンスの ID。

    ccn-iz26o9zye6lhoo****
    Name

    string

    SAG インスタンスの名前。

    testname
    HardwareVersion

    string

    SAG インスタンスのタイプ。有効な値：

    • sag-1000：SAG-1000 デバイスに関連付けられている SAG CPE インスタンス。

    • sag-100wm：SAG-100WM デバイスに関連付けられている SAG CPE インスタンス。

    • sag-software：SAG アプリアンスタンス。

    • sag-vcpe：SAG vCPE インスタンス。

    sag-100wm
    IdaasId

    string

    SAG インスタンスが関連付けられている IDaaS インスタンスの ID。

    idaas-cn-hangzhou-1ahixtl****
    DataPlan

    integer

    SAG インスタンスのデータ転送プラン。単位：GB。

    説明

    各クライアントアカウントには、月額 5 GB の無料データ転送クォータが割り当てられます。

    5
    AssociatedCcnName

    string

    SAG インスタンスに関連付けられている CCN インスタンスの名前。

    ccn
    ResellerUid

    string

    サードパーティリセラーの Alibaba Cloud アカウント ID。

    25346073170691****
    DpiMonitorStatus

    string

    DPI ベースのモニタリング機能のステータス。有効な値：

    • Active：有効

    • Inactive：無効

    Inactive
    MaxBandwidth

    string

    SAG インスタンスの最大帯域幅値。単位：Mbit/s。

    50M
    SmartAGUid

    integer

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

    1210123456123456
    BackupSoftwareVersion

    string

    スタンバイ SAG デバイスのソフトウェアバージョン。

    2.3.0.0
    EndTime

    integer

    SAG インスタンスの有効期限が切れるときのタイムスタンプ。単位：ミリ秒。

    この値は、エポックタイム 1970年1月1日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。

    1628265600000
    ResellerInstanceId

    string

    リセラーに属する SAG インスタンスの ID。

    sag-v0fkpk4akfz5****
    VpnStatus

    string

    VPN 接続のステータス。有効な値：

    • up：正常

    • down：異常

    down
    RoutingStrategy

    string

    SAG インスタンスが Alibaba Cloud にルートを公開するために使用するメソッド。

    • static：静的ルート

    • dynamic：動的ルート

    static
    SecurityLockThreshold

    integer

    時間のしきい値。SAG デバイスが指定された期間オフラインのままである場合、SAG デバイスはロックされます。

    単位：秒。

    3600

    object

    Type

    string

    ネットワーク接続のタイプ。有効な値：

    • ccn：オンプレミスネットワークは CCN を介して Alibaba Cloud に接続されます。

    • vbr：オンプレミスネットワークは、仮想ボーダールータ (VBR) と Express Connect 回線を介して Alibaba Cloud に接続されます。

    ccn
    Status

    string

    ネットワーク接続のステータス。

    有効な値：

    • Ordered：注文は発送待ちです。

    • Delivered：注文は発送済みです。

    • Offline：接続は切断されています。

    • Active：SAG デバイスは利用可能です。

    • Arrearage：支払い遅延のため SAG デバイスはロックされています。

    Express Connect 回線のステータス。有効な値：

    • normal：正常

    • arrears：支払い遅延

    Active
    EndTime

    integer

    接続の有効期限が切れるときのタイムスタンプ。単位：ミリ秒。

    この値は、エポックタイム 1970年1月1日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。

    1628265600000
    Bandwidth

    string

    接続の帯域幅値。単位：Mbit/s。

    50M
    RelateInstanceRegionId

    string

    接続が関連付けられているインスタンスのリージョン ID。

    cn-shanghai
    RelateInstanceId

    string

    接続に関連付けられているインスタンスの ID。

    ccn-iz26o9zye6lhoo****
    InstanceId

    string

    プロダクトインスタンスの ID。

    sag-6z21oj0vjjrx6s****
    CommodityType

    string

    プロダクトタイプ。有効な値：

    • bandwidth：SAG インスタンスと帯域幅リソースは個別に購入できます。

    • smartag：SAG インスタンスと帯域幅リソースはバンドルとして購入する必要があります。

    smartag
    ResourceGroupId

    string

    SAG インスタンスが属するリソースグループの ID。

    rg-acfm2iu4fnc****
    UserCount

    integer

    SAG インスタンスのクライアントアカウント数。

    3
    AccessPointId

    string

    SAG インスタンスのアクセスポイントの ID。

    238
    ApplicationBandwidthPackageId

    string

    SAG インスタンスに関連付けられているアプリケーションアクセラレーション用の帯域幅プランの ID。

    abwp-7963l7iqnquyj3****
    AccelerateBandwidth

    integer

    アプリケーションアクセラレーションの最大帯域幅値。単位：Mbit/s。

    1
    EnableSoftwareConnectionAudit

    boolean

    SAS アプリアンスタンスのネットワーク接続ログの監査が有効になっているかどうかを示します。有効な値：

    • true：有効

    • false：無効

    true
    Position

    string

    SAG インスタンスに関する位置情報。

    \[{\\"adcode\\":\\"\\",\\"label\\":\\"Jimo District, Qingdao, Shandong province\\",\\"value\\":\\"B02140800T\\",\\"center\\":\\"120.989576,36.487512\\",\\"\_new\\":\\"true\\"}]

    Isp

    string

    SAG インスタンスのインターネットサービスプロバイダー (ISP)。

    China Telecom

    EnableAdvancedMonitor

    boolean

    SAG インスタンスで DPI が有効になっているかどうかを示します。有効な値：

    • true：有効

    • false：無効

    true

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F",
  "PageNumber": 1,
  "SmartAccessGateways": {
    "SmartAccessGateway": [
      {
        "SerialNumber": "sage6gsdllbid****,sage6nniq3dqa****",
        "Status": "Active",
        "UpBandwidth4G": 3,
        "BackupStatus": "Active",
        "IdaasApplicationId": "idaas-cn-hangzhou-l7j0wf0crzea****",
        "SoftwareVersion": "2.3.0.0",
        "CreateTime": 1622617250000,
        "SmartAGId": "sag-6z21oj0vjjrx6s****",
        "UpBandwidthWan": 2,
        "City": "cn-shanghai",
        "AclIds": "acl-shfhfhhfbnvkdg****",
        "QosIds": "qos-djh****",
        "IRIds": "ir-7unf5nom01ygrg****",
        "CidrBlock": "10.0.9.0/24",
        "Description": "docdesc",
        "IpsecStatus": "up",
        "EnterpriseCode": "12P****",
        "DpiStatus": "Off",
        "AssociatedCcnId": "ccn-iz26o9zye6lhoo****",
        "Name": "testname",
        "HardwareVersion": "sag-100wm",
        "IdaasId": "idaas-cn-hangzhou-1ahixtl****",
        "DataPlan": 5,
        "AssociatedCcnName": "ccn",
        "ResellerUid": "25346073170691****",
        "DpiMonitorStatus": "Inactive",
        "MaxBandwidth": "50M",
        "SmartAGUid": 1210123456123456,
        "BackupSoftwareVersion": "2.3.0.0",
        "EndTime": 1628265600000,
        "ResellerInstanceId": "sag-v0fkpk4akfz5****",
        "VpnStatus": "down",
        "RoutingStrategy": "static",
        "SecurityLockThreshold": 3600,
        "Links": {
          "Link": [
            {
              "Type": "ccn",
              "Status": "Active",
              "EndTime": 1628265600000,
              "Bandwidth": "50M",
              "RelateInstanceRegionId": "cn-shanghai",
              "RelateInstanceId": "ccn-iz26o9zye6lhoo****",
              "InstanceId": "sag-6z21oj0vjjrx6s****",
              "CommodityType": "smartag"
            }
          ]
        },
        "ResourceGroupId": "rg-acfm2iu4fnc****",
        "UserCount": 3,
        "AccessPointId": "238",
        "ApplicationBandwidthPackageId": "abwp-7963l7iqnquyj3****",
        "AccelerateBandwidth": 1,
        "EnableSoftwareConnectionAudit": true,
        "Position": "\\[{\\\\\"adcode\\\\\":\\\\\"\\\\\",\\\\\"label\\\\\":\\\\\"Jimo District, Qingdao, Shandong province\\\\\",\\\\\"value\\\\\":\\\\\"B02140800T\\\\\",\\\\\"center\\\\\":\\\\\"120.989576,36.487512\\\\\",\\\\\"\\_new\\\\\":\\\\\"true\\\\\"}]\n",
        "Isp": "China Telecom\n",
        "EnableAdvancedMonitor": true
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Param.InvalidVersionComparator The specified version comparison operator is invalid.
    400 InvalidRegionID The specified regionId does not exist.
    403 Forbidden User not authorized to operate on the specified resource.

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

    変更履歴

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