DescribeHybridCloudClusters API でハイブリッドクラウドクラスターをクエリ - WAF

ハイブリッドクラウドクラスターの一覧をクエリします。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-waf:DescribeHybridCloudClusters

get

*All Resource

*

acs:ResourceGroupId

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	WAF インスタンスの ID。説明 WAF インスタンスの ID を照会するには、DescribeInstanceInfo を呼び出してください。	waf_v2_public_cn-uqm35****02
RegionId	string	任意	WAF インスタンスがデプロイされているリージョン。有効な値は以下のとおりです。 cn-hangzhou: 中国本土 ap-southeast-1: 中国本土以外	cn-hangzhou
ResourceManagerResourceGroupId	string	任意	Alibaba Cloud リソースグループの ID。	rg-acfm***q

レスポンスフィールド

フィールド	型	説明	例
	object	応答内容。
RequestId	string	リクエスト ID。	66A98669-ER12-WE34-23PO-301469*****E
ClusterInfos	array<object>	クラスターの一覧。
	object	クラスター情報。
HttpsPorts	string	HTTPS プロトコルを使用するポート。値は文字列で、複数のポートが返される場合は、port1,port2,port3 の形式でカンマ区切りになります。	443,8443
ProtectionServerCount	integer	クラスターに追加可能な保護ノードの数。	1
ProxyStatus	string	プロキシのステータス。有効な値は以下のとおりです。 on: 有効 off: 無効	off
RuleType	string	ルールの種類。有効な値は以下のとおりです。 bypass: WAF によるセキュリティチェックをバイパスし、トラフィックをそのまま通過させます。	bypass
AccessRegion	string	専用回線が接続されているリージョン。有効な値は以下のとおりです。 cn-hangzhou: 杭州 cn-beijing: 北京 cn-shanghai: 上海	cn-hangzhou
Remark	string	備考。	test
ClusterResourceId	string	ハイブリッドクラウドクラスターのリソース ID。	hdbc-cluster-t1****a
ClusterName	string	クラスター名。	testcluster
RuleStatus	string	手動バイパス設定のステータス。有効な値は以下のとおりです。 on: 有効。 off: 無効。	off
Id	integer	クラスター ID。	524**8
AccessMode	string	ネットワークアクセスモード。有効な値は以下のとおりです。 internet: インターネット経由のアクセス。 vpc: 専用回線を用いたプライベートネットワーク経由のアクセス。	internet
ProxyType	string	クラスターの種類。有効な値は以下のとおりです。 cname: リバースプロキシクラスター service: サービスクラスター	cname
RuleConfig	string	ルール構成。	{"enable":true,"param":{"breaker":{"duration":1,"failed":1,"recent_failed":1},"disable_protect":false,"max_request_body_len":1,"timeout":1}}
HttpPorts	string	HTTP プロトコルを使用するポート。値は文字列で、複数のポートが返される場合は、port1,port2,port3 の形式でカンマ区切りになります。	80,8080

例

成功レスポンス

JSONJSON

{
  "RequestId": "66A98669-ER12-WE34-23PO-301469*****E",
  "ClusterInfos": [
    {
      "HttpsPorts": "443,8443",
      "ProtectionServerCount": 1,
      "ProxyStatus": "off",
      "RuleType": "bypass",
      "AccessRegion": "cn-hangzhou",
      "Remark": "test",
      "ClusterResourceId": "hdbc-cluster-t1****a",
      "ClusterName": "testcluster",
      "RuleStatus": "off",
      "Id": 0,
      "AccessMode": "internet",
      "ProxyType": "cname",
      "RuleConfig": "{\"enable\":true,\"param\":{\"breaker\":{\"duration\":1,\"failed\":1,\"recent_failed\":1},\"disable_protect\":false,\"max_request_body_len\":1,\"timeout\":1}}",
      "HttpPorts": "80,8080"
    }
  ]
}

エラーコード

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

変更履歴

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