DescribeUserBuyVersion - 获取用户云防火墙实例信息

获取用户版本信息。

接口说明

本接口一般用于查询获取用户云防火墙实例信息。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cloudfirewall:DescribeUserBuyVersion

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。若填写实例 ID,则根据实例 ID 查询。不填写则默认查询最新实例。

cfw_elasticity_public_cn-*******

返回参数

名称

类型

描述

示例值

object

AliUid

integer

云防火墙账号的 AliUid。

119898001566xxxx

InstanceId

string

购买的云防火墙实例 id。

说明

使用试用版本时此字段无意义。

vipcloudfw-cn-xxxxx

StartTime

integer

云防火墙实例的开通时间。

说明

使用毫秒级时间戳格式。

1692504764000

RequestId

string

结果的请求 ID。

F71B03EE-xxxxx-91D79CC6AA1A

Version

integer

云防火墙实例的版本信息。取值:

  • 2:高级版

  • 3:企业版

  • 4:旗舰版

  • 10:按量付费版本

2

UserStatus

boolean

云防火墙实例的状态。取值:

  • true:有效

  • false:无效

true

Expire

integer

云防火墙实例的到期时间。

说明

使用毫秒级时间戳格式。

说明

使用按量付费版本时该字段无意义。

1726934400000

LogStatus

boolean

日志投递开启状态。取值:

  • true:已开启

  • false:未开启

true

InstanceStatus

string

云防火墙实例的生产状态。取值:

  • normal:实例正常运行中

  • init:实例初始化中

  • deleting:实例正在删除

  • abnormal:实例存在异常

  • free:无有效实例

normal

MaxOverflow

integer

是否开通超量弹性计费。取值:

  • 1000000:已开通

  • 0:未开通

说明

该字段仅对包年包月用户生效。

0

VpcNumber

integer

购买的 VPC 边界防护规格数。

说明

该字段仅对包年包月用户生效。

21

IpNumber

integer

购买的互联网边界防护规格数。

说明

该字段仅对包年包月用户生效。

63

LogStorage

integer

购买的日志存储容量。

说明

该字段仅对包年包月用户生效。

3000

InternetBandwidth

integer

购买的互联网防火墙流量处理能力。

3000

VpcBandwidth

integer

购买的 VPC 防火墙流量处理能力。

3000

NatBandwidth

integer

购买的 NAT 防火墙流量处理能力。

3000

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情