DescribeControlPolicy で Cloud Firewall アクセス制御ポリシーを取得 - Cloud Firewall - Alibaba Cloud - Cloud Firewall

すべてのアクセス制御ポリシーに関する情報を取得します。

操作説明

この操作は、アクセス制御ポリシーに関する情報についてページングクエリを実行します。

QPS 制限

この操作の秒間クエリ数 (QPS) 制限は、単一ユーザーあたり 10 です。この制限を超えると、API 呼び出しはスロットリングされます。これはビジネスに影響を与える可能性があります。したがって、呼び出しを適切に計画してください。

今すぐお試しください

この 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-cloudfirewall:DescribeControlPolicy

get

*ControlPolicyOrder

acs:cloudfirewall::{#accountId}:controlpolicy/{#AclUuid}/controlpolicyorder/{#Direction}

*ControlPolicy

acs:cloudfirewall::{#accountId}:controlpolicy/{#AclUuid}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Lang	string	任意	応答メッセージの言語。有効値： zh (デフォルト)：中国語 en：英語	zh
Lang	string	任意	応答メッセージの言語。有効値： zh (デフォルト)：中国語 en：英語	zh
Direction	string	任意	アクセス制御ポリシーが制御するトラフィックの方向。有効値： in：外部ソースから内部宛先へのインバウンドトラフィック。 out：内部ソースから外部宛先へのアウトバウンドトラフィック。列挙値: in : 外部ソースから内部宛先へのインバウンドトラフィック。 out : 内部ソースから外部宛先へのアウトバウンドトラフィック。	in
CurrentPage	string	必須	返すページ番号。デフォルト値：1。	1
PageSize	string	必須	各ページで返すエントリ数。	10
Source	string	任意	アクセス制御ポリシーの送信元アドレス。あいまいクエリがサポートされています。このパラメーターの値は、`SourceType` パラメーターの値によって異なります。 `SourceType` が `net` の場合、このパラメーターの値は CIDR ブロックです。例：192.0.XX.XX/24。 `SourceType` が `group` の場合、このパラメーターの値は送信元アドレス帳の名前です。例：`db_group`。このパラメーターを空のままにすると、すべての送信元アドレスがクエリされます。 `SourceType` が `location` の場合、このパラメーターの値は送信元リージョンです。例：`Beijing` または `beijing`。クエリには中国語名または英語名のいずれかを使用できます。説明このパラメーターを設定しない場合、すべてのタイプの送信元アドレスがクエリされます。	192.0.XX.XX
Destination	string	任意	アクセス制御ポリシーの宛先アドレス。あいまいクエリがサポートされています。このパラメーターの値は、`DestinationType` パラメーターの値によって異なります。 `DestinationType` が `net` の場合、このパラメーターの値は CIDR ブロックです。例：10.0.3.0/24。 `DestinationType` が `domain` の場合、このパラメーターの値はドメイン名です。例：aliyun。 `DestinationType` が `group` の場合、このパラメーターの値はアドレス帳の名前です。例：db_group。 `DestinationType` が `location` の場合、このパラメーターの値はリージョン名です。リージョンコードの詳細については、AddControlPolicy をご参照ください。例：["BJ11", "ZB"]。説明このパラメーターを設定しない場合、すべてのタイプの宛先アドレスがクエリされます。	192.0.XX.XX
Description	string	任意	アクセス制御ポリシーの説明。あいまいクエリがサポートされています。説明このパラメーターを設定しない場合、すべてのポリシーの説明がクエリされます。	test
Proto	string	任意	アクセス制御ポリシー内のトラフィックのプロトコルタイプ。有効値： TCP UDP ICMP ANY (すべてのプロトコルタイプ) 説明このパラメーターを設定しない場合、すべてのプロトコルタイプがクエリされます。	TCP
AclAction	string	任意	Cloud Firewall がトラフィックに対して実行するアクション。有効値： accept：許可 drop：拒否 log：監視説明このパラメーターを設定しない場合、すべてのアクションタイプがクエリされます。	accept
Release	string	任意	アクセス制御ポリシーのステータス。有効値： true：アクセス制御ポリシーは有効です。 false：アクセス制御ポリシーは無効です。	true
AclUuid	string	任意	アクセス制御ポリシーの一意の ID。	00281255-d220-4db1-8f4f-c4df221a****
IpVersion	string	任意	サポートされている IP バージョン。有効値： 4 (デフォルト)：IPv4 アドレス 6：IPv6 アドレス列挙値: 4 : IPv4 6 : IPv6	6
RepeatType	string	任意	アクセス制御ポリシーのポリシー有効期間の繰り返しタイプ。有効値： Permanent (デフォルト)：常時 None：1 回限り Daily：毎日 Weekly：毎週 Monthly：毎月列挙値: Daily : 毎日 Monthly : 毎月 Permanent : 常時 Weekly : 毎週 None : 1 回限り	Permanent

レスポンスフィールド

フィールド	型	説明	例
	object
PageNo	string	返されたページのページ番号。	1
PageSize	string	ページごとに返されるエントリ数。	10
RequestId	string	リクエスト ID。	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****
TotalCount	string	アクセス制御ポリシーの総数。	100
Policys	array<object>	アクセス制御ポリシーに関する情報。
	object	アクセス制御ポリシーの詳細。
Direction	string	アクセス制御ポリシーのトラフィックの方向。有効値： in：インバウンドトラフィック out：アウトバウンドトラフィック	in
Order	integer	アクセス制御ポリシーの優先度。優先度の値は 1 から始まり、順次増加します。値が小さいほど、優先度が高くなります。	1
SourceType	string	アクセス制御ポリシーの送信元アドレスタイプ。有効値： net：送信元 CIDR ブロック group：送信元アドレス帳 location：送信元リージョン	net
ApplicationName	string	アクセス制御ポリシーでサポートされるアプリケーションタイプ。代わりに `ApplicationNameList` を使用してください。有効値： FTP HTTP HTTPS Memcache MongoDB MQTT MySQL RDP Redis SMTP SMTPS SSH SSL VNC ANY (すべてのアプリケーションタイプ)	HTTP
HitTimes	integer	アクセス制御ポリシーのヒット数。	100
Description	string	アクセス制御ポリシーの説明。	test
SourceGroupType	string	アクセス制御ポリシーの送信元アドレス帳のタイプ。有効値： ip：1 つ以上の CIDR ブロックを含む IP アドレス帳。 tag：1 つ以上のタグを持つ ECS インスタンスの IP アドレスを含む ECS タグベースアドレス帳。 domain：1 つ以上のドメイン名を含むドメイン名アドレス帳。 threat：1 つ以上の悪意のある IP アドレスまたはドメイン名を含む脅威インテリジェンスアドレス帳。 backsrc：1 つ以上の Anti-DDoS または WAF インスタンスのオリジン URL を含むオリジン URL アドレス帳。	ip
DnsResultTime	integer	DNS 名前解決のタイムスタンプ。値は UNIX タイムスタンプです。単位：秒。	1579261141
DnsResult `deprecated`	string	DNS 名前解決の結果。	192.0.XX.XX,192.0.XX.XX
Proto	string	アクセス制御ポリシー内のトラフィックのプロトコルタイプ。有効値： ANY TCP UDP ICMP	TCP
DestinationGroupType	string	アクセス制御ポリシーの宛先アドレス帳のタイプ。有効値： ip：1 つ以上の CIDR ブロックを含む IP アドレス帳。 tag：1 つ以上のタグを持つ ECS インスタンスの IP アドレスを含む ECS タグベースアドレス帳。 domain：1 つ以上のドメイン名を含むドメイン名アドレス帳。 threat：1 つ以上の悪意のある IP アドレスまたはドメイン名を含む脅威インテリジェンスアドレス帳。 backsrc：1 つ以上の Anti-DDoS または WAF インスタンスのオリジン URL を含むオリジン URL アドレス帳。	ip
Destination	string	アクセス制御ポリシーの宛先アドレス。このパラメーターの値は、`DestinationType` パラメーターの値によって異なります。有効値： DestinationType が net の場合、宛先アドレスは CIDR ブロックです。例：192.0.XX.XX/24。 DestinationType が domain の場合、宛先アドレスはドメイン名です。例：aliyuncs.com。 DestinationType が group の場合、宛先アドレスはアドレス帳の名前です。例：db_group。 DestinationType が location の場合、宛先アドレスはリージョン名です。リージョンコードの詳細については、AddControlPolicy をご参照ください。例：["BJ11", "ZB"]。	192.0.XX.XX/24
HitLastTime	integer	最終ヒットのタイムスタンプ。値は UNIX タイムスタンプです。単位：秒。	1579261141
DestPortGroup	string	アクセス制御ポリシーのトラフィックの宛先ポートアドレス帳の名前。	my_port_group
AclUuid	string	アクセス制御ポリシーの一意の ID。	00281255-d220-4db1-8f4f-c4df221a****
DestPortType	string	アクセス制御ポリシーのトラフィックの宛先ポートタイプ。有効値： port：ポート group：ポートアドレス帳	port
Source	string	アクセス制御ポリシーの送信元アドレス。有効値： SourceType が `net` の場合、送信元アドレスは CIDR ブロックです。例：192.0.XX.XX/24。 SourceType が `group` の場合、送信元アドレスは送信元アドレス帳の名前です。例：db_group。 SourceType が `location` の場合、送信元アドレスはリージョンです。リージョンコードの詳細については、「AddControlPolicy」をご参照ください。例：["BJ11", "ZB"]。	192.0.XX.XX/24
DestinationType	string	アクセス制御ポリシーの宛先アドレスタイプ。有効値： net：宛先 CIDR ブロック group：宛先アドレス帳 domain：宛先ドメイン名 location：ターゲットリージョン	net
DestPort	string	アクセス制御ポリシーのトラフィックの宛先ポート。	80
IpVersion	integer	サポートされている IP バージョン。有効値： 4：IPv4 アドレス 6：IPv6 アドレス	6
AclAction	string	Cloud Firewall がトラフィックに対して実行するアクション。有効値： accept：許可 drop：拒否 log：監視	accept
Release	string	アクセス制御ポリシーのステータス。ポリシーは作成後にデフォルトで有効になります。有効値： true：アクセス制御ポリシーは有効です。 false：アクセス制御ポリシーは無効です。	true
ApplicationId	string	アクセス制御ポリシーのトラフィックのアプリケーション ID。	10***
DestinationGroupCidrs	array	アクセス制御ポリシーの宛先アドレス帳にある CIDR ブロックのリスト。
	string	アクセス制御ポリシーの宛先アドレス帳にある CIDR ブロック。	192.0.XX.XX/24
DestPortGroupPorts	array	宛先ポートアドレス帳のポートのリスト。
	string	宛先ポートアドレス帳のポート。	80/80
SourceGroupCidrs	array	アクセス制御ポリシーの送信元アドレス帳にある CIDR ブロックのリスト。
	string	アクセス制御ポリシーの送信元アドレス帳にある CIDR ブロック。	192.0.XX.XX/24
ApplicationNameList	array	アプリケーション名のリスト。
	string	アクセス制御ポリシーでサポートされるアプリケーションタイプのリスト。有効値： FTP HTTP HTTPS Memcache MongoDB MQTT MySQL RDP Redis SMTP SMTPS SSH SSL VNC ANY (すべてのアプリケーションタイプ)	HTTP
SpreadCnt	integer	アクセス制御ポリシーが消費する仕様エントリの数。これは、各ポリシーによって消費されるエントリの合計です。単一ポリシーのエントリ数は、送信元アドレスの数 (CIDR ブロックまたはリージョン) × 宛先アドレスの数 (CIDR ブロック、リージョン、またはドメイン名) × ポート範囲の数 × アプリケーションの数として計算されます。	10000
CreateTime	integer	ポリシーが作成された時刻。値は UNIX タイムスタンプです。単位：秒。	1761062400
ModifyTime	integer	ポリシーが最後に変更された時刻。値は UNIX タイムスタンプです。単位：秒。	1761062400
RepeatType	string	アクセス制御ポリシーのポリシー有効期間の繰り返しタイプ。有効値： Permanent (デフォルト)：常時 None：1 回限り Daily：毎日 Weekly：毎週 Monthly：毎月列挙値: Daily : 毎日 Monthly : 毎月 Permanent : 常時 Weekly : 毎週 None : 1 回限り	Permanent
RepeatDays	array	アクセス制御ポリシーのポリシー有効期間の定期的な日付のコレクション。 `RepeatType` が `Permanent`、`None`、または `Daily` の場合、`RepeatDays` は空のコレクションです。例：[] `RepeatType` が `Weekly` の場合、`RepeatDays` は空にできません。例：[0, 6] 説明 `RepeatType` が `Weekly` に設定されている場合、`RepeatDays` には重複した値を含めることはできません。 `RepeatType` が `Monthly` の場合、`RepeatDays` は空にできません。例：[1, 31] 説明 `RepeatType` が `Monthly` に設定されている場合、`RepeatDays` には重複した値を含めることはできません。
	integer	アクセス制御ポリシーのポリシー有効期間の定期的な日付。説明 `RepeatType` が `Weekly` に設定されている場合、値の範囲は 0 から 6 です。週は日曜日から始まります。 `RepeatType` が `Monthly` に設定されている場合、値の範囲は 1 から 31 です。	1
RepeatStartTime	string	アクセス制御ポリシーのポリシー有効期間の繰り返しの開始時刻。例：`08:00`。時刻は正時または 30 分でなければならず、繰り返しの終了時刻より少なくとも 30 分早くなければなりません。説明 `RepeatType` が `Permanent` または `None` の場合、`RepeatStartTime` は空です。 `RepeatType` が `Daily`、`Weekly`、または `Monthly` の場合、このパラメーターは必須です。時刻は HH:mm 形式 (24 時間表記) です。例：`08:00` および `23:30`。	08:00
RepeatEndTime	string	アクセス制御ポリシーのポリシー有効期間の繰り返しの終了時刻。例：`23:30`。時刻は正時または 30 分でなければならず、繰り返しの開始時刻より少なくとも 30 分遅くなければなりません。説明 `RepeatType` が `Permanent` または `None` の場合、`RepeatEndTime` は空です。 `RepeatType` が `Daily`、`Weekly`、または `Monthly` の場合、このパラメーターは必須です。時刻は HH:mm 形式 (24 時間表記) です。例：`08:00` および `23:30`。	23:30
StartTime	integer	アクセス制御ポリシーのポリシー有効期間の開始時刻。値は UNIX タイムスタンプです。時刻は正時または 30 分でなければならず、終了時刻より少なくとも 30 分早くなければなりません。説明 `RepeatType` が `Permanent` の場合、`StartTime` は空です。 `RepeatType` が `None`、`Daily`、`Weekly`、または `Monthly` の場合、このパラメーターは必須です。	1694761200
EndTime	integer	アクセス制御ポリシーのポリシー有効期間の終了時刻。値は UNIX タイムスタンプです。時刻は正時または 30 分でなければならず、開始時刻より少なくとも 30 分遅くなければなりません。説明 `RepeatType` が `Permanent` の場合、`EndTime` は空です。 `RepeatType` が `None`、`Daily`、`Weekly`、または `Monthly` の場合、このパラメーターは必須です。	1694764800
DomainResolveType	string	アクセス制御ポリシーのドメイン名解決メソッド。有効値： FQDN：FQDN ベース DNS：ダイナミック DNS FQDN_AND_DNS：FQDN とダイナミック DNS	FQDN

例

成功レスポンス

JSONJSON

{
  "PageNo": "1",
  "PageSize": "10",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****",
  "TotalCount": "100",
  "Policys": [
    {
      "Direction": "in",
      "Order": 1,
      "SourceType": "net",
      "ApplicationName": "HTTP",
      "HitTimes": 100,
      "Description": "test",
      "SourceGroupType": "ip",
      "DnsResultTime": 1579261141,
      "DnsResult": "192.0.XX.XX,192.0.XX.XX",
      "Proto": "TCP",
      "DestinationGroupType": "ip",
      "Destination": "192.0.XX.XX/24",
      "HitLastTime": 1579261141,
      "DestPortGroup": "my_port_group",
      "AclUuid": "00281255-d220-4db1-8f4f-c4df221a****",
      "DestPortType": "port",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net",
      "DestPort": "80",
      "IpVersion": 6,
      "AclAction": "accept",
      "Release": "true",
      "ApplicationId": "10***",
      "DestinationGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "DestPortGroupPorts": [
        "80/80"
      ],
      "SourceGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "ApplicationNameList": [
        "HTTP"
      ],
      "SpreadCnt": 10000,
      "CreateTime": 1761062400,
      "ModifyTime": 1761062400,
      "RepeatType": "Permanent",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800,
      "DomainResolveType": "FQDN"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ErrorParametersUid	The aliUid parameter is invalid.
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.
400	ErrorParameterIpVersion	The IP version is invalid.
400	ErrorParametersDirection	The direction is invalid.
400	ErrorDBSelect	An error occurred while querying database.
400	ErrorUnmarshalJSON	An error occurred while parsing JSON.
400	ErrorUUIDNew	The UUID is invalid.
400	ErrorParametersAppId	The AppId parameter is incorrect.
400	ErrorParametersSource	The source is invalid.
400	ErrorDomainResolve	An error occurred while resolving the domain.
400	ErrorParametersDestination	The Destination parameter is invalid.
400	ErrorParametersProto	The protocol is invalid.
400	ErrorParametersDestPort	The dst_port is invalid.
400	ErrorParametersAction	The action is invalid.
400	ErrorParameters	Parameters error.
400	ErrorMarshalJSON	An error occurred while encoding JSON.
400	ErrorParametersAclUuid	Specified parameter AclUuid is not valid.

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

変更履歴

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