UpdateAclCheckDetailStatus

更新时间:
复制 MD 格式

Modify the status of ACL check details.

Operation description

QPS Limit

The single-user QPS limit for this API is 10 calls per second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call this API appropriately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:UpdateAclCheckDetailStatus

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Lang

string

No

The language.

Valid values:

  • en :

    English

  • zh :

    Chinese (default)

zh

TaskId

string

Yes

The ACL check task ID.

task-c92d4544ef7b6a42

Uuid

string

Yes

The unique identifier ID of the ACL policy in the ACL check details.

bbbb43c9-a931-4d89-9939-86d509139a20

Status

string

Yes

The modified status.

Valid values:

  • Pending :

    Pending

  • Ignored :

    Ignored

  • Processed :

    Processed

Pending

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

850A84D6************00090125EEB1

CheckRecord

object

The ACL check record.

Acls

array<object>

The list of ACL check results.

array<object>

The ACL check result.

Acl

object

The ACL check result.

Direction

string

The traffic direction for the access control policy.

Valid values:

  • in: Inbound traffic.

  • out: Outbound traffic.

in

Order

integer

The priority of the access control policy.

The priority value starts from 1. A smaller value indicates a higher priority.

1

SourceType

string

The type of the source address in the policy. Valid values:

  • net: A source CIDR block.

  • group: A source address book.

  • location: A source region.

net

ApplicationName

string

The application types supported by the access control policy. Valid values:

  • FTP

  • HTTP

  • HTTPS

  • Memcache

  • MongoDB

  • MQTT

  • MySQL

  • RDP

  • Redis

  • SMTP

  • SMTPS

  • SSH

  • SSL_No_Cert

  • SSL

  • VNC

Note

The available application types depend on the Proto value. When Proto is TCP, all the above application types are supported. If both ApplicationName and ApplicationNameList are specified, ApplicationNameList takes precedence.

ANY

HitTimes

integer

The hit count of the policy.

1

Description

string

The description of the policy.

test_policy

SourceGroupType

string

The type of the source address book in the policy. Valid values:

  • ip: An address book containing IP addresses or CIDR blocks.

  • tag: An address book containing the IP addresses of ECS instances that match specified tags.

  • domain: An address book containing one or more domain names.

  • threat: A threat intelligence address book containing malicious IP addresses or domain names.

  • backsrc: A back-to-source address book containing the back-to-source addresses of Anti-DDoS or WAF instances.

ip

DnsResultTime

integer

The UNIX timestamp, in seconds, of the DNS resolution.

1579261141

DnsResult

string

The result of the DNS resolution.

192.168.0.1/32

Proto

string

The protocol type of traffic in the access control policy. Valid values:

  • TCP

  • UDP

  • ICMP

  • ANY: All protocol types.

Note

If this parameter is not specified, all protocol types are queried.

ANY

DestinationGroupType

string

The type of the destination address book in the policy. Valid values:

  • ip: An address book containing IP addresses or CIDR blocks.

  • tag: An address book containing the IP addresses of ECS instances that match specified tags.

  • domain: An address book containing one or more domain names.

  • threat: A threat intelligence address book containing malicious IP addresses or domain names.

  • backsrc: A back-to-source address book containing the back-to-source addresses of Anti-DDoS or WAF instances.

domain

Destination

string

The destination address in the access control policy. This parameter supports fuzzy search. The value of this parameter varies based on the value of DestinationType.

  • If DestinationType is set tonet, the value of this parameter is a CIDR block. Example: 10.0.3.0/24.

  • If DestinationType is set todomain, the value of this parameter is a domain name. Example: aliyun.

  • If DestinationType is set togroup, the value of this parameter is the name of an address book. Example: db_group.

  • If DestinationType is set tolocation, the value of this parameter is a location. For more information about location codes, see AddControlPolicy. Example: ["BJ11", "ZB"].

Note

If this parameter is not specified, all types of destination addresses are queried.

kms.cn-shanghai.aliyuncs.com

HitLastTime

integer

The UNIX timestamp, in seconds, of the last policy hit.

1579261141

DestPortGroup

string

The type of the destination port for traffic in the policy. Valid values:

  • port: A single port or a port range.

  • group: A port address book.

port

AclUuid

string

The UUID of the policy.

1e8ed1b2-cebc-4b95-a9cc-0cb7ce2c0c2c

DestPortType

string

The type of the destination port in the policy. Valid values:

  • port: A single port or a port range.

  • group: A port address book.

port

Source

string

The source address in the policy.

Valid values:

  • If SourceType is set tonet, the value of Source is a source CIDR block.

    Example: 10.2.4.0/24

  • If SourceType is set togroup, the value of Source is the name of a source address book.

    Example: db_group

10.71.94.24

DestinationType

string

The type of the destination address in the policy.

Valid values:

  • net: A destination CIDR block.

  • group: A destination address book.

  • domain: A destination domain name.

group

DestPort

string

The destination port for traffic in the policy.

22/22

IpVersion

integer

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

  • 4: IPv4 (default).

  • 6: IPv6.

