调用DescribeInstanceInfo接口获取WAF实例的当前信息。

说明 调用该接口时,无需指定InstanceId请求参数。

调试

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

请求参数

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

要执行的操作。取值:DescribeInstanceInfo

InstanceSource String waf-cloud

WAF实例来源。系统规定默认值:waf-cloud

InstanceId String waf_elasticity-cn-0xldbqt****

WAF实例ID。

ResourceGroupId String rg-atstuj3rtop****

相关的资源组ID。默认为空,即属于默认资源组。

返回数据

名称 类型 示例值 描述
InstanceInfo Struct

WAF实例的信息。

EndDate Long 1512921600

WAF实例到期时间,返回值为秒级时间戳。

说明 对于按量付费实例,返回的值表示试用版到期时间。
InDebt Integer 1

当前WAF实例是否欠费:

  • 0:表示已欠费。
  • 1:表示未欠费,实例处于正常状态。
说明 该返回参数仅对按量付费WAF实例有意义。
InstanceId String waf_elasticity-cn-0xldbqt****

WAF实例ID。

PayType Integer 2

WAF实例类型:

  • 0:表示未购买或未开通WAF实例。
  • 1:表示包年包月实例。
  • 2:表示按量付费实例。
Region String cn

WAF实例所在的地域:

  • cn:表示中国内地。
  • cn-hongkong:表示海外地区。
RemainDay Integer 0

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

说明 该返回参数仅对试用版按量付费WAF实例有意义。
Status Integer 0

WAF实例是否到期:

  • 0:表示实例已到期。
  • 1:表示实例未到期,处于正常状态。
说明 该返回参数仅对包年包月WAF实例有意义。
SubscriptionType String PayAsYouGo

WAF实例的计费方式:

  • Subscription:表示包年包月类型。
  • PayAsYouGo:表示按量付费类型。
Trial Integer 0

是否试用版WAF实例:

  • 0:表示否。
  • 1:表示是。
说明 该返回参数仅对按量付费WAF实例有意义。
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

请求ID。

示例

请求示例

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

正常返回示例

XML 格式

<DescribeInstanceInfoResponse>
	  <InstanceInfo>
		    <Status>0</Status>
		    <EndDate>1512921600</EndDate>
		    <Region>cn</Region>
		    <InDebt>1</InDebt>
		    <Trial>0</Trial>
		    <InstanceId>waf_elasticity-cn-0xldbqt****</InstanceId>
		    <RemainDay>0</RemainDay>
		    <PayType>2</PayType>
	  </InstanceInfo>
	  <RequestId>276D7566-31C9-4192-9DD1-51B10DAC29D2</RequestId>
</DescribeInstanceInfoResponse>

JSON 格式

{
	"InstanceInfo":{
		"Status":0,
		"EndDate":1512921600,
		"Region":"cn",
		"InDebt":1,
		"Trial":0,
		"InstanceId":"waf_elasticity-cn-0xldbqt****",
		"RemainDay":0,
		"PayType":2
	},
	"RequestId":"276D7566-31C9-4192-9DD1-51B10DAC29D2"
}

错误码

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