Queries the black hole status of one or more Anti-DDoS Pro or Anti-DDoS Premium instances.

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 DescribeBlackholeStatus

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

InstanceIds.N RepeatList Yes ddoscoo-cn-mp91j1ao****

The ID of instance N.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.
RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance

Response parameters

Parameter Type Example Description
BlackholeStatus Array

Details about the black hole status of the instance.

BlackStatus String blackhole

Indicates whether the instance is in the Blackhole state. Valid values:

  • blackhole: The instance is in the Blackhole state.
  • normal: The instance is in the Normal state.
EndTime Long 1540196323

The end time of the black hole. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

Ip String 203.***. ***.132

The IP address of the instance.

StartTime Long 1540195323

The start time of the black hole. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

RequestId String C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeBlackholeStatus
&InstanceIds.1=ddoscoo-cn-mp91j1ao****
&<Common request parameters>

Sample success responses

XML format

<DescribeBlackholeStatusResponse>
      <RequestId>C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E</RequestId>
      <BlackholeStatus>
            <Ip>203. ***. ***.132</Ip>
            <BlackStatus>blackhole</BlackStatus>
            <StartTime>1540195323</StartTime>
            <EndTime>1540196323</EndTime>
      </BlackholeStatus>
</DescribeBlackholeStatusResponse>

JSON format

{
    "RequestId": "C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E",
    "BlackholeStatus": [{
        "Ip": "203. ***. ***.132",
        "BlackStatus": "blackhole",
        "StartTime": 1540195323,
        "EndTime": 1540196323
    }]
}

Error codes

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