ListGatewayService - 查詢網關已訂閱的服務列表 - Microservices Engine

查詢網關已訂閱的服務列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mse:ListGatewayService

get

*Gateway

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

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	頁碼。	1
PageSize	integer	否	分頁大小。	10
OrderItem	string	否	排序屬性。	GmtCreate
DescSort	boolean	否	排序。	false
FilterParams	object	否	過濾條件，格式為{"key1":"value1"}。
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	每頁最大記錄數，預設值為 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	元資訊或 IP 列表。	{}
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	健全狀態檢查期望狀態值。
	integer	期望的 HttpStatus。	200
UnhealthyEndpoints	array	非健康 endpoint 數組
	string	非健康 endpoint	172.168.0.1
GatewayTrafficPolicy	object	流量管理原則。
Tls	object	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	主體別名數組。
	string	主體別名。	name
Sni	string	服務名稱標識。	name-sni
LoadBalancerSettings	object	負載平衡設定。
LoadbalancerType	string	負載平衡策略 ROUND_ROBIN LEAST_CONN RANDOM CONSISTENT_HASH	RANDOM
ConsistentHashLBConfig	object	一致性雜湊配置。
ParameterName	string	參數名稱。	param
HttpCookie	object	基於 Cookie 的參數。
Name	string	cookie 名稱。	name
Path	string	cookie 路徑。	/path
Ttl	string	cookie 生命週期。	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 網域名稱服務 (DNS)使用）
	string	DNS 伺服器地址（IP+連接埠）	1.1.1.1:80

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
400	IllegalRequest	Invalid request:%s	非法請求： %s
400	InvalidParameter	Parameter error:%s	請求參數錯誤：%s
500	InternalError	Console error. Try again later:%s	控制台錯誤.稍後重試：%s
403	NoPermission	You are not authorized to perform this operation:%s	沒有許可權使用此介面：%s
404	NotFound	Not found:%s	資源不存在：%s

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。