4

AclAction

string

The action performed on traffic that matches the policy. Valid values:

  • accept: Allows the traffic.

  • drop: Denies the traffic.

  • log: Monitors the traffic.

log

Release

string

Indicates whether the policy is enabled. Valid values:

  • true: The policy is enabled.

  • false: The policy is disabled.

true

ApplicationId

string

The application ID for traffic in the policy.

HTTP

DestinationGroupCidrs

array

A list of CIDR blocks in the destination address book of the policy.

string

A CIDR block in the destination address book.

192.168.0.1/32

DestPortGroupPorts

array

A list of ports in the destination port address book.

string

A port in the destination port address book.

22/22

SourceGroupCidrs

array

A list of CIDR blocks in the source address book of the policy.

string

A CIDR block in the source address book of the policy.

192.168.0.1/32

ApplicationNameList

array

A list of application types that are supported by the policy.

string

An application type supported by the policy.

SSH

SpreadCnt

integer

The number of rule entries that the policy consumes. The number of entries that a single policy consumes is calculated by using the following formula: Number of source CIDR blocks × Number of destination addresses (CIDR blocks, locations, or domain names) × Number of applications × Number of port ranges.

10

CreateTime

integer

The time when the policy was created. The value is a UNIX timestamp. Unit: seconds.

1761062400

ModifyTime

integer

The time when the policy was last modified. The value is a UNIX timestamp. Unit: seconds.

1761062400

RepeatType

string

The recurrence type for the validity period of the policy. Valid values:

  • Permanent: Always.

  • None: A single occurrence.

  • Daily: Daily.

  • Weekly: Weekly.

  • Monthly: Monthly.

None

RepeatDays

array

An array of the days of a week or month on which the policy recurs.

  • If RepeatType is set toPermanent,None, orDaily, RepeatDays is an empty array. Example: []

  • If RepeatType is set to Weekly, RepeatDays cannot be empty. Example: [0, 6]

Note

If RepeatType is set to Weekly, RepeatDays cannot contain duplicate values.

  • If RepeatType is set toMonthly, RepeatDays cannot be empty. Example: [1, 31]

Note

If RepeatType is set to Monthly, RepeatDays cannot contain duplicate values.

integer

The day of a week or month on which the policy recurs.

  • If RepeatType is set toPermanent,None, orDaily, RepeatDays is an empty array. Example: []

  • If RepeatType is set to Weekly, RepeatDays cannot be empty. Example: [0, 6]

Note

If RepeatType is set to Weekly, RepeatDays cannot contain duplicate values.

  • If RepeatType is set toMonthly, RepeatDays cannot be empty. Example: [1, 31]

Note

If RepeatType is set to Monthly, RepeatDays cannot contain duplicate values.

1

RepeatStartTime

string

The recurrence start time in HH:mm format. The time must be on the hour or half-hour and at least 30 minutes before the end time.

Note

This parameter is returned only if RepeatType is Daily, Weekly, or Monthly.

08:00

RepeatEndTime

string

The recurrence end time in HH:mm format. The time must be on the hour or half-hour and at least 30 minutes after the start time.

Note

This parameter is returned only if RepeatType is Daily, Weekly, or Monthly.

23:30

StartTime

integer

The start time of the query. The value is a UNIX timestamp. Unit: seconds.

1736130347

EndTime

integer

The end time of the query. The value is a UNIX timestamp. Unit: seconds.

1752754426

AddressListCount

integer

The number of addresses in the address book.

1

GroupUuid

string

The UUID of the address book.

Note

For more information, see DescribeAddressBook.

5a96a798-9b73-47f7-831e-1d7aa3c987a9

AutoAddTagEcs

integer

Indicates if public IP addresses from new ECS instances with matching tags are automatically added to the address book. This applies to both newly purchased instances and existing instances whose tags are updated to match.

0

GroupName

string

The name of the address book.

subscribe

ReferenceCount

integer

The number of times the address book is referenced.

1

GroupType

string

The type of the address book. Valid values:

  • ip: An IP address book.

  • domain: A domain address book.

  • port: A port address book.

  • tag: An ECS tag-based address book.

  • allCloud: A cloud service address book.

  • threat: A threat intelligence address book.

port

TagRelation

string

The logical relationship among multiple ECS tags.

and

TagList

array<object>

A list of ECS tags.

object

The ECS tag.

TagValue

string

The value of the ECS tag.

tfTestAcc0

TagKey

string

The key of the ECS tag.

produce

AddressList

array

A list of addresses in the address book.

string

The address in the address book.

183.2.201.71/32,60.28.235.22/32,210.51.58.107/32,60.28.235.81/32,210.51.58.51/32,60.28.235.52/32,1.1.1.1/32,154.212.141.143/32,167.94.146.55/32,185.226.197.47/32,101.251.238.174/32

NatGatewayId

string

The ID of the NAT Gateway.

ngw-gw85zno51npz7lgc04z89

DomainResolveType

integer

