Queries the information of a WAF instance.

Note When you call this operation, you do not need to specify the InstanceId parameter.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstanceInfo

The operation that you want to perform. Set the value to DescribeInstanceInfo.

InstanceSource String No waf-cloud

The source of the WAF instance. Default value: waf-cloud.

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

The ID of the WAF instance.

ResourceGroupId String No rg-atstuj3rtop****

The ID of the resource group to which the WAF instance belongs. This parameter is empty by default. In this case, 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 expiration time of the WAF instance. This value is a timestamp precise to the second.

Note If the WAF instance is billed on a pay-as-you-go basis, the parameter indicates the time when the trial period ends.
InDebt Integer 1

Indicates whether the WAF instance has overdue payments. Valid values:

  • 0: The instance has overdue payments.
  • 1: The instance does not have overdue payments and is running as normal.
Note This parameter is valid only when the WAF instance uses the pay-as-you-go billing method.
InstanceId String waf_elasticity-cn-0xldbqt****

The ID of the WAF instance.

PayType Integer 2

The type of the WAF instance:

  • 0: No WAF instances are purchased, or WAF is not activated.
  • 1: subscription WAF instance.
  • 2: pay-as-you-go WAF instance.
Region String cn

The region where the WAF instance resides.

  • cn: mainland China
  • cn-hongkong: outside mainland China
RemainDay Integer 0

The number of remaining days before the trial period of the WAF instance ends.

Note This parameter is valid only when the WAF instance that is for trial uses the pay-as-you-go billing method.
Status Integer 0

Indicates whether the WAF instance has expired. Valid values:

  • 0: The instance has expired.
  • 1: The instance is not expired and is running as normal.
Note This parameter is valid only when the WAF instance uses the subscription billing method.
SubscriptionType String PayAsYouGo

The billing method of the WAF instance:

  • Subscription: subscription
  • PayAsYouGo: pay-as-you-go
Trial Integer 0

Indicates whether the WAF instance is for trial. Valid value:

  • 0: The WAF instance is not for trial.
  • 1: The WAF instance is for trial.
Note This parameter is valid only when the WAF instance uses the pay-as-you-go billing method.
RequestId String D7861F61-5B61-46CE-A47C-6B19160D5EB0

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeInstanceInfo
&<Common request parameters>

Sample success responses

XML format 

<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 format 

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

Error codes

For a list of error codes, visit the API Error Center.