DescribeApisecProtectionResources API リファレンス - WAF - Alibaba Cloud - Web Application Firewall

今すぐお試しください

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

list

*All Resource

*

acs:ResourceGroupId

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	WAF インスタンスの ID。説明 DescribeInstance 操作を呼び出して、WAF インスタンスの ID を照会できます。	waf-cn-0xldbqt****
Resource	string	任意	保護対象の名前。	cwaf-***-waf
PageNumber	integer	任意	ページングクエリを実行する際に返されるページ番号。デフォルト値: 1 (最初のページを示します)。ページングの詳細については、API リファレンスを参照してください。	1
PageSize	integer	任意	ページングクエリを実行する際の 1 ページあたりのエントリ数。デフォルト値: 10 (1 ページあたり 10 エントリを示します)。ページングの詳細については、API リファレンスを参照してください。	10
ApisecStatus	integer	任意	API セキュリティのグローバルスイッチ。	1
RegionId	string	任意	WAF インスタンスがデプロイされているリージョン。有効な値: cn-hangzhou: 中国本土。 ap-southeast-1: 中国本土以外。	cn-hangzhou
ResourceManagerResourceGroupId	string	任意	Alibaba Cloud リソースグループの ID。	rg-acfm***q

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
TotalCount	integer	返されたエントリの総数。	5
RequestId	string	リクエスト ID。	2EFCFE18-78F8-5079-B312-07***48B
Data	array<object>	保護対象のリスト。
	object	保護対象の情報。
ApisecStatus	integer	API セキュリティのグローバルスイッチ。	1
Resource	string	保護対象。	cwaf-***-waf
ReportStatus	integer	コンプライアンスレビュースイッチのステータス。	1
TraceStatus	integer	トレーシング監査スイッチのステータス。	0

例

成功レスポンス

JSONJSON

{
  "TotalCount": 5,
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "Data": [
    {
      "ApisecStatus": 1,
      "Resource": "cwaf-***-waf",
      "ReportStatus": 1,
      "TraceStatus": 0
    }
  ]
}

エラーコード

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

変更履歴

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