特定の VPC 境界ファイアウォールのアクセス制御ポリシーをすべて取得します。
操作説明
この操作では、VPC ファイアウォールのアクセスコントロールポリシーを照会します。VPC ファイアウォールは、Cloud Enterprise Network (CEN) または Express Connect 経由で接続された 2 つの VPC 間のトラフィックを保護するために、異なるアクセスコントロールポリシーを使用します。
QPS 制限
この操作の QPS 制限は、アカウントあたり 1 秒間に 10 リクエストです。この制限を超えると、API コールはスロットリングされます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
yundun-cloudfirewall:DescribeVpcFirewallControlPolicy |
get |
*VpcFirewallControlPolicy
*VpcFirewall
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Lang |
string |
任意 |
リクエストとレスポンスの言語。 有効な値:
|
zh |
| VpcFirewallId |
string |
必須 |
VPC 境界ファイアウォールのインスタンス ID。次のいずれかの ID を指定できます。
説明
DescribeVpcFirewallList オペレーションを呼び出して、ID を取得できます。 |
vfw-a42bbb7b887148c9**** |
| CurrentPage |
string |
任意 |
ページ番号。 |
1 |
| PageSize |
string |
任意 |
ページあたりのエントリー数。 最大値: 50。 |
10 |
| Source |
string |
任意 |
アクセス制御ポリシーのソースアドレス。あいまい一致検索に対応しています。 説明
値には CIDR ブロックまたはアドレス帳を指定できます。 |
192.0.XX.XX/24 |
| Destination |
string |
任意 |
アクセス制御ポリシーの宛先アドレス。あいまい一致検索に対応しています。 説明
値には CIDR ブロック、ドメイン名、またはアドレス帳を指定できます。 |
192.0.XX.XX/24 |
| Description |
string |
任意 |
アクセス制御ポリシーの説明。あいまい一致検索に対応しています。 |
test |
| Proto |
string |
任意 |
アクセス制御ポリシーのプロトコルタイプ。有効な値:
説明
このパラメーターを設定しない場合、すべてのプロトコルのポリシーが検索されます。 |
TCP |
| AclAction |
string |
任意 |
トラフィックに対するアクション。有効な値:
説明
このパラメーターを設定しない場合、すべてのアクションのポリシーが検索されます。 |
accept |
| MemberUid |
string |
任意 |
Alibaba Cloud アカウントで管理されているメンバーの UID。 |
258039427902**** |
| AclUuid |
string |
任意 |
アクセス制御ポリシーの一意の ID。 |
4037fbf7-3e39-4634-92a4-d0155247**** |
| Release |
string |
任意 |
アクセス制御ポリシーのステータス。有効な値:
|
true |
| RepeatType |
string |
任意 |
アクセス制御ポリシーの繰り返しタイプ。有効な値:
列挙値:
|
Permanent |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| TotalCount |
string |
VPC ファイアウォールのアクセス制御ポリシーの総数です。 |
20 |
| RequestId |
string |
リクエスト ID です。 |
CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D |
| Policys |
array<object> |
VPC ファイアウォールのアクセス制御ポリシーです。 |
|
|
object |
|||
| Destination |
string |
アクセス制御ポリシーの宛先アドレスです。 値は
|
192.0.XX.XX/24 |
| Order |
integer |
アクセス制御ポリシーの優先度です。1 から始まり、値が小さいほど優先度が高くなります。 |
1 |
| DestPortGroup |
string |
宛先ポートアドレス帳の名前です。 |
my_port_group |
| SourceType |
string |
送信元アドレスのタイプです。 有効な値:
|
net |
| ApplicationName |
string |
アプリケーションタイプです。 代わりに
|
HTTP |
| AclUuid |
string |
アクセス制御ポリシーの一意の識別子です。 |
4037fbf7-3e39-4634-92a4-d0155247**** |
| DestPortType |
string |
宛先ポートのタイプです。 有効な値:
|
port |
| Source |
string |
アクセス制御ポリシーの送信元アドレスです。 値は
|
192.0.XX.XX/24 |
| DestinationType |
string |
宛先アドレスのタイプです。 有効な値:
|
net |
| HitTimes |
integer |
ポリシーのヒット数です。 |
100 |
| DestPort |
string |
宛先ポートです。 |
80 |
| Description |
string |
ポリシーの説明です。 |
test |
| AclAction |
string |
アクセス制御ポリシーに一致するトラフィックに対して実行するアクションです。 有効な値:
|
accept |
| ApplicationId |
string |
アプリケーションの ID です。 |
10** |
| Proto |
string |
プロトコルタイプです。 有効な値:
|
TCP |
| DestinationGroupCidrs |
array |
宛先アドレス帳の CIDR ブロックのリストです。 |
|
|
string |
リストに含まれる CIDR ブロックです。 |
["192.0.XX.XX/24", "192.0.XX.XX/32"] |
|
| DestPortGroupPorts |
array |
宛先ポートアドレス帳のポートのリストです。 |
|
|
string |
リストに含まれるポートです。 |
[80,443] |
|
| SourceGroupCidrs |
array |
送信元アドレス帳の CIDR ブロックのリストです。 |
|
|
string |
リストに含まれる CIDR ブロックです。 |
["192.0.XX.XX/24", "198.51.XX.XX/32"] |
|
| MemberUid |
string |
メンバーアカウントの UID です。 |
258039427902**** |
| Release |
string |
アクセス制御ポリシーの有効ステータスです。 ポリシーは作成後にデフォルトで有効になります。 有効な値:
|
true |
| SourceGroupType |
string |
送信元アドレス帳のタイプです。 値は常に IP で、IP アドレスまたは CIDR ブロックを含むアドレス帳を示します。 |
ip |
| DestinationGroupType |
string |
宛先アドレス帳のタイプです。 有効な値:
|
ip |
| HitLastTime |
integer |
ポリシーが最後にヒットしたときの UNIX タイムスタンプ (秒単位) です。 |
1579261141 |
| ModifyTime |
integer |
ポリシーが最後に変更されたときの UNIX タイムスタンプ (秒単位) です。 |
1761062400 |
| SpreadCnt |
integer |
アクセス制御ポリシーが消費するルールキャパシティユニットの数です。 これは、送信元アドレスの数 × 宛先アドレスの数 × アプリケーションの数 × ポート範囲の数として計算されます。 |
10000 |
| CreateTime |
integer |
ポリシーが作成されたときの UNIX タイムスタンプ (秒単位) です。 |
1761062400 |
| ApplicationNameList |
array |
アプリケーション名のリストです。 |
|
|
string |
アプリケーションタイプです。 有効な値:
|
[ "HTTPS", "SMTPS", "SSL" ] |
|
| RepeatType |
string |
ポリシーの有効期間の繰り返しタイプです。 有効な値:
列挙値:
|
Permanent |
| RepeatDays |
array |
ポリシーが繰り返される曜日または日付です。
説明
説明
|
|
|
integer |
ポリシーが繰り返される日です。 説明
有効な値は、繰り返しタイプが |
1 |
|
| RepeatStartTime |
string |
繰り返しの開始時刻です。 時刻は 説明
このパラメーターは、 |
08:00 |
| RepeatEndTime |
string |
繰り返しの終了時刻です。 時刻は 説明
このパラメーターは、 |
23:30 |
| StartTime |
integer |
ポリシーの有効期間の開始を示す UNIX タイムスタンプ (秒単位) です。 時刻は正時または 30 分単位とし、終了時刻の少なくとも 30 分前である必要があります。 説明
このパラメーターは、 |
1694761200 |
| EndTime |
integer |
ポリシーの有効期間の終了を示す UNIX タイムスタンプ (秒単位) です。 時刻は正時または 30 分単位とし、開始時刻の少なくとも 30 分後である必要があります。 説明
このパラメーターは、 |
1694764800 |
| DomainResolveType |
string |
ドメイン名解決モードです。 有効な値:
|
FQDN |
例
成功レスポンス
JSONJSON
{
"TotalCount": "20",
"RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
"Policys": [
{
"Destination": "192.0.XX.XX/24",
"Order": 1,
"DestPortGroup": "my_port_group",
"SourceType": "net",
"ApplicationName": "HTTP",
"AclUuid": "4037fbf7-3e39-4634-92a4-d0155247****",
"DestPortType": "port",
"Source": "192.0.XX.XX/24",
"DestinationType": "net",
"HitTimes": 100,
"DestPort": "80",
"Description": "test",
"AclAction": "accept",
"ApplicationId": "10**",
"Proto": "TCP",
"DestinationGroupCidrs": [
"[\"192.0.XX.XX/24\", \"192.0.XX.XX/32\"]"
],
"DestPortGroupPorts": [
"[80,443]"
],
"SourceGroupCidrs": [
"[\"192.0.XX.XX/24\", \"198.51.XX.XX/32\"]"
],
"MemberUid": "258039427902****",
"Release": "true",
"SourceGroupType": "ip",
"DestinationGroupType": "ip",
"HitLastTime": 1579261141,
"ModifyTime": 1761062400,
"SpreadCnt": 10000,
"CreateTime": 1761062400,
"ApplicationNameList": [
"[\n \"HTTPS\", \n \"SMTPS\", \n \"SSL\"\n]"
],
"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 | ErrorDBSelect | An error occurred while querying database. | |
| 400 | ErrorUUIDNew | The UUID is invalid. | |
| 400 | ErrorParametersAppId | The appId is invalid. | |
| 400 | ErrorParameterIpVersion | The IP version is invalid. | |
| 400 | ErrorParametersDirection | The direction is invalid. | |
| 400 | ErrorParametersSource | The source is invalid. | |
| 400 | ErrorDomainResolve | A domain resolution error occurred. | |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。