All Products
Search

This Product

    Cloud Firewall:DescribePolicyPriorUsed

    Document Center

    Cloud Firewall:DescribePolicyPriorUsed

    Last Updated:Sep 02, 2024

    Queries the priority range of access control policies.

    Operation description

    You can call this operation to query the priority range of the access control policies that match specific query conditions.

    Limits

    You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    yundun-cloudfirewall:DescribePolicyPriorUsedget
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    SourceIpdeprecatedstringNo

    The source IP address of the request.

    		192.0.XX.XX
    LangstringNo

    The language of the content within the request and response.

    Valid values:

    • zh (default)
    • en
    		zh
    DirectionstringYes

    The direction of the traffic to which the access control policy applies.

    Valid values:

    • in: inbound.
    • out: outbound.
    		in
    IpVersionstringNo

    The IP version of the asset that is protected by Cloud Firewall.

    Valid values:

    • 4 (default): IPv4.
    • 6: IPv6.
    		6

    Response parameters

    ParameterTypeDescriptionExample
    object
    Endinteger

    The lowest priority of existing access control policies.

    Note The value -1 indicates the lowest priority.
    		150
    Startinteger

    The highest priority of existing access control policies.

    Note The value 0 indicates the highest priority.
    		-1
    RequestIdstring

    The request ID.

    		CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

    Examples

    Sample success responses

    JSONformat

    {
  "End": 150,
  "Start": -1,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ErrorParameterIpVersionThe IP version is invalid.The IP version is invalid.
    400ErrorParametersDirectionThe direction is invalid.The direction is invalid.
    400ErrorParametersUidThe aliUid parameter is invalid.The aliUid parameter is invalid.
    400ErrorDBSelectAn error occurred while querying database.An error occurred while querying database.
    400ErrorParametersUidinvalid aliUid.Invalid Aliuid.
    400ErrorUUIDNewThe UUID is invalid.The UUID is invalid.
    400ErrorParametersAppIdThe AppId parameter is incorrect.The AppId parameter is invalid.
    400ErrorParametersSourceThe source is invalid.The source is invalid.
    400ErrorDomainResolveA domain resolution error occurred.An error occurred while resolving the domain.
    400ErrorParametersDestinationThe destination is invalid.The destination is invalid.
    400ErrorParametersProtoThe protocol is invalid.The protocol is invalid.
    400ErrorParametersDestPortThe dst_port is invalid.The dst_port is invalid.
    400ErrorParametersActionThe action is invalid.The action is invalid.
    400ErrorParametersParameters error.Parameter error.
    400ErrorMarshalJSONAn error occurred while encoding JSON.An error occurred while encoding JSON.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-07-31The Error code has changedView Change Details