すべてのプロダクト
Search

このプロダクト

    Microservices Engine:ListGateway

    ドキュメントセンター

    Microservices Engine:ListGateway

    最終更新日:Apr 20, 2026

    ゲートウェイのリストを照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    mse:ListGateway

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    ページ番号。

    1
    PageSize

    integer

    任意

    1ページあたりのエントリ数。

    10
    OrderItem

    string

    任意

    ソート条件。

    {}
    DescSort

    boolean

    任意

    結果を降順でソートするかどうかを指定します。このパラメーターは現在利用されていません。

    false
    FilterParams

    object

    任意

    フィルターパラメーター。

    GatewayType

    string

    任意

    ゲートウェイタイプ。

    Ingress
    Name

    string

    任意

    ゲートウェイ名。

    rutain-test
    Vpc

    string

    任意

    VPC ID。

    vpc-bp13hhyjntbab7w****
    GatewayUniqueId

    string

    任意

    一意のゲートウェイ ID。

    gw-5017305290e14centbrveca****
    InstanceId

    string

    任意

    インスタンス ID。

    mse_ingresspre-cn-****
    MseTag

    string

    任意

    リソースタグ。

    [{"key":"tagkey","value":"tagvalue"}]
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-7y2uye*****
    AcceptLanguage

    string

    任意

    応答の言語。有効な値：

    • zh: 中国語

    • en: 英語

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    データ構造。

    RequestId

    string

    リクエスト ID。

    34300B3-52EC-5049-8C96-914098CF****
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Message

    string

    応答メッセージ。

    You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*
    Code

    integer

    応答コード。

    200
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    Data

    object

    応答データ。

    TotalSize

    integer

    エントリの総数。

    9
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    1ページあたりのエントリ数。

    10
    Result

    array<object>

    ゲートウェイのリスト。

    array<object>

    ゲートウェイの詳細。

    Id

    integer

    ゲートウェイ ID。

    153
    Name

    string

    ゲートウェイ名。

    tesa-test
    GatewayUniqueId

    string

    一意のゲートウェイ ID。

    gw-5017305290e14cebb8ce5cb6a4****
    GatewayType

    string

    ゲートウェイタイプ。

    Ingress
    Region

    string

    リージョン。

    cn-hangzhou
    PrimaryUser

    string

    Alibaba Cloud アカウントの ID。

    18278117654342
    Status

    integer

    ゲートウェイのステータス。有効な値：

    • 0: 作成中

    • 1: 作成失敗

    • 2: 実行中

    • 3: 変更中

    • 4: スケールイン中

    • 6: スケールアウト中

    • 8: 削除中

    • 9: 停止中

    • 10: 再起動中

    • 11: 再構築中

    • 12: アップグレード中

    • 13: アップグレード失敗

    2
    AhasOn

    boolean

    Application High Availability Service (AHAS) が有効になっているかどうかを示します。

    false
    ArmsOn

    boolean

    Application Real-Time Monitoring Service (ARMS) が有効になっているかどうかを示します。

    false
    Spec

    string

    仕様。

    MSE_GTW_1_2_200_c
    Replica

    integer

    レプリカ数。

    2
    GmtCreate

    string

    作成時刻。

    2021-09-13 19:24:23
    GmtModified

    string

    変更時刻。

    2021-09-13 19:24:23
    StatusDesc

    string

    ステータスの説明。

    重启中
    Slb

    array<object>

    関連付けられた SLB インスタンス。

    object

    SLB インスタンスの詳細。

    SlbIp

    string

    SLB インスタンスの IP アドレス。

    153.12.XX.XX
    SlbPort

    string

    SLB インスタンスのポート。

    80
    SlbSpec

    string

    SLB インスタンスの仕様。

    slb.s2.small
    Type

    string

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

    • PUB_NET：インターネット

    • PRIVATE_NET：VPC

    PUB_NET
    GatewaySlbStatus

    string

    関連付けられた SLB インスタンスのステータス。

    Ready
    StatusDesc

    string

    ステータスの説明。

    创建中
    GatewaySlbMode

    string

    関連付けられた SLB インスタンスのモード。

    UserHost
    SlbId

    string

    SLB インスタンスの ID。

    lb-bp1ut8asdfgucjk****
    InternetSlb

    array<object>

    インターネット向け SLB インスタンス。

    object

    インターネット向け SLB インスタンスの詳細。

    SlbIp

    string

    SLB インスタンスの IP アドレス。

    153.12.XX.XX
    SlbPort

    string

    SLB インスタンスのポート。

    slb.s2.small
    SlbSpec

    string

    SLB インスタンスの仕様。

    slb.s2.small
    Type

    string

    ネットワークタイプ。

    PUB_NET
    InternetNetworkFlow

    string

    パブリックネットワークトラフィック。

    20
    GatewaySlbStatus

    string

    関連付けられた SLB インスタンスのステータス。

    Ready
    StatusDesc

    string

    ステータスの説明。

    创建中
    GatewaySlbMode

    string

    関連付けられた SLB インスタンスのモード。

    UserHost
    SlbId

    string

    SLB インスタンスの ID。

    lb-bp1ut8asdfgucjk****
    Upgrade

    boolean

    ゲートウェイをアップグレードできるかどうかを示します。

    false
    MustUpgrade

    boolean

    ゲートウェイを強制的にアップグレードする必要があるかどうかを示します。

    false
    SupportWasm

    boolean

    WebAssembly (Wasm) がサポートされているかどうかを示します。

    true
    CurrentVersion

    string

    現在のバージョン。

    0.1.0-mse-gw
    AppVersion

    string

    アプリケーションバージョン。

    1.0.1.0
    LatestVersion

    string

    最新バージョン。

    0.1.0-mse-gw
    Vswitch2

    string

    セカンダリ vSwitch の ID。

    vsw-bpbrveck45nf****
    InstanceId

    string

    インスタンス ID。

    mse_ingresspost-cn-0jbvrcex****
    ChargeType

    string

    課金方法。

    POSTPAY
    EndDate

    string

    有効期限。

    4792060800000
    Tag

    string

    ゲートウェイのタグ。

    test
    InitConfig

    object

    初期化設定。

    EnableWaf

    boolean

    Web Application Firewall (WAF) が有効になっているかどうかを示します。

    true
    SupportWaf

    boolean

    WAF がサポートされているかどうかを示します。

    true
    GatewayVersion

    string

    ゲートウェイバージョン。

    1.2.9
    RollBack

    boolean

    ロールバックがサポートされているかどうかを示します。

    false
    MseTag

    string

    リソースタグ。

    {"tagKey":"tagValue"}
    ResourceGroupId

    string

    リソースグループ ID。

    rg-97hg87vi****
    TotalReplica

    integer

    自動スケーリングされたレプリカを含むレプリカの総数。

    4
    Elastic

    boolean

    自動スケーリングが有効になっているかどうかを示します。

    true
    ElasticReplica

    integer

    自動スケーリングされたレプリカの数。

    2
    ElasticType

    string

    自動スケーリングのタイプ。有効な値：

    • CronHPA: 時間ベースのスケーリング

    CronHPA
    ElasticPolicy

    object

    自動スケーリングポリシー。

    Elastic

    boolean

    自動スケーリングが有効になっているかどうかを示します。

    true
    MaxReplica

    integer

    自動スケーリングのレプリカの最大数。

    10
    ElasticType

    string

    自動スケーリングのタイプ。有効な値：

    • CronHPA: スケジュールされたスケーリング

    CronHPA
    TimePolicyList

    array<object>

    スケジュールされた自動スケーリングポリシーのリスト。

    object

    DesiredReplica

    integer

    自動スケーリングで期待されるレプリカ数。

    4
    StartTime

    string

    自動スケーリングの開始時刻。

    07:00
    EndTime

    string

    自動スケーリングの終了時刻。

    09:00
    LoadWarningThreshold

    boolean

    負荷ベースの自動スケーリングのしきい値タイプを指定します。true は警告しきい値、false は安全しきい値です。

    EnableScaleTimePolicyList

    array<object>

    スケールインが許可される期間。

    object

    StartTime

    string

    期間の開始時刻。

    EndTime

    string

    期間の終了時刻。

    ElasticInstanceId

    string

    ゲートウェイの弾性インスタンスの ID。このパラメーターは、自動スケーリングが有効な場合に返されます。

    mse_ingresselastic_public_cn-uqm3d0*****
    VpcId

    string

    ゲートウェイが存在する VPC の ID。

    vpc-uf6heojei217tv14*****
    MseVersion

    string

    クラスターバージョン。

    MaintenancePeriod

    object

    メンテナンスウィンドウ。

    TimeZone

    string

    タイムゾーン。

    StartTime

    string

    メンテナンスウィンドウの開始時刻。

    EndTime

    string

    メンテナンスウィンドウの終了時刻。

    GatewayEntry

    array<object>

    ゲートウェイの Ingress 設定。このパラメーターは Professional Edition インスタンスに適用されます。

    object

    NetType

    string

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

    • PRIVATE_NET：VPC

    • PUB_NET：インターネット

    PUB_NET
    EntryDomain

    string

    Ingress ドメイン名。

    gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com
    IpList

    array

    Ingress IP アドレス。

    string

    Ingress IP アドレス。

    1.2.3.4
    HttpPorts

    array

    HTTP リスナーポート。

    integer

    HTTP リスナーポート。

    80
    HttpsPorts

    array

    HTTPS リスナーポート。

    integer

    HTTPS リスナーポート。

    443
    VersionLifecycle

    string

    バージョンライフサイクル。

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "34300B3-52EC-5049-8C96-914098CF****",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation. Action: mse:ListGateway, Resource: acs:mse:cn-hangzhou:102123:*",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 153,
        "Name": "tesa-test",
        "GatewayUniqueId": "gw-5017305290e14cebb8ce5cb6a4****",
        "GatewayType": "Ingress",
        "Region": "cn-hangzhou",
        "PrimaryUser": "18278117654342",
        "Status": 2,
        "AhasOn": false,
        "ArmsOn": false,
        "Spec": "MSE_GTW_1_2_200_c",
        "Replica": 2,
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2021-09-13 19:24:23",
        "StatusDesc": "重启中",
        "Slb": [
          {
            "SlbIp": "153.12.XX.XX",
            "SlbPort": "80",
            "SlbSpec": "slb.s2.small",
            "Type": "PUB_NET",
            "GatewaySlbStatus": "Ready",
            "StatusDesc": "创建中",
            "GatewaySlbMode": "UserHost",
            "SlbId": "lb-bp1ut8asdfgucjk****"
          }
        ],
        "InternetSlb": [
          {
            "SlbIp": "153.12.XX.XX",
            "SlbPort": "slb.s2.small",
            "SlbSpec": "slb.s2.small",
            "Type": "PUB_NET",
            "InternetNetworkFlow": "20",
            "GatewaySlbStatus": "Ready",
            "StatusDesc": "创建中",
            "GatewaySlbMode": "UserHost",
            "SlbId": "lb-bp1ut8asdfgucjk****"
          }
        ],
        "Upgrade": false,
        "MustUpgrade": false,
        "SupportWasm": true,
        "CurrentVersion": "0.1.0-mse-gw",
        "AppVersion": "1.0.1.0",
        "LatestVersion": "0.1.0-mse-gw",
        "Vswitch2": "vsw-bpbrveck45nf****",
        "InstanceId": "mse_ingresspost-cn-0jbvrcex****",
        "ChargeType": "POSTPAY",
        "EndDate": "4792060800000",
        "Tag": "test",
        "InitConfig": {
          "EnableWaf": true,
          "SupportWaf": true
        },
        "GatewayVersion": "1.2.9",
        "RollBack": false,
        "MseTag": "{\"tagKey\":\"tagValue\"}",
        "ResourceGroupId": "rg-97hg87vi****",
        "TotalReplica": 4,
        "Elastic": true,
        "ElasticReplica": 2,
        "ElasticType": "CronHPA",
        "ElasticPolicy": {
          "Elastic": true,
          "MaxReplica": 10,
          "ElasticType": "CronHPA",
          "TimePolicyList": [
            {
              "DesiredReplica": 4,
              "StartTime": "07:00",
              "EndTime": "09:00"
            }
          ],
          "LoadWarningThreshold": false,
          "EnableScaleTimePolicyList": [
            {
              "StartTime": "",
              "EndTime": ""
            }
          ]
        },
        "ElasticInstanceId": "mse_ingresselastic_public_cn-uqm3d0*****",
        "VpcId": "vpc-uf6heojei217tv14*****",
        "MseVersion": "",
        "MaintenancePeriod": {
          "TimeZone": "",
          "StartTime": "",
          "EndTime": ""
        },
        "GatewayEntry": [
          {
            "NetType": "PUB_NET",
            "EntryDomain": "gw-*****5c2cd6144f4bfa1c32289f45ea8.cn-hangzhou.alicloudapi.com",
            "IpList": [
              "1.2.3.4"
            ],
            "HttpPorts": [
              80
            ],
            "HttpsPorts": [
              443
            ]
          }
        ],
        "VersionLifecycle": ""
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalRequest Invalid request:%s
    400 InvalidParameter Parameter error:%s
    500 InternalError Console error. Try again later:%s
    403 NoPermission You are not authorized to perform this operation:%s
    404 NotFound Not found:%s

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

    変更履歴

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