ListGatewaySlb - Microservices Engine - Alibaba Cloud ドキュメントセンター

この操作では、ゲートウェイエントリの SLB インスタンスを照会します。

今すぐお試しください

この 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:ListGatewaySlb

get

*Gateway

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GatewayUniqueId	string	任意	ゲートウェイの一意の ID です。	gw-1cef5440bf2d484db419fb264d4f****
AcceptLanguage	string	任意	応答メッセージの言語です。有効な値： zh：中国語 en：英語	zh

レスポンスフィールド

フィールド	型	説明	例
	object	データ構造。
RequestId	string	リクエスト ID。	EAB345F4-3AC3-560C-B653-65717703****
HttpStatusCode	integer	HTTP ステータスコード。	200
Message	string	応答メッセージ。	Succ
Code	integer	リターンコード。	200
Success	boolean	リクエストが成功したかどうかを示します。有効な値： `true`：リクエストは成功しました。 `false`：リクエストは失敗しました。	true
Data	array<object>	応答データ。
	array<object>	データ構造。
Id	string	レコードの一意の ID。	ID
SlbId	string	SLB インスタンスの ID。	lb-bp1kmnli3hdpreptw2ah3
SlbIp	string	SLB インスタンスの IP アドレス。	121.199.XX.XX
SlbPort	string	SLB インスタンスのポート。	80,443
Type	string	ネットワークタイプ。有効な値： `PUB_NET`：パブリックネットワーク `PRIVATE_NET`：プライベートネットワーク	PUB_NET
GatewayId	string	ゲートウェイの ID。	1
GmtCreate	string	レコードの作成時間。	2022-01-14 14:39:16
GatewaySlbMode	string	SLB 関連付けのソース。	UserSelect
GatewaySlbStatus	string	SLB インスタンスの関連付けステータス。	Ready
StatusDesc	string	ステータスの詳細な説明。	Associating
VServerGroupId	string	HTTP vServer グループの ID。	353
HttpPort	integer	vServer グループの HTTP ポート。	80
HttpsPort	integer	vServer グループの HTTPS ポート。	443
ServiceWeight	integer	サービスの重み。	80
EditEnable	boolean	エントリが編集可能かどうかを示します。	false
HttpsVServerGroupId	string	HTTPS vServer グループの ID。	353
VsMetaInfo	string	vServer グループのメタデータ。	[{"protocol":"HTTP","vServerGroupName":"k8s/80/**","port":80,"vServerGroupId":"rsp-bp"},{"protocol":"HTTPS","vServerGroupName":"k8s/443/","port":443,"vServerGroupId":"rsp-bp***"}]
VServiceList	array<object>	SLB リスナーの詳細。
	object
Port	string	リスナーポート。	443
Protocol	string	プロトコルタイプ。有効な値： HTTPS HTTP	HTTPS
VServerGroupId	string	vServer グループの ID。	rsp-bp183l2x70***
VServerGroupName	string	vServer グループの名前。	k8s/310/*/istio-system/clusterid
SlbType	string	SLB インスタンスのタイプ。

例

成功レスポンス

JSONJSON

{
  "RequestId": "EAB345F4-3AC3-560C-B653-65717703****",
  "HttpStatusCode": 200,
  "Message": "Succ",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": "ID",
      "SlbId": "lb-bp1kmnli3hdpreptw2ah3",
      "SlbIp": "121.199.XX.XX",
      "SlbPort": "80,443",
      "Type": "PUB_NET",
      "GatewayId": "1",
      "GmtCreate": "2022-01-14 14:39:16",
      "GatewaySlbMode": "UserSelect",
      "GatewaySlbStatus": "Ready",
      "StatusDesc": "Associating",
      "VServerGroupId": "353",
      "HttpPort": 80,
      "HttpsPort": 443,
      "ServiceWeight": 80,
      "EditEnable": false,
      "HttpsVServerGroupId": "353",
      "VsMetaInfo": "[{\"protocol\":\"HTTP\",\"vServerGroupName\":\"k8s/80/****\",\"port\":80,\"vServerGroupId\":\"rsp-bp***\"},{\"protocol\":\"HTTPS\",\"vServerGroupName\":\"k8s/443/***\",\"port\":443,\"vServerGroupId\":\"rsp-bp*****\"}]",
      "VServiceList": [
        {
          "Port": "443",
          "Protocol": "HTTPS",
          "VServerGroupId": "rsp-bp183l2x70***",
          "VServerGroupName": "k8s/31**0/***/istio-system/clusterid"
        }
      ],
      "SlbType": ""
    }
  ]
}

エラーコード

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

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

変更履歴

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