DescribeControlPolicy - - Alibaba Cloud ドキュメントセンター

すべてのアクセスコントロールポリシーに関する情報を取得します。

操作説明

この操作は、アクセスコントロールポリシーをページ単位で取得します。

QPS 制限

1 人のユーザーあたりの 1 秒あたりのクエリ数 (QPS) の上限は 10 です。この上限を超えると、API 呼び出しはスロットリングされます。これはビジネスに影響を与える可能性があります。それに応じて呼び出しを計画してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Lang	string	任意	応答メッセージの言語。有効な値: zh (デフォルト): 中国語 en: 英語	zh
Lang	string	任意	応答メッセージの言語。有効な値: zh (デフォルト): 中国語 en: 英語	zh
Direction	string	任意	アクセスコントロールポリシーのトラフィックの方向。有効な値: in: インバウンドトラフィック out: アウトバウンドトラフィック	in
CurrentPage	string	必須	ページ番号。デフォルト値: 1。	1
PageSize	string	必須	1 ページあたりのエントリ数。	10
Source	string	任意	アクセスコントロールポリシーのソースアドレス。あいまい一致がサポートされています。このパラメーターの値は、SourceType パラメーターの値によって異なります。 SourceType が `net` に設定されている場合、このパラメーターの値は CIDR ブロックです。例: 192.0.XX.XX/24。 SourceType が `group` に設定されている場合、このパラメーターの値はソースアドレス帳の名前です。例: db_group。 SourceType が `location` に設定されている場合、このパラメーターの値はソースの場所です。例: 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` に設定されている場合、このパラメーターの値は場所です。例: ["BJ11", "ZB"]。ロケーションコードの詳細については、「AddControlPolicy」をご参照ください。説明このパラメーターを指定しない場合、ポリシーは宛先アドレスでフィルターされません。	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	6
RepeatType	string	任意	ポリシーの繰り返し頻度タイプ。有効な値: Permanent (デフォルト): ポリシーは常に有効です。 None: ポリシーは特定の期間有効です。 Daily: ポリシーは毎日有効です。 Weekly: ポリシーは毎週有効です。 Monthly: ポリシーは毎月有効です。列挙値: Daily : 毎日 Monthly : 毎月 Permanent : ポリシーは常に有効です。 Weekly : 毎週 None : ポリシーは特定の期間有効です。	Permanent

レスポンスフィールド

フィールド	型	説明	例
	object
PageNo	string	ページ番号。	1
PageSize	string	1 ページあたりのエントリ数。	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 ブロックを含むアドレス帳。 tag: 1 つ以上のタグを持つ ECS インスタンスの IP アドレスを含む ECS タグアドレス帳。 domain: 1 つ以上のドメイン名を含むドメイン名アドレス帳。 threat: 1 つ以上の悪意のある IP アドレスまたはドメイン名を含む脅威インテリジェンスアドレス帳。 backsrc: 1 つ以上の Anti-DDoS または WAF インスタンスのオリジン IP アドレスを含むオリジン IP アドレス帳。	ip
DnsResultTime	integer	ドメイン名が解決された時刻。これは秒単位の 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 ブロックを含むアドレス帳。 tag: 1 つ以上のタグを持つ ECS インスタンスの IP アドレスを含む ECS タグアドレス帳。 domain: 1 つ以上のドメイン名を含むドメイン名アドレス帳。 threat: 1 つ以上の悪意のある IP アドレスまたはドメイン名を含む脅威インテリジェンスアドレス帳。 backsrc: 1 つ以上の Anti-DDoS または WAF インスタンスのオリジン IP アドレスを含むオリジン IP アドレス帳。	ip
Destination	string	宛先アドレス。このパラメーターの値は、`DestinationType` の値によって異なります。有効な値: DestinationType が net に設定されている場合、このパラメーターの値は CIDR ブロックです。例: 192.0.XX.XX/24。 DestinationType が domain に設定されている場合、このパラメーターの値はドメイン名です。例: aliyuncs.com。 DestinationType が group に設定されている場合、このパラメーターの値はアドレス帳の名前です。例: db_group。 DestinationType が location に設定されている場合、このパラメーターの値は場所です。例: ["BJ11", "ZB"]。ロケーションコードの詳細については、「AddControlPolicy」をご参照ください。	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` に設定されている場合、このパラメーターの値は場所です。例: ["BJ11", "ZB"]。ロケーションコードの詳細については、「AddControlPolicy」をご参照ください。	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	ポリシーによって消費されるクォータ。単一のポリシーによって消費されるクォータは、次の数式を使用して計算されます: ソースアドレスの数 × 宛先アドレスの数 × ポート範囲の数 × アプリケーションの数。	10000
CreateTime	integer	ポリシーが作成された時刻。	1761062400
ModifyTime	integer	ポリシーが最後に変更された時刻。	1761062400
RepeatType	string	ポリシーの繰り返し頻度タイプ。有効な値: Permanent (デフォルト): ポリシーは常に有効です。 None: ポリシーは特定の期間有効です。 Daily: ポリシーは毎日有効です。 Weekly: ポリシーは毎週有効です。 Monthly: ポリシーは毎月有効です。列挙値: Daily : ポリシーは毎日有効です。 Monthly : ポリシーは毎月有効です。 Permanent : ポリシーは常に有効です。 Weekly : ポリシーは毎週有効です。 None : ポリシーは特定の期間有効です。	Permanent
RepeatDays	array	ポリシーが繰り返し有効になる曜日または月の日。 RepeatType が `Permanent`、`None`、または `Daily` に設定されている場合、このパラメーターは空の配列です。例: [] RepeatType が Weekly に設定されている場合、このパラメーターは空ではありません。例: [0, 6] 説明 `RepeatType` が `Weekly` に設定されている場合、配列内の値を繰り返すことはできません。 RepeatType が `Monthly` に設定されている場合、このパラメーターは空ではありません。例: [1, 31] 説明 `RepeatType` が `Monthly` に設定されている場合、配列内の値を繰り返すことはできません。
	integer	週または月の日。説明 RepeatType が Weekly に設定されている場合、有効な値は 0 から 6 です。週は日曜日から始まります。 RepeatType が Monthly に設定されている場合、有効な値は 1 から 31 です。	1
