All Products
Search
Document Center

Cloud Firewall:DescribeAssetList

更新時間:Sep 02, 2024

Queries the assets that are protected by Cloud Firewall.

Operation description

You can call the DescribeAssetList operation to query the assets that are protected by Cloud Firewall.

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:DescribeAssetListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the response. Valid values:

  • zh: Chinese (default)
  • en: English
zh
CurrentPagestringYes

The page number. Valid values: 1 to 50.

1
PageSizestringYes

The number of entries per page. Valid values: 1 to 50.

10
RegionNostringNo

The region ID of your Cloud Firewall.

Note For more information about the regions, see Supported regions.
cn-hangzhou
StatusstringNo

The status of the firewall. Valid values:

  • open: The firewall is enabled.
  • opening: The firewall is being enabled.
  • closed: The firewall is disabled.
  • closing: The firewall is being disabled.
Note If you do not specify this parameter, the assets that are configured for firewalls in all states are queried.
open
SearchItemstringNo

The instance ID or IP address of the asset.

192.0.XX.XX
TypestringNo

This parameter is deprecated.

eip
ResourceTypestringNo

The type of the asset. Valid values:

  • BastionHostEgressIP: the egress IP address of a bastion host
  • BastionHostIngressIP: the ingress IP address of a bastion host
  • EcsEIP: the elastic IP address (EIP) of an Elastic Compute Service (ECS) instance
  • EcsPublicIP: the public IP address of an ECS instance
  • EIP: the EIP
  • EniEIP: the EIP of an elastic network interface (ENI)
  • NatEIP: the EIP of a NAT gateway
  • SlbEIP: the EIP of a Server Load Balancer (SLB) instance or a Classic Load Balancer (CLB) instance
  • SlbPublicIP: the public IP address of an SLB instance or a CLB instance
  • NatPublicIP: the public IP address of a NAT gateway
  • HAVIP: the high-availability virtual IP address (HAVIP)
EIP
SgStatusstringNo

The status of the security group policy. Valid values:

  • pass: delivered
  • block: undelivered
  • unsupport: unsupported
Note If you do not specify this parameter, the assets on which security group policies in all states take effect are queried.
pass
IpVersionstringNo

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

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

The UID of the member that is added to Cloud Firewall.

258039427902****
UserTypestringNo

The edition of Cloud Firewall. Valid values:

  • buy: a paid edition (default)
  • free: Free Edition
buy
NewResourceTagstringNo

The time when the asset was added. Valid values:

  • discovered in 1 hour: within one hour.
  • discovered in 1 day: within one day.
  • discovered in 7 days: within seven days.
discovered in 1 hour

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of the assets that are protected by Cloud Firewall.

12
RequestIdstring

The ID of the request.

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
Assetsarray<object>

The details about the assets that are protected by Cloud Firewall.

object
RiskLevelstring

The risk level of the asset. Valid values:

  • low: low
  • middle: medium
  • hight: high
Note The value of this parameter is returned only when the UserType parameter is set to free.
low
BindInstanceNamestring

The instance name of the asset.

instance01
Typestring

This parameter is deprecated.

eip
SgStatusTimelong

The time when the status of the security group was last checked. The value is a UNIX timestamp. Unit: seconds.

1615082937
ResourceInstanceIdstring

The instance ID of the asset.

i-8vbdrjrxzt78****
MemberUidlong

The UID of the member.

258039427902****
IntranetAddressstring

The internal IP address of the server.

192.168.XX.XX
SyncStatusstring

Indicates whether traffic redirection is supported for the asset. Valid values:

  • enable: yes
  • disable: no
enable
AliUidlong

The UID of the Alibaba Cloud account.

Note The value of this parameter indicates the management account to which the member is added.
158039427902****
ProtectStatusstring

The status of the firewall. Valid values:

  • open: enabled.
  • opening: being enabled.
  • closed: disabled.
  • closing: being disabled.
open
InternetAddressstring

The public IP address of the server.

192.0.XX.XX
BindInstanceIdstring

The ID of the cloud resource with which the asset is associated.

i-8vbdrjrxzt78****
RegionIDstring

The ID of the region in which the asset resides.

cn-hangzhou
RegionStatusstring

Indicates whether the firewall is supported in the region in which the asset resides. Valid values:

  • enable: yes
  • disable: no
enable
ResourceTypestring

The type of the asset. Valid values:

  • BastionHostEgressIP: the egress IP address of a bastion host
  • BastionHostIngressIP: the ingress IP address of a bastion host
  • EcsEIP: the elastic IP address (EIP) of an Elastic Compute Service (ECS) instance
  • EcsPublicIP: the public IP address of an ECS instance
  • EIP: the EIP
  • EniEIP: the EIP of an elastic network interface (ENI)
  • NatEIP: the EIP of a NAT gateway
  • SlbEIP: the EIP of a Server Load Balancer (SLB) instance
  • SlbPublicIP: the public IP address of an SLB instance
  • NatPublicIP: the public IP address of a NAT gateway
  • HAVIP: the high-availability virtual IP address (HAVIP)
EIP
IpVersioninteger

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

Valid values:

  • 4: IPv4
  • 6: IPv6
4
SgStatusstring

The status of the security group policy. Valid values:

  • pass: applied
  • block: not applied
  • unsupport: unsupported
block
Notestring

The remarks of the asset. Valid values:

  • REGION_NOT_SUPPORT: The region is not supported.
  • NETWORK_NOT_SUPPORT: The network is not supported.
REGION_NOT_SUPPORT
Namestring

The instance name of the asset that is protected by Cloud Firewall.

instance01
CreateTimeStampstring

The timestamp when the asset is added to Cloud Firewall.

2023-02-28 10:29:58
NewResourceTagstring

The time when the asset was added. Valid values:

  • discovered in 1 hour: within one hour.
  • discovered in 1 day: within one day.
  • discovered in 7 days: within seven days.
discovered in 1 hour

Examples

Sample success responses

JSONformat

{
  "TotalCount": 12,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "Assets": [
    {
      "RiskLevel": "low",
      "BindInstanceName": "instance01",
      "Type": "eip",
      "SgStatusTime": 1615082937,
      "ResourceInstanceId": "i-8vbdrjrxzt78****",
      "MemberUid": 0,
      "IntranetAddress": "192.168.XX.XX",
      "SyncStatus": "enable",
      "AliUid": 0,
      "ProtectStatus": "open",
      "InternetAddress": "192.0.XX.XX",
      "BindInstanceId": "i-8vbdrjrxzt78****",
      "RegionID": "cn-hangzhou",
      "RegionStatus": "enable",
      "ResourceType": "EIP",
      "IpVersion": 4,
      "SgStatus": "block",
      "Note": "REGION_NOT_SUPPORT",
      "Name": "instance01",
      "CreateTimeStamp": "2023-02-28 10:29:58",
      "NewResourceTag": "discovered in 1 hour"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400ErrorDBSelectAn error occurred while querying database.An error occurred while querying database.

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

Change history

Change timeSummary of changesOperation
2023-08-29The Error code has changedView Change Details