The domain name resolution method of the policy. Valid values:

  • FQDN: FQDN-based resolution.

  • DNS: Dynamic DNS-based resolution.

  • FQDN_AND_DNS: A combination of FQDN and dynamic DNS-based resolution.

0

VpcFirewallId

string

The instance ID of the VPC firewall.

cen-cw4z051hr8x53qniv5

AclStatus

string

The status of the policy check.

configuring

AclAssessmentDetail

string

The assessment details of the policy.

No traffic hit policy.

RecordAssessmentDetail

string

The assessment details of this ACL check record.

Due to business offline or other reasons, the number of hits of the object policy in a period of time is 0.

CheckName

string

The ACL check name. Valid values:

  • PolicyHitCountZero: Policies with no traffic hits.

  • PolicySourceDestinationSame: Invalid policies with the same source and destination.

  • PolicyDuplicate: Duplicate redundant policies.

  • PolicyConflict: Business conflict policies.

  • DefaultPolicyNotDeny: Default policy is not Deny All allowlist mechanism.

  • PolicyPortHighRisk: Policies that allow traffic through high-risk ports.

  • PolicyTooLoose: Overly permissive control policies.

  • AddressBookIpSeparated: Duplicate, overlapping, or scattered IP address books.

  • AddressBookPortSeparated: Duplicate, overlapping, or scattered port address books.

  • AddressBookDomainValid: Domain address book validity check.

PolicyHitCountZero

Description

string

The rule description.

dwd_mysql_lingwan_faxing_chat_config_di

LastCheckTime

string

The timestamp of the last check. Unit: seconds.

1724982259

Level

string

The risk level.

High

PolicyTotalCount

integer

The total number of policies.

1

TaskId

string

The ACL check task ID.

task-c92d4544ef7b6a42

Examples

Success response

JSON format

{
  "RequestId": "850A84D6************00090125EEB1",
  "CheckRecord": {
    "Acls": [
      {
        "Acl": {
          "Direction": "in",
          "Order": 1,
          "SourceType": "net",
          "ApplicationName": "ANY",
          "HitTimes": 1,
          "Description": "test_policy",
          "SourceGroupType": "ip",
          "DnsResultTime": 1579261141,
          "DnsResult": "192.168.0.1/32",
          "Proto": "ANY",
          "DestinationGroupType": "domain",
          "Destination": "kms.cn-shanghai.aliyuncs.com",
          "HitLastTime": 1579261141,
          "DestPortGroup": "port",
          "AclUuid": "1e8ed1b2-cebc-4b95-a9cc-0cb7ce2c0c2c",
          "DestPortType": "port",
          "Source": "10.71.94.24",
          "DestinationType": "group",
          "DestPort": "22/22",
          "IpVersion": 4,
          "AclAction": "log",
          "Release": "true",
          "ApplicationId": "HTTP",
          "DestinationGroupCidrs": [
            "192.168.0.1/32"
          ],
          "DestPortGroupPorts": [
            "22/22"
          ],
          "SourceGroupCidrs": [
            "192.168.0.1/32"
          ],
          "ApplicationNameList": [
            "SSH"
          ],
          "SpreadCnt": 10,
          "CreateTime": 1761062400,
          "ModifyTime": 1761062400,
          "RepeatType": "None",
          "RepeatDays": [
            1
          ],
          "RepeatStartTime": "08:00",
          "RepeatEndTime": "23:30",
          "StartTime": 1736130347,
          "EndTime": 1752754426,
          "AddressListCount": 1,
          "GroupUuid": "5a96a798-9b73-47f7-831e-1d7aa3c987a9",
          "AutoAddTagEcs": 0,
          "GroupName": "subscribe",
          "ReferenceCount": 1,
          "GroupType": "port",
          "TagRelation": "and",
          "TagList": [
            {
              "TagValue": "tfTestAcc0",
              "TagKey": "produce"
            }
          ],
          "AddressList": [
            "183.2.201.71/32,60.28.235.22/32,210.51.58.107/32,60.28.235.81/32,210.51.58.51/32,60.28.235.52/32,1.1.1.1/32,154.212.141.143/32,167.94.146.55/32,185.226.197.47/32,101.251.238.174/32"
          ],
          "NatGatewayId": "ngw-gw85zno51npz7lgc04z89",
          "DomainResolveType": 0,
          "VpcFirewallId": "cen-cw4z051hr8x53qniv5"
        },
        "AclStatus": "configuring",
        "AclAssessmentDetail": "No traffic hit policy."
      }
    ],
    "RecordAssessmentDetail": "Due to business offline or other reasons, the number of hits of the object policy in a period of time is 0.\n",
    "CheckName": "PolicyHitCountZero",
    "Description": "dwd_mysql_lingwan_faxing_chat_config_di",
    "LastCheckTime": "1724982259",
    "Level": "High",
    "PolicyTotalCount": 1,
    "TaskId": "task-c92d4544ef7b6a42"
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 ErrorAclCheckNotExist ACL check not exist. The access control configuration check does not exist.
400 ErrorAclCheckDetailNotExist ACL check detail not exist. The details of the access control configuration check do not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.