RepeatStartTime	string	繰り返しの開始時刻。時刻は HH:mm 形式です。時刻は正時または 30 分で、終了時刻の少なくとも 30 分前でなければなりません。説明 RepeatType が Permanent または None に設定されている場合、このパラメーターは空です。RepeatType が Daily、Weekly、または Monthly に設定されている場合は、このパラメーターを設定する必要があります。	08:00
RepeatEndTime	string	繰り返しの終了時刻。時刻は HH:mm 形式です。時刻は正時または 30 分で、開始時刻の少なくとも 30 分後でなければなりません。説明 RepeatType が Permanent または None に設定されている場合、このパラメーターは空です。RepeatType が Daily、Weekly、または Monthly に設定されている場合は、このパラメーターを設定する必要があります。	23:30
StartTime	integer	ポリシーの有効期間の開始時刻。これは UNIX タイムスタンプです。時刻は正時または 30 分で、終了時刻の少なくとも 30 分前でなければなりません。説明 RepeatType が Permanent に設定されている場合、このパラメーターは空です。RepeatType が None、Daily、Weekly、または Monthly に設定されている場合は、このパラメーターを設定する必要があります。	1694761200
EndTime	integer	ポリシーの有効期間の終了時刻。これは UNIX タイムスタンプです。時刻は正時または 30 分で、開始時刻の少なくとも 30 分後でなければなりません。説明 RepeatType が Permanent に設定されている場合、このパラメーターは空です。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.

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

変更履歴

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