DescribeAntiBruteForceRules API リファレンス - Security Center - Alibaba Cloud - Security Center

作成済みのブルートフォース攻撃防止ルールを照会します。

今すぐお試しください

この 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-sas:DescribeAntiBruteForceRules

get

*AntiBruteForceRule

acs:yundun-sas:{#regionId}:{#accountId}:antibruteforcerule/{#AntiBruteForceRuleId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SourceIp	string	任意	アクセスソースの IP アドレス。	121.69.XX.XX
Id	integer	任意	ブルートフォース攻撃防止ルールの ID。説明 DescribeAntiBruteForceRules 操作を呼び出してこのパラメーターを取得できます。	1141****
CurrentPage	integer	任意	返すページのページ番号。デフォルト値: 1（最初のページを示します）。	1
PageSize	string	任意	ページングクエリで各ページに返すエントリの最大値。このパラメーターはページングに使用されます。	10
Name	string	任意	ブルートフォース攻撃防止ルールの名前。	testName

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。Alibaba Cloud がリクエストに対して生成する一意の識別子です。この ID を使用して問題をトラブルシューティングできます。	4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D
PageInfo	object	クエリ結果のページネーション情報。
CurrentPage	integer	ページングクエリにおける現在のページのページ番号。このパラメーターはページングに使用されます。	1
PageSize	integer	ページングクエリで 1 ページあたりに返されるエントリの最大値。このパラメーターはページングに使用されます。	20
TotalCount	integer	作成済みのブルートフォース攻撃防止ルールの総数。	2
Count	integer	ページングクエリで現在のページに返されるエントリの数。このパラメーターはページングに使用されます。	2
Rules	array<object>	ブルートフォース攻撃防止ルールの詳細。
	array<object>	ブルートフォース攻撃防止ルールの詳細。
MachineCount	integer	ブルートフォース攻撃防止ルールが適用されているサーバーの数。	3
EnableSmartRule	boolean	このパラメーターは非推奨であり、指定する必要はありません。	false
FailCount	integer	ブルートフォース攻撃防止ルールをトリガーする失敗したログイン試行回数のしきい値。	15
ForbiddenTime	integer	ブルートフォース攻撃防止ルールがトリガーされた後、攻撃者の IP アドレスが無効化される持続時間。単位: 分。	360
Span	integer	ブルートフォース攻撃防止ルールが効果を発揮する時間しきい値。単位: 分。例えば、Span が 10 にセットされている場合、10 分以内の失敗したログイン試行回数が設定のしきい値を超えると、ブルートフォース攻撃防止ルールがトリガーされ、指定された持続時間のログイン試行がブロックされます。	10
DefaultRule	boolean	現在のルールがデフォルトルールかどうかを示します。有効な値: true: デフォルトルールです。 false: デフォルトルールではありません。説明デフォルトルールとして設定されたブルートフォース攻撃防止ルールは、防止ルールが設定されていないすべてのサーバーに効果を発揮します。詳細については設定項目を参照してください。	true
Name	string	ブルートフォース攻撃防止ルールの名前。	AntiBruteForceRule01
Id	integer	ブルートフォース攻撃防止ルールの ID。	1629
UuidList	array	ブルートフォース攻撃防止ルールが適用されているサーバーの UUID のリスト。
	string	ブルートフォース攻撃防止ルールが適用されているサーバーの UUID。	uuid-018c-4ef7-89fd-988b9b0e****
CreateTimestamp	integer	ブルートフォース攻撃防止ルールが作成された時間の UNIX タイムスタンプ。単位: ミリ秒。	1669800181000
ProtocolType	object	ブルートフォース攻撃防止ルールがインターセプションでサポートするプロトコルタイプ。
Rdp	string	RDP インターセプト方法。値： on：有効 off：無効	on
Ssh	string	SSH インターセプト方法。値： on：有効 off：無効	on
SqlServer	string	SQL Server インターセプト方法。値： on：有効 off：無効	off

例

成功レスポンス

JSONJSON

{
  "RequestId": "4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 2,
    "Count": 2
  },
  "Rules": [
    {
      "MachineCount": 3,
      "EnableSmartRule": false,
      "FailCount": 15,
      "ForbiddenTime": 360,
      "Span": 10,
      "DefaultRule": true,
      "Name": "AntiBruteForceRule01",
      "Id": 1629,
      "UuidList": [
        "uuid-018c-4ef7-89fd-988b9b0e****"
      ],
      "CreateTimestamp": 1669800181000,
      "ProtocolType": {
        "Rdp": "on",
        "Ssh": "on",
        "SqlServer": "off"
      }
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	ServerError	ServerError
403	NoPermission	caller has no permission

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

変更履歴

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