指定された VPC ファイアウォールのすべてのアクセス制御ポリシーを照会します。
操作説明
この操作を呼び出して、VPC ファイアウォールのアクセス制御ポリシーをクエリできます。VPC ファイアウォールは、Cloud Enterprise Network (CEN) インスタンスを介して接続された VPC 間のトラフィックと、Express Connect 回線を介して接続された VPC 間のトラフィックに対して、異なるアクセス制御ポリシーを使用します。
QPS 制限
1 ユーザーあたりの 1 秒あたりのクエリ数 (QPS) 制限は 10 です。制限を超えると、API 呼び出しはスロットリングされます。スロットリングはビジネスに影響を与える可能性があります。制限を超えないように API 呼び出しを計画してください。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Lang |
string |
任意 |
リクエストと応答の言語。 有効な値:
|
zh |
| VpcFirewallId |
string |
必須 |
VPC ファイアウォールのインスタンス ID。
説明
DescribeVpcFirewallAclGroupList 操作を呼び出して ID を取得できます。 |
vfw-a42bbb7b887148c9**** |
| CurrentPage |
string |
任意 |
返すページ番号。このパラメーターはページ分割クエリに使用されます。 |
1 |
| PageSize |
string |
任意 |
各ページで返す VPC ファイアウォールのアクセス制御ポリシーの数。このパラメーターはページ分割クエリに使用されます。 最大値は 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 |
任意 |
Cloud Firewall がトラフィックに対して実行する操作。有効な値:
説明
このパラメーターを設定しない場合、すべての操作がクエリされます。 |
accept |
| MemberUid |
string |
任意 |
メンバーアカウントの 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 |
アクセス制御ポリシーでサポートされるアプリケーションタイプ。代わりに ApplicationNameList を使用してください。有効な値:
|
HTTP |
| AclUuid |
string |
アクセス制御ポリシーの一意の ID。 |
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 |
Cloud Firewall がトラフィックに対して実行する操作。有効な値:
|
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 |
アクセス制御ポリシーのソースアドレス帳の詳細。 |
|
|
string |
ソースアドレス帳内の CIDR ブロックのリスト。 |
["192.0.XX.XX/24", "198.51.XX.XX/32"] |
|
| MemberUid |
string |
メンバーアカウントの UID。 |
258039427902**** |
| Release |
string |
アクセス制御ポリシーのステータス。ポリシーは作成後にデフォルトで有効になります。有効な値:
|
true |
| SourceGroupType |
string |
ソースアドレス帳のタイプ。値は ip に固定されています。これは、1 つ以上の CIDR ブロックを含む IP アドレス帳を示します。 |
ip |
| DestinationGroupType |
string |
宛先アドレス帳のタイプ。有効な値:
|
ip |
| HitLastTime |
integer |
最後のヒットのタイムスタンプ。この値は UNIX タイムスタンプです。単位:秒。 |
1579261141 |
| ModifyTime |
integer |
ポリシーが最後に変更された時刻。この値は UNIX タイムスタンプです。単位:秒。 |
1761062400 |
| SpreadCnt |
integer |
占有されているポリシースペックの数。これは、各ポリシーが占有するスペックの累積値です。 単一のポリシーが占有するスペック数 = ソース CIDR ブロック数 × 宛先アドレス数 (CIDR ブロックまたはドメイン名) × アプリケーション数 × ポート範囲数。 |
10,000 |
| CreateTime |
integer |
ポリシーが作成された時刻。この値は UNIX タイムスタンプです。単位:秒。 |
1761062400 |
| ApplicationNameList |
array |
アプリケーション名のリスト。 |
|
|
string |
アクセス制御ポリシーでサポートされるアプリケーションタイプのリスト。有効な値:
|
[ "HTTPS", "SMTPS", "SSL" ] |
|
| RepeatType |
string |
ポリシーの繰り返しタイプ。有効な値:
列挙値:
|
Permanent |
| RepeatDays |
array |
ポリシーが有効な曜日または日付。
説明
**RepeatType** が `Weekly` の場合、配列に重複した値を含めることはできません。
説明
**RepeatType** が `Monthly` の場合、配列に重複した値を含めることはできません。 |
|
|
integer |
ポリシーが有効な日。 説明
**RepeatType** が `Weekly` の場合、有効な値は 0 から 6 です。週は日曜日から始まります。 **RepeatType** が `Monthly` の場合、有効な値は 1 から 31 です。 |
1 |
|
| RepeatStartTime |
string |
繰り返しの開始時刻。例:08:00。時刻は正時または 30 分単位で、終了時刻より少なくとも 30 分早くする必要があります。 説明
**RepeatType** が `Permanent` または `None` の場合、このパラメーターは空です。**RepeatType** が `Daily`、`Weekly`、または `Monthly` の場合、このパラメーターを設定する必要があります。 |
08:00 |
| RepeatEndTime |
string |
繰り返しの終了時刻。例:23:30。時刻は正時または 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 |
例
成功レスポンス
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": 0,
"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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。