文档

DescribeInstanceInfo - 获取WAF实例的当前信息

更新时间:

查询当前阿里云账号下WAF实例的详情。

接口说明

使用说明

本接口用于查询当前阿里云账号下 WAF 实例的详情,例如,实例的 ID、版本、状态、到期时间等。

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

要查询的 WAF 实例的 ID。

不设置该参数表示查询中国内地地域或非中国内地地域的所有 WAF 实例信息。

waf-cn-tl32ast****
ResourceGroupIdstring

WAF 实例在资源管理服务中所属的资源组 ID。不设置该参数表示默认资源组。

rg-atstuj3rtop****
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用 API 的请求格式,请参见本文示例中的请求示例。

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

D7861F61-5B61-46CE-A47C-6B19160D5EB0
InstanceInfoobject

WAF 实例的详情。

Statusinteger

WAF 实例是否过期。取值:

  • 0:表示已过期。
  • 1:表示未过期。
说明 PayType0(表示未开通 WAF 实例)时,不返回该参数。
1
EndDatelong

WAF 实例的到期时间。使用时间戳表示,单位:秒。

说明 PayType0(表示未开通 WAF 实例)时,不返回该参数。
1512921600
Versionstring

WAF 实例的版本。取值:

  • version_3:表示中国内地高级版。
  • version_4:表示中国内地企业版。
  • version_5:表示中国内地旗舰版。
  • version_exclusive_cluster:表示中国内地虚拟独享集群版。
  • version_hybrid_cloud_standard:表示中国内地混合云 WAF 版。
  • version_pro_asia:表示非中国内地高级版。
  • version_business_asia:表示非中国内地企业版。
  • version_enterprise_asia:表示非中国内地旗舰版。
  • version_exclusive_cluster_asia:表示非中国内地虚拟独享集群版。
  • version_hybrid_cloud_standard_asia:表示非中国内地混合云 WAF 版。
  • version_elastic_bill:表示按量计费版。
  • version_elastic_bill_new:表示按量计费 2.0 版。

如果返回的 version 参数值不在上述列表中,请确认您使用的是阿里云中国站云账号。

说明 PayType0(表示未开通 WAF 实例)时,不返回该参数。
version_3
RemainDayinteger

试用版 WAF 实例的剩余可用天数。

说明 只有当 Trial1(表示已开通试用版 WAF 实例)时,才返回该参数。
1
Regionstring

WAF 实例的地域。取值:

  • cn:表示中国内地。
  • cn-hongkong:表示非中国内地。
说明 PayType0(表示未开通 WAF 实例)时,不返回该参数。
cn
PayTypeinteger

WAF 实例的开通状态。取值:

  • 0:表示当前阿里云账号未开通 WAF 实例。
  • 1:表示当前阿里云账号已开通 WAF 包年包月实例。
  • 2:表示当前阿里云账号已开通 WAF 按量计费实例。
1
InDebtinteger

WAF 实例是否存在欠费。取值:

  • 0:表示已欠费。
  • 1:表示未欠费。
说明 PayType0(表示未开通 WAF 实例)时,不返回该参数。
1
InstanceIdstring

WAF 实例的 ID。

说明 PayType0(表示未开通 WAF 实例)时,不返回该参数。
waf-cn-tl32ast****
SubscriptionTypestring

WAF 实例的计费方式。取值:

  • Subscription:表示包年包月。
  • PayAsYouGo:表示按量计费。
说明 PayType0(表示未开通 WAF 实例)时,不返回该参数。
Subscription
Trialinteger

当前阿里云账号是否开通了试用版 WAF 实例。取值:

  • 0:表示否。
  • 1:表示是。
说明 只有当前阿里云账号已开通试用版 WAF 实例时,才会返回该参数。
1

示例

正常返回示例

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "InstanceInfo": {
    "Status": 1,
    "EndDate": 1512921600,
    "Version": "version_3",
    "RemainDay": 1,
    "Region": "cn",
    "PayType": 1,
    "InDebt": 1,
    "InstanceId": "waf-cn-tl32ast****",
    "SubscriptionType": "Subscription",
    "Trial": 1
  }
}

错误码

HTTP status code错误码错误信息
403ForbbidenUser not authorized to operate on the specified resource.
500InternalErrorThe request processing has failed due to some unknown error.

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

  • 本页导读 (1)