DescribeHybridCloudUnassignedMachines 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:DescribeHybridCloudUnassignedMachines

get

*All Resource

*

acs:ResourceGroupId

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	WAF インスタンスの ID。説明 WAF インスタンスの ID をクエリするには、DescribeInstance を呼び出します。	waf_v3prepaid_public_cn-5yd****7009
ClusterId	integer	必須	ハイブリッドクラウドクラスターの ID。	123
Ip	string	任意	サーバーの IP アドレス。	1.X.X.1
HostName	string	任意	ホスト名。	online-xagent1
PageSize	integer	任意	各ページに返すエントリ数。デフォルト値：10。	10
PageNumber	integer	任意	返すページのページ番号。デフォルト値：1。	1
RegionId	string	任意	WAF インスタンスが存在するリージョン。有効な値： cn-hangzhou：中国本土。 ap-southeast-1：中国本土以外。	cn-hangzhou
ResourceManagerResourceGroupId	string	任意	Alibaba Cloud リソースグループの ID。	rg-acfm***q

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されたエントリの総数。	28
RequestId	string	リクエスト ID。	3EBCFCE9-4A3C-5E01-915D-691B****510A
UnassignedMachines	array<object>	ハイブリッドクラウドクラスター内の未割り当てマシンのリスト。
	object	ハイブリッドクラウドクラスター内の未割り当てマシン。
CustomName	string	ノード名。	exampleName
Memory	integer	メモリサイズ (KB)。換算レートは 1000 です。	31580872
Ip	string	サーバーの IP アドレス。	1.X.X.1
Cpu	integer	CPU コア数。	16
Mid	string	ノードの ID。	78db009ab6cf055a9085f9f4****ae3a
HostName	string	ホスト名。	online-xagent1
Mac	string	デバイスの MAC アドレス。	00163e2686ac

例

成功レスポンス

JSONJSON

{
  "TotalCount": 28,
  "RequestId": "3EBCFCE9-4A3C-5E01-915D-691B****510A",
  "UnassignedMachines": [
    {
      "CustomName": "exampleName",
      "Memory": 31580872,
      "Ip": "1.X.X.1\n",
      "Cpu": 16,
      "Mid": "78db009ab6cf055a9085f9f4****ae3a",
      "HostName": "online-xagent1\n",
      "Mac": "00163e2686ac"
    }
  ]
}

エラーコード

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

変更履歴

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