すべてのプロダクト
Search

このプロダクト

    Cloud Firewall:DescribeControlPolicy

    ドキュメントセンター

    Cloud Firewall:DescribeControlPolicy

    最終更新日:Aug 02, 2026

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

    操作説明

    この操作は、通常、アクセスのコントロールポリシー情報のページングクエリに使用されます。

    今すぐお試しください

    この 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
    Direction

    string

    任意

    アクセスのコントロールポリシーによってコントロールされるトラフィックの方向。有効な値: in (インバウンド) または out (アウトバウンド)。Direction と AclUuid の少なくとも一方を指定する必要があります。AclUuid が指定されていない場合は、空でない Direction を指定する必要があります。指定しない場合、ErrorParametersDirection エラーが返されます。

    列挙値:

    • in :

      Inbound。外部ソースから内部リソースへのトラフィックを示します。

    • out :

      Outbound。内部リソースから外部送信先へのトラフィックを示します。

    in
    CurrentPage

    string

    必須

    ページングクエリで表示される現在のページのページ番号。

    1
    PageSize

    string

    必須

    ページングクエリで表示される 1 ページあたりのエントリの最大値。

    10
    Source

    string

    任意

    アクセスのコントロールポリシーのソースアドレス。あいまいクエリがサポートされています。値は SourceType (ソースタイプ) によって異なります。

    192.0.XX.XX
    Destination

    string

    任意

    アクセスのコントロールポリシーの送信先アドレス。あいまいクエリがサポートされています。値は DestinationType (送信先タイプ) によって異なります。

    192.0.XX.XX
    Description

    string

    任意

    アクセスのコントロールポリシーの説明。あいまいクエリがサポートされています。

    オフィスネットワークセグメントへのアクセスを許可
    Proto

    string

    任意

    アクセスのコントロールポリシーにおけるトラフィックのプロトコルの種類。有効な値:

    TCP
    AclAction

    string

    任意

    Cloud Firewall がアクセスのコントロールポリシーのトラフィックに対して実行する操作。有効な値:

    accept
    Release

    string

    任意

    アクセスのコントロールポリシーの有効化ステータス。有効な値:

    true
    AclUuid

    string

    任意

    アクセスのコントロールポリシーの一意の ID。AclUuid と Direction の少なくとも一方を指定する必要があります。AclUuid を指定すると、ID でポリシーをクエリできます。

    00281255-d220-4db1-8f4f-c4df221a****
    IpVersion

    string

    任意

    サポートされている IP アドレスバージョン。有効な値:

    列挙値:

    • 4 :

      IPv4

    • 6 :

      IPv6

    6
    RepeatType

    string

    任意

    アクセスのコントロールポリシーのポリシー有効期間の繰り返し頻度のタイプ。有効な値:

    列挙値:

    • Daily :

      毎日。

    • Monthly :

      毎月。

    • Permanent :

      常時。

    • Weekly :

      毎週。

    • None :

      指定された 1 回の期間。

    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
    Order

    integer

    アクセスコントロールポリシーの優先度。

    1
    SourceType

    string

    アクセスコントロールポリシーのソースアドレスのタイプ。有効な値:

    net
    ApplicationName

    string

    アクセスコントロールポリシーでサポートされているアプリケーションタイプ。ApplicationNameList の使用を推奨します。有効な値:

    HTTP
    HitTimes

    integer

    アクセスコントロールポリシーのヒット数。

    100
    Description

    string

    アクセスコントロールポリシーの説明。

    オフィスネットワークセグメントへのアクセスを許可
    SourceGroupType

    string

    アクセスコントロールポリシーのソースアドレス帳のタイプ。有効な値:

    ip
    DnsResultTime

    integer

    DNS 名前解決のタイムスタンプ。値は秒単位の UNIX タイムスタンプです。

    1579261141
    DnsResult deprecated

    string

    DNS 名前解決の結果。

    192.0.XX.XX,192.0.XX.XX
    Proto

    string

    アクセスコントロールポリシーにおけるトラフィックのセキュリティプロトコルの種類。有効な値:

    TCP
    DestinationGroupType

    string

    アクセスコントロールポリシーの送信先アドレス帳のタイプ。有効な値:

    ip
    Destination

    string

    アクセスコントロールポリシーの送信先アドレス。値は DestinationType (送信先タイプ) によって異なります。有効な値:

    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
    Source

    string

    アクセスコントロールポリシーのソースアドレス。有効な値:

    192.0.XX.XX/24
    DestinationType

    string

    アクセスコントロールポリシーの送信先アドレスのタイプ。有効な値:

    net
    DestPort

    string

    アクセスコントロールポリシーにおけるトラフィックの宛先ポート。

    80
    IpVersion

    integer

    サポートされている IP アドレスバージョン。有効な値:

    6
    AclAction

    string

    Cloud Firewall がアクセスのコントロールポリシーのトラフィックに対して実行する操作。有効な値:

    accept
    Release

    string

    アクセスコントロールポリシーの有効化ステータス。ポリシーは作成後、デフォルトで有効になります。有効な値:

    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

    アクセスコントロールポリシーでサポートされているアプリケーションタイプのリスト。有効な値:

    HTTP
    SpreadCnt

    integer

    アクセスコントロールポリシーによって消費されるクォータ単位数。各ポリシーによって消費されるクォータ単位の累積数です。

    10000
    CreateTime

    integer

    ポリシーが作成された時間。値は秒単位の UNIX タイムスタンプであり、1970 年 1 月 1 日 (協定世界時 (UTC)) からの経過秒数です。

    1761062400
    ModifyTime

    integer

    ポリシーが最後に変更済みの時間。値は秒単位の UNIX タイムスタンプであり、1970 年 1 月 1 日 (協定世界時 (UTC)) からの経過秒数です。

    1761062400
    RepeatType

    string

    アクセスのコントロールポリシーのポリシー有効期間の繰り返し頻度のタイプ。有効な値:

    列挙値:

    • Daily :

      毎日。

    • Monthly :

      毎月。

    • Permanent :

      常時。

    • Weekly :

      毎週。

    • None :

      指定された 1 回の期間。

    Permanent
    RepeatDays

    array

    アクセスコントロールポリシーのポリシー有効期間の繰り返し頻度のコレクション。

    integer

    アクセスコントロールポリシーのポリシー有効期間の繰り返し頻度。

    1
    RepeatStartTime

    string

    アクセスコントロールポリシーのポリシー有効期間の繰り返し頻度の開始時刻。例: 08:00。値は正時または 30 分単位である必要があり、繰り返し終了時刻より少なくとも 30 分前でなければなりません。

    08:00
    RepeatEndTime

    string

    アクセスコントロールポリシーのポリシー有効期間の繰り返し頻度の終了時間。例: 23:30。値は正時または 30 分単位である必要があり、繰り返し開始時刻より少なくとも 30 分後でなければなりません。

    23:30
    StartTime

    integer

    アクセスコントロールポリシーのポリシー有効期間の開始時刻。値は秒単位の UNIX タイムスタンプです。値は正時または 30 分単位である必要があり、終了時刻より少なくとも 30 分前でなければなりません。

    1694761200
    EndTime

    integer

    アクセスコントロールポリシーのポリシー有効期間の終了時間。値は秒単位の UNIX タイムスタンプです。値は正時または 30 分単位である必要があり、開始時刻より少なくとも 30 分後でなければなりません。

    1694764800
    DomainResolveType

    string

    アクセスコントロールポリシーのドメイン名解決メソッド。有効な値:

    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.

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

    変更履歴

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