調(diào)用DescribeInstanceInfo查詢當(dāng)前阿里云賬號(hào)下WAF實(shí)例的詳情。

使用說明

本接口用于查詢當(dāng)前阿里云賬號(hào)下WAF實(shí)例的詳情，例如，實(shí)例的ID、版本、狀態(tài)、到期時(shí)間等。

QPS限制

本接口的單用戶QPS限制為50次/秒。超過限制，API調(diào)用將會(huì)被限流，這可能影響您的業(yè)務(wù)，請(qǐng)合理調(diào)用。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeInstanceInfo

要執(zhí)行的操作。取值：DescribeInstanceInfo。

InstanceId String 否 waf-cn-tl32ast****

要查詢的WAF實(shí)例的ID。

不設(shè)置該參數(shù)表示查詢中國(guó)內(nèi)地地域或非中國(guó)內(nèi)地地域的所有WAF實(shí)例信息。
ResourceGroupId String 否 rg-atstuj3rtop****

WAF實(shí)例在資源管理服務(wù)中所屬的資源組ID。不設(shè)置該參數(shù)表示默認(rèn)資源組。

調(diào)用API時(shí)，除了本文中該API的請(qǐng)求參數(shù)，還需加入阿里云API公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)的詳細(xì)介紹，請(qǐng)參見公共參數(shù)。

調(diào)用API的請(qǐng)求格式，請(qǐng)參見本文示例中的請(qǐng)求示例。

返回?cái)?shù)據(jù)

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

本次請(qǐng)求的ID。
InstanceInfo Object

WAF實(shí)例的詳情。
Status Integer 1

WAF實(shí)例是否過期。取值：

  • 0：表示已過期。
  • 1：表示未過期。
說明 PayType為0（表示未開通WAF實(shí)例）時(shí)，不返回該參數(shù)。
EndDate Long 1512921600

WAF實(shí)例的到期時(shí)間。使用時(shí)間戳表示，單位：秒。

說明 PayType為0（表示未開通WAF實(shí)例）時(shí)，不返回該參數(shù)。
Version String version_3

WAF實(shí)例的版本。取值：

  • version_3：表示中國(guó)內(nèi)地高級(jí)版。

  • version_4：表示中國(guó)內(nèi)地企業(yè)版。

  • version_5：表示中國(guó)內(nèi)地旗艦版。

  • version_exclusive_cluster：表示中國(guó)內(nèi)地虛擬獨(dú)享集群版。

  • version_hybrid_cloud_standard：表示中國(guó)內(nèi)地混合云WAF版。

  • version_pro_asia：表示非中國(guó)內(nèi)地高級(jí)版。

  • version_business_asia：表示非中國(guó)內(nèi)地企業(yè)版。

  • version_enterprise_asia：表示非中國(guó)內(nèi)地旗艦版。

  • version_exclusive_cluster_asia：表示非中國(guó)內(nèi)地虛擬獨(dú)享集群版。

  • version_hybrid_cloud_standard_asia：表示非中國(guó)內(nèi)地混合云WAF版。

  • version_elastic_bill：表示按量計(jì)費(fèi)版。

  • version_elastic_bill_new：表示按量計(jì)費(fèi)2.0版。

如果返回的version參數(shù)值不在上述列表中，請(qǐng)確認(rèn)您使用的是阿里云中國(guó)站云賬號(hào)。

說明 PayType為0（表示未開通WAF實(shí)例）時(shí)，不返回該參數(shù)。
RemainDay Integer 1

試用版WAF實(shí)例的剩余可用天數(shù)。

說明 只有當(dāng)Trial為1（表示已開通試用版WAF實(shí)例）時(shí)，才返回該參數(shù)。
Region String cn

WAF實(shí)例的地域。取值：

  • cn：表示中國(guó)內(nèi)地。
  • cn-hongkong：表示非中國(guó)內(nèi)地。
說明 PayType為0（表示未開通WAF實(shí)例）時(shí)，不返回該參數(shù)。
PayType Integer 1

WAF實(shí)例的開通狀態(tài)。取值：

  • 0：表示當(dāng)前阿里云賬號(hào)未開通WAF實(shí)例。

  • 1：表示當(dāng)前阿里云賬號(hào)已開通WAF包年包月實(shí)例。

  • 2：表示當(dāng)前阿里云賬號(hào)已開通WAF按量計(jì)費(fèi)實(shí)例。
InDebt Integer 1

WAF實(shí)例是否存在欠費(fèi)。取值：

  • 0：表示已欠費(fèi)。
  • 1：表示未欠費(fèi)。
說明 PayType為0（表示未開通WAF實(shí)例）時(shí)，不返回該參數(shù)。
InstanceId String waf-cn-tl32ast****

WAF實(shí)例的ID。

說明 PayType為0（表示未開通WAF實(shí)例）時(shí)，不返回該參數(shù)。
SubscriptionType String Subscription

WAF實(shí)例的計(jì)費(fèi)方式。取值：

  • Subscription：表示包年包月。

  • PayAsYouGo：表示按量計(jì)費(fèi)。
說明 PayType為0（表示未開通WAF實(shí)例）時(shí)，不返回該參數(shù)。
Trial Integer 1

當(dāng)前阿里云賬號(hào)是否開通了試用版WAF實(shí)例。取值：

  • 0：表示否。
  • 1：表示是。
說明 只有當(dāng)前阿里云賬號(hào)已開通試用版WAF實(shí)例時(shí)，才會(huì)返回該參數(shù)。

示例

請(qǐng)求示例

http(s)://[Endpoint]/?Action=DescribeInstanceInfo
&公共請(qǐng)求參數(shù)

正常返回示例

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

錯(cuò)誤碼

訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。