すべてのプロダクト
Search

このプロダクト

    Microservices Engine:ListGatewayService

    ドキュメントセンター

    Microservices Engine:ListGatewayService

    最終更新日: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:ListGatewayService

    get

    *Gateway

    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    ページ番号。

    1
    PageSize

    integer

    任意

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

    10
    OrderItem

    string

    任意

    ソートプロパティ。

    GmtCreate
    DescSort

    boolean

    任意

    結果を降順でソートするかどうかを示します。

    false
    FilterParams

    object

    任意

    フィルター条件。`{"key1":"value1"}` のような JSON 文字列として指定します。

    Name

    string

    任意

    サービス名。

    test
    SourceType

    string

    任意

    ソースタイプ。

    MSE
    Namespace

    string

    任意

    名前空間。

    public
    GroupName

    string

    任意

    グループ。

    test
    GatewayUniqueId

    string

    必須

    一意のゲートウェイ ID。

    gw-5017305290e14centbrveca****
    ServiceProtocol

    string

    任意

    サービスプロトコル。

    • HTTP

    • HTTPS

    • HTTP2

    • GRPC

    • DUBBO

    列挙値:

    • HTTP2 :

      HTTP2

    • HTTPS :

      HTTPS

    • HTTP :

      HTTP

    • DUBBO :

      DUBBO

    • GRPC :

      GRPC

    HTTP
    AcceptLanguage

    string

    任意

    応答言語。有効な値：

    • zh: 中国語

    • en: 英語

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    データ構造。

    RequestId

    string

    リクエスト ID。

    F46CDBA4-B1EE-5C94-8A48-51C10177****
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Message

    string

    応答メッセージ。

    You are not authorized to perform this operation.
    Code

    integer

    応答コード。

    200
    Success

    boolean

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

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

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

    true
    Data

    object

    応答データ。

    TotalSize

    integer

    エントリの総数。

    9
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。デフォルト値：10。

    10
    Result

    array<object>

    サービスリスト。

    array<object>

    サービスの詳細。

    Id

    integer

    サービス ID。

    1
    Name

    string

    サービス名。

    test
    GatewayUniqueId

    string

    ゲートウェイの一意の ID。

    gw-5017305290e14centbrveca****
    GatewayId

    integer

    ゲートウェイ ID。

    1
    SourceType

    string

    ソースタイプ。

    MSE
    Namespace

    string

    名前空間。

    public
    GroupName

    string

    グループ名。

    test
    SourceId

    integer

    ソース ID。

    2
    ServiceNameInRegistry

    string

    サービスレジストリ内の元のサービス名。

    test
    MetaInfo

    string

    サービスメタデータ。

    {}
    Ips

    array

    サービスの IP アドレスのリスト。

    string

    サービスの IP アドレス。

    127.0.2.1
    GmtCreate

    string

    サービスが作成された時間。

    2022-01-07 18:07:57
    GmtModified

    string

    サービスが最後に変更された時間。

    2022-01-07 18:07:57
    Versions

    array<object>

    サービスバージョンのリスト。

    object

    サービスバージョン。

    Name

    string

    バージョン名。

    v1
    ServiceProtocol

    string

    サービスプロトコル。

    HTTP
    ServicePort

    integer

    サービスポート。

    80
    HealehStatus

    string

    サービスのヘルスステータス。有効な値：

    • Health

    • Unhealthy

    • Unknown

    Unhealthy
    HealthStatus

    string

    サービスのヘルスステータス。有効な値：

    • Health

    • Unhealthy

    • Unknown

    Unhealthy
    HealthCheck

    boolean

    ヘルスチェックを実行するかどうかを示します。

    true
    HealthCheckInfo

    object

    ヘルスチェック設定。

    Check

    boolean

    ヘルスチェックを有効にするかどうかを示します。

    true
    Protocol

    string

    ヘルスチェックのプロトコル。

    TCP
    Timeout

    integer

    ヘルスチェックのタイムアウト (秒単位)。

    2
    Interval

    integer

    ヘルスチェックの間隔 (秒単位)。

    2
    HealthyThreshold

    integer

    エンドポイントが正常と見なされるために必要な、連続したヘルスチェックの成功回数。

    2
    UnhealthyThreshold

    integer

    エンドポイントが異常と見なされるために必要な、連続したヘルスチェックの失敗回数。

    2
    HttpPath

    string

    ヘルスチェックの HTTP パス。

    /health
    HttpHost

    string

    ヘルスチェック HTTP リクエストのホスト。

    http://172.168.0.1
    ExpectedStatuses

    array

    ヘルスチェックの成功を示す、期待される HTTP ステータスコードのリスト。

    integer

    期待される HTTP ステータスコード。

    200
    UnhealthyEndpoints

    array

    異常なエンドポイントのリスト。

    string

    異常なエンドポイント。

    172.168.0.1
    GatewayTrafficPolicy

    object

    トラフィック管理ポリシー。

    Tls

    object

    Transport Layer Security (TLS) 設定。

    Mode

    string

    TLS モード。

    • DISABLE

    • SIMPLE

    • MUTUAL

    • ISTIO_MUTUAL

    SIMPLE
    CertId

    string

    証明書 ID。

    5******-cn-hangzhou
    CaCertId

    string

    CA 証明書 ID。

    5******-cn-hangzhou
    CaCertContent

    string

    CA 証明書の公開鍵。

    content
    SubjectAltNames

    array

    サブジェクト代替名 (SAN) のリスト。

    string

    サブジェクト代替名。

    name
    Sni

    string

    サーバ名表示 (SNI)。

    name-sni
    LoadBalancerSettings

    object

    負荷分散設定。

    LoadbalancerType

    string

    負荷分散ポリシー。

    • ROUND_ROBIN

    • LEAST_CONN

    • RANDOM

    • CONSISTENT_HASH

    RANDOM
    ConsistentHashLBConfig

    object

    Cookie ベースの一貫性ハッシュの設定。

    ParameterName

    string

    一貫性ハッシュに使用されるパラメーターの名前。

    param
    HttpCookie

    object

    Cookie ベースの一貫性ハッシュの設定。

    Name

    string

    Cookie の名前。

    name
    Path

    string

    Cookie のパス。

    /path
    Ttl

    string

    Cookie の生存時間 (TTL)。

    360
    MinimumRingSize

    integer

    ハッシュリングの最小サイズ。

    10000
    ConsistentHashLBType

    string

    一貫性ハッシュメソッド。

    • HEADER

    • COOKIE

    • SOURCE_IP

    • QUERY_PARAMETER

    HEADER
    WarmupDuration

    integer

    ウォームアップ期間 (秒単位)。この期間中、新しく追加されたエンドポイントへのトラフィックは徐々に増加します。

    10
    Ports

    array

    サービスポートのリスト。

    integer

    サービスポート番号。

    8080
    ServiceFQDN

    string

    サービスの完全修飾ドメイン名 (FQDN)。

    DnsServerList

    array

    DNS サーバのリスト。このパラメーターは DNS ベースのサービスでのみ使用されます。

    string

    `IP アドレス:ポート` 形式の DNS サーバアドレス。

    1.1.1.1:80

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "F46CDBA4-B1EE-5C94-8A48-51C10177****",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "Name": "test",
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "GatewayId": 1,
        "SourceType": "MSE",
        "Namespace": "public",
        "GroupName": "test",
        "SourceId": 2,
        "ServiceNameInRegistry": "test",
        "MetaInfo": "{}",
        "Ips": [
          "127.0.2.1"
        ],
        "GmtCreate": "2022-01-07 18:07:57",
        "GmtModified": "2022-01-07 18:07:57",
        "Versions": [
          {
            "Name": "v1"
          }
        ],
        "ServiceProtocol": "HTTP",
        "ServicePort": 80,
        "HealehStatus": "Unhealthy",
        "HealthStatus": "Unhealthy",
        "HealthCheck": true,
        "HealthCheckInfo": {
          "Check": true,
          "Protocol": "TCP",
          "Timeout": 2,
          "Interval": 2,
          "HealthyThreshold": 2,
          "UnhealthyThreshold": 2,
          "HttpPath": "/health",
          "HttpHost": "http://172.168.0.1",
          "ExpectedStatuses": [
            200
          ]
        },
        "UnhealthyEndpoints": [
          "172.168.0.1"
        ],
        "GatewayTrafficPolicy": {
          "Tls": {
            "Mode": "SIMPLE",
            "CertId": "5******-cn-hangzhou",
            "CaCertId": "5******-cn-hangzhou",
            "CaCertContent": "content",
            "SubjectAltNames": [
              "name"
            ],
            "Sni": "name-sni"
          },
          "LoadBalancerSettings": {
            "LoadbalancerType": "RANDOM",
            "ConsistentHashLBConfig": {
              "ParameterName": "param",
              "HttpCookie": {
                "Name": "name",
                "Path": "/path",
                "Ttl": "360"
              },
              "MinimumRingSize": 10000,
              "ConsistentHashLBType": "HEADER"
            },
            "WarmupDuration": 10
          }
        },
        "Ports": [
          8080
        ],
        "ServiceFQDN": "",
        "DnsServerList": [
          "1.1.1.1:80"
        ]
      }
    ]
  }
}

    エラーコード

    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

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

    変更履歴

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