DescribeInstanceInfo - Web Application Firewall

使用說明

本介面用於查詢當前阿里雲帳號下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：表示未到期。說明 PayType為0（表示未開通WAF執行個體）時，不返回該參數。
EndDate	Long	1512921600	WAF執行個體的到期時間。使用時間戳表示，單位：秒。說明 PayType為0（表示未開通WAF執行個體）時，不返回該參數。
Version	String	version_3	WAF執行個體的版本。取值： version_pro_china：表示中國內地進階版。 version_business_china：表示中國內地企業版。 version_enterprise_china：表示中國內地旗艦版。 version_exclusive_china：表示中國內地虛擬獨享叢集版。 version_hybrid_cloud_standard_china：表示中國內地混合雲WAF版。 version_pro：表示非中國內地進階版。 version_business：表示非中國內地企業版。 version_enterprise：表示非中國內地旗艦版。 version_exclusive：表示非中國內地虛擬獨享叢集版。 version_hybrid_cloud_standard：表示非中國內地混合雲WAF版。如果返回的version參數值不在上述列表中，請確認您使用的是阿里雲國際站雲帳號。說明 PayType為0（表示未開通WAF執行個體）時，不返回該參數。
RemainDay	Integer	1	試用版WAF執行個體的剩餘可用天數。說明只有當Trial為1（表示已開通試用版WAF執行個體）時，才返回該參數。
Region	String	cn	WAF執行個體的地區。取值： cn：表示中國內地。 cn-hongkong：表示非中國內地。說明 PayType為0（表示未開通WAF執行個體）時，不返回該參數。
PayType	Integer	1	WAF執行個體的開通狀態。取值： 0：表示當前阿里雲帳號未開通WAF執行個體。 1：表示當前阿里雲帳號已開通WAF訂用帳戶執行個體。
InDebt	Integer	1	WAF執行個體是否存在欠費。取值： 0：表示已欠費。 1：表示未欠費。說明 PayType為0（表示未開通WAF執行個體）時，不返回該參數。
InstanceId	String	waf-cn-tl32ast****	WAF執行個體的ID。說明 PayType為0（表示未開通WAF執行個體）時，不返回該參數。
SubscriptionType	String	Subscription	WAF執行個體的計費方式。取值固定為Subscription，表示訂用帳戶。說明 PayType為0（表示未開通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"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。