DescribeUnhealthyHostAvailability による異常サーバー一覧の取得 - CMS

DescribeUnhealthyHostAvailability 操作を呼び出して、異常なサーバーのリストを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:DescribeUnhealthyHostAvailability

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	array	必須	タスク ID。	123456
	integer	任意	タスク ID。	123***

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	状態コード。説明値が 200 の場合は、リクエストが成功したことを示します。	200
Message	string	エラーメッセージ。	User not authorized to operate on the specified resource.
RequestId	string	リクエスト ID。	ACBDBB40-DFB6-4F4C-8957-51FFB233969C
Success	boolean	操作が成功したかどうかを示します。有効な値: -true: 操作は成功しました。-false: 操作は失敗しました。	true
UnhealthyList	object
NodeTaskInstance	array<object>	異常なサーバーのリストに関する情報。
	array<object>
Id	integer	タスク ID。	123******
InstanceList	object
String	array	インスタンス ID のリスト。
	string	インスタンス。	i-*****

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "ACBDBB40-DFB6-4F4C-8957-51FFB233969C",
  "Success": true,
  "UnhealthyList": {
    "NodeTaskInstance": [
      {
        "Id": 0,
        "InstanceList": {
          "String": [
            "i-*****"
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

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

変更履歴

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