All Products
Search
Document Center

Anti-DDoS:DescribeBlockStatus

Last Updated:Apr 24, 2024

Queries the Diversion from Origin Server configurations of one or more Anti-DDoS Proxy (Chinese Mainland) instances.

Operation description

This operation is used to query the Diversion from Origin Server configurations of one or more Anti-DDoS Pro instances.

Note This operation is suitable only for Anti-DDoS Pro.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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:DescribeBlockStatusRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

The ID of the resource group to which the instance belongs in Resource Management.

If you do not configure this parameter, the instance belongs to the default resource group.

rg-acfm2pz25js****
InstanceIdsarrayYes

An array consisting of information about the IDs of the instances that you want to query.

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

The ID of the instance.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.
ddoscoo-cn-zvp2eibz****

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E
StatusListobject []

An array that consists of details of the Diversion from Origin Server configurations of the instance.

Ipstring

The IP address of the instance.

203.XX.XX.88
BlockStatusListobject []

An array that consists of details of the Diversion from Origin Server configuration.

EndTimelong

The end time of the blocking. This value is a UNIX timestamp. Unit: seconds.

1540196323
StartTimelong

The start time of the blocking. This value is a UNIX timestamp. Unit: seconds.

1540195323
Linestring

The Internet service provider (ISP) line from which the traffic is blocked. Valid values:

  • ct: China Telecom (International)
  • cut: China Unicom (International)
cut
BlockStatusstring

The blocking status of the network traffic. Valid values:

  • areablock: Network traffic is blocked.
  • normal: Network traffic is not blocked.
areablock

Examples

Sample success responses

JSONformat

{
  "RequestId": "C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E",
  "StatusList": [
    {
      "Ip": "203.XX.XX.88",
      "BlockStatusList": [
        {
          "EndTime": 1540196323,
          "StartTime": 1540195323,
          "Line": "cut",
          "BlockStatus": "areablock"
        }
      ]
    }
  ]
}

Error codes

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