All Products
Search
Document Center

Anti-DDoS:DescribeBlackholeStatus

Last Updated:Oct 08, 2024

Queries the blackhole filtering 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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-ddoscoo:DescribeBlackholeStatusget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdsarrayYes

The ID of the instance.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.
stringYes

The ID of the instance.

ddoscoo-cn-mp91j1ao****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E
BlackholeStatusarray<object>

An array that consists of the blackhole filtering status of the instance.

BlackholeStatusobject
EndTimelong

The end time of blackhole filtering. The value is a UNIX timestamp. Unit: seconds.

1540196323
StartTimelong

The start time of blackhole filtering. The value is a UNIX timestamp. Unit: seconds.

1540195323
Ipstring

The IP address of the instance.

203.***.***.132
BlackStatusstring

Indicates whether blackhole filtering is triggered for the instance. Valid values:

  • blackhole: yes
  • normal: no
blackhole

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.