DescribeAssetStatistic-阿里云帮助中心

Queries the statistics information of assets protected by Cloud Firewall.

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:DescribeAssetStatistic

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	112.239.XX.XX
Lang	string	No	The language of the request and response. Valid values:- zh: Chinese- en: English.	zh
Lang	string	No	指定请求和接收消息的语言类型。-zh：中文-en：英文	zh

Response elements

Element	Type	Description	Example
	object	The response object.
AutoResourceEnable	boolean	Indicates whether automatic traffic redirection is enabled. Valid values:- true: Enabled.- false: Disabled.	true
RequestId	string	The request ID.	850A84******25g4d2
ResourceSpecStatistic	object	The consumed quota statistics information.
IpNumUsed	integer	The number of public IP addresses with protection enabled.	10
IpNumSpec	integer	The quota for protected public IP addresses.	20
SensitiveDataIpNumSpec	integer	The quota for sensitive data IP addresses.	0
SensitiveDataIpNumUsed	integer	The number of sensitive data IP addresses with protection enabled.	0
GeneralInstanceSpecStatistic	object	The general instance specifications for version 2.0.
TotalGeneralInstanceUsedCnt	integer	The total quota.	1
TotalCfwGeneralInstanceUsedCnt	integer	The number of instances with the Internet firewall enabled.	1
TotalVfwGeneralInstanceUsedCnt	integer	The number of instances with the VPC firewall enabled.	1
TotalNatGeneralInstanceUsedCnt	integer	The number of instances with the NAT firewall enabled.	1
TotalCfwGeneralInstanceCnt	integer	The total number of instances for the Internet firewall.	1
TotalNatGeneralInstanceCnt	integer	The total number of instances for the NAT firewall.	1
CfwGeneralInstanceRegionStatistic	array<object>	The region-specific statistics for the Internet firewall.
	object	The details of region-specific statistics for the Internet firewall.
RegionNo	string	Region information	cn-hangzhou
MemberList	array	List of member accounts in the region.
	string	A member of the region	123
CfwTotalGeneralInstanceRegionStatistic	array<object>	The region-specific statistics for all Internet firewall instances.
	object	The details of region-specific statistics for the Internet firewall.
RegionNo	string	Region information	cn-shanghai
MemberList	array	List of member accounts in the region.
	string	The members in the region.	123

Examples

Success response

JSON format

{
  "AutoResourceEnable": true,
  "RequestId": "850A84******25g4d2",
  "ResourceSpecStatistic": {
    "IpNumUsed": 10,
    "IpNumSpec": 20,
    "SensitiveDataIpNumSpec": 0,
    "SensitiveDataIpNumUsed": 0
  },
  "GeneralInstanceSpecStatistic": {
    "TotalGeneralInstanceUsedCnt": 1,
    "TotalCfwGeneralInstanceUsedCnt": 1,
    "TotalVfwGeneralInstanceUsedCnt": 1,
    "TotalNatGeneralInstanceUsedCnt": 1,
    "TotalCfwGeneralInstanceCnt": 1,
    "TotalNatGeneralInstanceCnt": 1,
    "CfwGeneralInstanceRegionStatistic": [
      {
        "RegionNo": "cn-hangzhou",
        "MemberList": [
          "123"
        ]
      }
    ],
    "CfwTotalGeneralInstanceRegionStatistic": [
      {
        "RegionNo": "cn-shanghai",
        "MemberList": [
          "123"
        ]
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParamsNotEnough	Parameters are insufficient.	Parameters are insufficient.
400	ErrorDbFailed	Query db failed.	DB access error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.