All Products
Search

This Product

    Cloud Firewall:DescribeUserBuyVersion

    Document Center

    Cloud Firewall:DescribeUserBuyVersion

    Last Updated:Dec 06, 2024

    Queries the edition information about Cloud Firewall.

    Operation description

    You can call this operation to query the edition information about Cloud Firewall.

    Limits

    You can call this operation up to 10 times per second per account. If the number of 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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringNo

    Instance ID. If the Instance ID is provided, the query will be based on this ID. If not provided, the latest instance will be queried by default.

    		cfw_elasticity_public_cn-*******

    Response parameters

    ParameterTypeDescriptionExample
    object
    AliUidlong

    The ID of the Alibaba Cloud account that is used to purchase Cloud Firewall.

    		119898001566xxxx
    InstanceIdstring

    The instance ID of Cloud Firewall.

    Note If you use a trial of Cloud Firewall, ignore this parameter.
    		vipcloudfw-cn-xxxxx
    StartTimelong

    The time when Cloud Firewall was activated.

    Note The value is a timestamp in milliseconds.
    		1692504764000
    RequestIdstring

    The request ID.

    		F71B03EE-xxxxx-91D79CC6AA1A
    Versioninteger

    The edition of Cloud Firewall. Valid values:

    • 2: Premium Edition.
    • 3: Enterprise Edition.
    • 4: Ultimate Edition.
    • 10: Cloud Firewall that uses the pay-as-you-go billing method.
    		2
    UserStatusboolean

    Indicates whether Cloud Firewall is valid. Valid values:

    • true
    • false
    		true
    Expirelong

    The time when Cloud Firewall expires.

    Note The value is a timestamp in milliseconds.
    Note If you use Cloud Firewall that uses the pay-as-you-go billing method, ignore this parameter.
    		1726934400000
    LogStatusboolean

    Indicates whether log delivery is enabled. Valid values:

    • true
    • false
    		true
    InstanceStatusstring

    The status of Cloud Firewall. Valid values:

    • normal: Cloud Firewall is running as expected.
    • init: Cloud Firewall is being initialized.
    • deleting: Cloud Firewall is being deleted.
    • abnormal: An exception occurs in Cloud Firewall.
    • free: Cloud Firewall is invalid.
    		normal
    MaxOverflowlong

    The status of the burstable protected traffic feature. Valid values:

    • 1000000: enabled.
    • 0: disabled.
    Note This parameter takes effect only for Cloud Firewall that uses the subscription billing method.
    		0
    VpcNumberlong

    The number of virtual private clouds (VPCs) that can be protected.

    Note This parameter takes effect only for Cloud Firewall that uses the subscription billing method.
    		21
    IpNumberlong

    The number of public IP addresses that can be protected.

    Note This parameter takes effect only for Cloud Firewall that uses the subscription billing method.
    		63
    LogStoragelong

    The log storage capacity.

    Note This parameter takes effect only for Cloud Firewall that uses the subscription billing method.
    		3000

    Examples

    Sample success responses

    JSONformat

    {
  "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
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-09-24The request parameters of the API has changedView Change Details