All Products
Search

This Product

    Cloud Firewall:DescribeUserBuyVersion

    Document Center

    Cloud Firewall:DescribeUserBuyVersion

    Last Updated:Aug 04, 2026

    Retrieves the version information of a user.

    Operation description

    This operation is used to query and retrieve Cloud Firewall instance information for a user.

    QPS limit

    The single-user QPS limit for this operation is 10 calls per second. If this limit is exceeded, the API call is throttled, which may affect your business. Call this operation at an appropriate 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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    No

    The instance ID. If you specify an instance ID, the system queries the specified instance. If you leave this parameter empty, the system queries the most recent instance by default.

    cfw_elasticity_public_cn-*******

    Response elements

    Element

    Type

    Description

    Example

    object

    AliUid

    integer

    The AliUid of the Cloud Firewall account.

    119898001566xxxx
    InstanceId

    string

    The ID of the purchased Cloud Firewall instance.

    Note

    This field is meaningless when you use the trial version.

    vipcloudfw-cn-xxxxx
    StartTime

    integer

    The activation time of the Cloud Firewall instance.

    Note

    The value is a millisecond-level UNIX timestamp.

    1692504764000
    RequestId

    string

    The request ID.

    F71B03EE-xxxxx-91D79CC6AA1A
    Version

    integer

    The version of the Cloud Firewall instance. Valid values:

    • 2: Premium Edition

    • 3: Enterprise Edition

    • 4: Ultimate Edition

    • 10: Pay-as-you-go Edition

    2
    UserStatus

    boolean

    The status of the Cloud Firewall instance. Valid values:

    • true: Valid.

    • false: Invalid.

    true
    Expire

    integer

    The expiration time of the Cloud Firewall instance.

    Note

    The value is a millisecond-level UNIX timestamp.

    Note

    This field is meaningless when you use the pay-as-you-go edition.

    1726934400000
    LogStatus

    boolean

    The enabling status of log delivery. Valid values:

    • true: Enabled.

    • false: Disabled.

    true
    InstanceStatus

    string

    The provisioning status of the Cloud Firewall instance. Valid values:

    • normal: The instance is running normally.

    • init: The instance is being initialized.

    • deleting: The instance is being deleted.

    • abnormal: The instance is abnormal.

    • free: No valid instance exists.

    normal
    MaxOverflow

    integer

    Indicates whether burstable elastic billing is enabled. Valid values:

    • 1000000: Enabled.

    • 0: Disabled.

    Note

    This field takes effect only for subscription users.

    0
    VpcNumber

    integer

    The purchased quota for VPC firewalls.

    Note

    This field takes effect only for subscription users.

    21
    IpNumber

    integer

    The purchased quota for the Internet border protection.

    Note

    This field takes effect only for subscription users.

    63
    LogStorage

    integer

    The purchased log storage capacity.

    Note

    This field takes effect only for subscription users.

    3000
    InternetBandwidth

    integer

    The purchased traffic processing capacity of the Internet firewall.

    3000
    VpcBandwidth

    integer

    The purchased traffic processing capacity of VPC firewalls.

    3000
    NatBandwidth

    integer

    The purchased traffic processing capacity of NAT firewalls.

    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 upgrade bandwidth.

    1000
    GeneralInstance

    integer

    The general-purpose instance quota.

    10
    ThreatIntelligence

    integer

    The enabling status of threat intelligence.

    1
    Sdl

    integer

    The enabling status of sensitive data leak detection. In the Resource field, true indicates enabled and false indicates disabled. In the API response, 1 indicates enabled and 0 indicates disabled.

    1
    PrivateDnsConnectorQuota

    integer

    The private DNS connector quota.

    5
    AckClusterConnectorQuota

    integer

    The ACK cluster connector quota.

    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.