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

获取用户版本信息。

接口说明

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

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cloudfirewall:DescribeUserBuyVersionget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object
AliUidlong

云防火墙账号的 AliUid。

119898001566xxxx
InstanceIdstring

购买的云防火墙实例 id。

说明 使用试用版本时此字段无意义。
vipcloudfw-cn-xxxxx
StartTimelong

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

说明 使用毫秒级时间戳格式。
1692504764000
RequestIdstring

结果的请求 ID。

F71B03EE-xxxxx-91D79CC6AA1A
Versioninteger

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

  • 2:高级版
  • 3:企业版
  • 4:旗舰版
  • 10:按量付费版本
2
UserStatusboolean

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

  • true:有效
  • false:无效
true
Expirelong

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

说明 使用毫秒级时间戳格式。
说明 使用按量付费版本时该字段无意义。
1726934400000
LogStatusboolean

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

  • true:已开启
  • false:未开启
true
InstanceStatusstring

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

  • normal:实例正常运行中

  • init:实例初始化中

  • deleting:实例正在删除

  • abnormal:实例存在异常

  • free:无有效实例

normal
MaxOverflowlong

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

  • 1000000:已开通
  • 0:未开通
说明 该字段仅对包年包月用户生效。
0
VpcNumberlong

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

说明 该字段仅对包年包月用户生效。
21
IpNumberlong

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

说明 该字段仅对包年包月用户生效。
63
LogStoragelong

购买的日志存储容量。

说明 该字段仅对包年包月用户生效。
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
}

错误码

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