DescribeUserBuyVersion-阿里云帮助中心

Retrieves version information for a user.

Operation description

This operation queries information about your Cloud Firewall instance.

QPS limit

This operation is limited to 10 queries per second (QPS) per user. If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable frequency.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the instance. If you specify this parameter, the query is performed based on the instance ID. If you leave this parameter empty, the latest instance is queried by default.	cfw_elasticity_public_cn-*******

Response elements

Element	Type	Description	Example
	object
AliUid	integer	The ID of the Alibaba Cloud account.	119898001566xxxx
InstanceId	string	The ID of the Cloud Firewall instance. Note This parameter does not apply to trial editions.	vipcloudfw-cn-xxxxx
StartTime	integer	The time when the Cloud Firewall instance was enabled. Note The value is a UNIX timestamp in milliseconds.	1692504764000
RequestId	string	The ID of the request.	F71B03EE-xxxxx-91D79CC6AA1A
Version	integer	The edition of the Cloud Firewall instance. Valid values: 2: Premium Edition 3: Enterprise Edition 4: Ultimate Edition 10: Pay-as-you-go	2
UserStatus	boolean	The status of the Cloud Firewall instance. Valid values: true: The instance is valid. false: The instance is invalid.	true
Expire	integer	The expiration time of the Cloud Firewall instance. Note The value is a UNIX timestamp in milliseconds. Note This parameter does not apply to pay-as-you-go editions.	1726934400000
LogStatus	boolean	Indicates whether log delivery is enabled. Valid values: true: Enabled false: Disabled	true
InstanceStatus	string	The operational status of the Cloud Firewall instance. Valid values: normal: The instance is running as expected. init: The instance is being initialized. deleting: The instance is being deleted. abnormal: The instance is in an abnormal state. free: No valid instance is available.	normal
MaxOverflow	integer	Indicates whether elastic billing for excess traffic is enabled. Valid values: 1000000: Enabled 0: Disabled Note This parameter applies only to subscription instances.	0
VpcNumber	integer	The number of purchased VPC firewalls. Note This parameter applies only to subscription instances.	21
IpNumber	integer	The number of public IP addresses that can be protected. Note This parameter applies only to subscription instances.	63
LogStorage	integer	The purchased log storage capacity. Note This parameter applies only to subscription instances.	3000
InternetBandwidth	integer	The purchased traffic processing capability for the Internet firewall.	3000
VpcBandwidth	integer	The purchased traffic processing capability for the VPC firewall.	3000
NatBandwidth	integer	The purchased traffic processing capability for the NAT firewall.	3000
MajorVersion	integer	The major version.	1
DefaultBandwidth	integer	The default bandwidth of the edition.	1000
ExtensionBandwidth	integer	The extended bandwidth.	1000
TemporaryBandwidth	integer	The temporary bandwidth.	1000
GeneralInstance	integer	The number of general-purpose instances.	10
ThreatIntelligence	integer	Indicates whether threat intelligence is enabled.	1
Sdl	integer	Indicates whether data leakage prevention is enabled.	1
PrivateDnsConnectorQuota	integer	The quota for private DNS connectors.	5
AckClusterConnectorQuota	integer	The quota for ACK cluster connectors.	5

Examples

Success response

JSON format

{
  "AliUid": 0,
  "InstanceId": "vipcloudfw-cn-xxxxx",
  "StartTime": 1692504764000,
  "RequestId": "F71B03EE-xxxxx-91D79CC6AA1A",
  "Version": 2,
  "UserStatus": true,
  "Expire": 1726934400000,
  "LogStatus": true,
  "InstanceStatus": "normal",
  "MaxOverflow": 0,
  "VpcNumber": 21,
  "IpNumber": 63,
  "LogStorage": 3000,
  "InternetBandwidth": 3000,
  "VpcBandwidth": 3000,
  "NatBandwidth": 3000,
  "MajorVersion": 1,
  "DefaultBandwidth": 1000,
  "ExtensionBandwidth": 1000,
  "TemporaryBandwidth": 1000,
  "GeneralInstance": 10,
  "ThreatIntelligence": 1,
  "Sdl": 1,
  "PrivateDnsConnectorQuota": 5,
  "AckClusterConnectorQuota": 5
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.