You can call this operation to query the information of the WAF instance in a specified region.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | Boolean | No | DescribeInstanceInfo |
The operation that you want to perform. Set the value to DescribeInstanceInfo. |
InstanceSource | String | Yes | waf-cloud |
The source of the WAF instance. Default value: waf-cloud. |
InstanceId | String | Yes | waf_elasticity-cn-0xldbqtm005 |
The ID of the WAF instance. |
ResourceGroupId | String | Yes | rg-atstuj3rtoptyui |
The ID of the resource group to which the WAF instance belongs. By default, no value is specified, which indicates that the WAF instance belongs to the default resource group. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
InstanceInfo | Struct |
The information of the WAF instance. |
|
EndDate | Long | 1512921600 |
The timestamp (in seconds) indicating when the WAF instance expires. Note For a pay-as-you-go instance, the returned value indicates the time when the trial
period ends.
|
InDebt | Integer | 1 |
Indicates whether the WAF instance has overdue payments. Valid values:
Note This parameter applies to pay-as-you-go instances only.
|
InstanceId | String | waf_elasticity-cn-0xldbqtm005 |
The ID of the WAF instance. |
PayType | Integer | 2 |
The type of the WAF instance:
|
Region | String | cn |
The region where the WAF instance is located.
|
RemainDay | Integer | 0 |
The number of days before the trial period of the WAF instance expires. Note This parameter applies to trial pay-as-you-go instances only.
|
Status | Integer | 0 |
Indicates whether the WAF instance has expired. Valid values:
Note This parameter applies to subscription WAF instances only.
|
SubscriptionType | String | PayAsYouGo |
The billing method of the WAF instance. Valid values:
|
Trial | Integer | 0 |
Indicates whether this is a trial instance. Valid value:
Note This parameter applies to pay-as-you-go instances only.
|
RequestId | String | D7861F61-5B61-46CE-A47C-6B19160D5EB0 |
The ID of the request. |
Samples
Sample request
http(s)://[Endpoint]/? Action=DescribeInstanceInfo
&Region=cn
&<Common request parameters>
Sample success responses
XML
format
<InstanceInfo>
<Status>0</Status>
<EndDate>1512921600</EndDate>
<Region>cn</Region>
<InDebt>1</InDebt>
<Trial>0</Trial>
<InstanceId>waf_elasticity-cn-0xldbqtm005</InstanceId>
<RemainDay>0</RemainDay>
<PayType>2</PayType>
</InstanceInfo>
<RequestId>276D7566-31C9-4192-9DD1-51B10DAC29D2</RequestId>
JSON
format
{
"InstanceInfo":{
"Status":0,
"EndDate":1512921600,
"Region":"cn",
"InDebt":1,
"Trial":0,
"InstanceId":"waf_elasticity-cn-0xldbqtm005",
"RemainDay":0,
"PayType":2
},
"RequestId":"276D7566-31C9-4192-9DD1-51B10DAC29D2"
}
Error codes.
For a list of error codes, visit the API Error Center.