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

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstanceInfo

要执行的操作。取值:DescribeInstanceInfo

InstanceId String waf-cn-tl32ast****

要查询的WAF实例的ID。

不设置该参数表示查询所有WAF实例的信息。

ResourceGroupId String rg-atstuj3rtop****

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

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

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

返回数据

名称 类型 示例值 描述
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

本次请求的ID。

InstanceInfo Object

WAF实例的详情。

Status Integer 1

WAF实例是否过期。取值:

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

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

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

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实例)时,不返回该参数。
RemainDay Integer 1

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

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

WAF实例的地域。取值:

  • cn:表示中国内地。
  • cn-hongkong:表示海外地区。
说明 PayType0(表示未开通WAF实例)时,不返回该参数。
PayType Integer 1

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

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

  • 2:表示当前阿里云账号已开通WAF按量计费实例。
InDebt Integer 1

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

  • 0:表示已欠费。
  • 1:表示未欠费。
说明 PayType0(表示未开通WAF实例)时,不返回该参数。
InstanceId String waf-cn-tl32ast****

WAF实例的ID。

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

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

  • Subscription:表示包年包月。

  • PayAsYouGo:表示按量计费。
说明 PayType0(表示未开通WAF实例)时,不返回该参数。
Trial Integer 1

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

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstanceInfo
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceInfoResponse>
    <RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
    <InstanceInfo>
        <Status>1</Status>
        <EndDate>1512921600</EndDate>
        <Version>version_3</Version>
        <Region>cn</Region>
        <PayType>1</PayType>
        <InDebt>1</InDebt>
        <InstanceId>waf-cn-tl32ast****</InstanceId>
        <SubscriptionType>Subscription</SubscriptionType>
    </InstanceInfo>
</DescribeInstanceInfoResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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