All Products
Search
Document Center

Anti-DDoS:ListInstance

Last Updated:Jul 05, 2024

Queries anti-DDoS diversion instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SaleIdstringNo

The ID of the anti-DDoS diversion instance.

ddos_diversion_public_cn-xxxxxxxxxxxxx
NamestringNo

The name of the instance.

StatusstringNo

The status of the instance. Valid values:

  • normal
  • expired
  • deleting
  • stopped
normal
PagelongNo

The page number. Default value: 1

1
NumlongNo

The number of entries per page. Default value: 100.

100

Response parameters

ParameterTypeDescriptionExample
object
Codelong

The status code.

  • 200: The request was successful.
  • Other codes: The request failed.
200
RequestIdstring

The request ID.

B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95
Messagestring

The response parameters.

successful
Dataarray<object>

The returned result.

object
Totallong

The total number of entries returned.

10
Pagelong

The page number.

1
Numlong

The number of entries per page.

100
Instancesarray<object>

The details of the anti-DDoS diversion instance.

object
UserIdstring

The user ID.

177xxxxxxxxxxxxx
SaleIdstring

The ID of the instance.

ddos_diversion_public_cn-xxxxxxxxxxxxx
InstanceIdstring

The alias of the instance.

ddos_diversion_public_cn-xxxxxxxxxxxxx_xxxxxx
Namestring

The name of the instance.

Statusstring

The status of the instance. Valid values:

  • normal
  • expired
  • deleting
  • stopped
normal
Commentstring

The description.

Messagestring

The configurations of the instance.

successful
Specobject

The specifications of the instance.

IdcNumbersstring

The number of data centers. Valid values: 1 to 10.

1
NormalBandwidthstring

The service traffic. Unit: Mbit/s.

100
IpSubnetNumsstring

The number of CIDR blocks. Value range: 1 to 10000.

1
Coveragestring

The region of the asset.

international_and_hmt
Editionstring

The mitigation plan.

enterprise
MitigationCapacitystring

The maximum mitigation capability.

unlimited
MitigationNumsstring

The number of mitigation sessions.

unlimited
DiversionTypestring

The diversion mode. Valid values: on-demand always-on

on-demand
MitigationAnalysisstring

The mitigation analysis feature.

off
MitigationAnalysisCapacitystring

The log storage capacity.

3T
InitialInstallationstring

The initial installation mode.

gre_tunnel_by_pccw
InitialQtystring

The initial installation quantity.

1
GmtExpirestring

The expiration time.

2023-02-23 00:00:00
GmtCreatestring

The purchase time.

2022-12-15 11:10:42
GmtModifystring

The update time.

2022-12-15 11:10:42

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "RequestId": "B0949F09-B9C1-1D5E-8F27-0A5BF3CD5D95",
  "Message": "successful",
  "Data": [
    {
      "Total": 10,
      "Page": 1,
      "Num": 100,
      "Instances": [
        {
          "UserId": "177xxxxxxxxxxxxx",
          "SaleId": "ddos_diversion_public_cn-xxxxxxxxxxxxx",
          "InstanceId": "ddos_diversion_public_cn-xxxxxxxxxxxxx_xxxxxx",
          "Name": "",
          "Status": "normal",
          "Comment": "",
          "Message": "successful",
          "Spec": {
            "IdcNumbers": "1",
            "NormalBandwidth": "100",
            "IpSubnetNums": "1",
            "Coverage": "international_and_hmt",
            "Edition": "enterprise",
            "MitigationCapacity": "unlimited",
            "MitigationNums": "unlimited",
            "DiversionType": "on-demand",
            "MitigationAnalysis": "off",
            "MitigationAnalysisCapacity": "3T",
            "InitialInstallation": "gre_tunnel_by_pccw",
            "InitialQty": "1"
          },
          "GmtExpire": "2023-02-23 00:00:00",
          "GmtCreate": "2022-12-15 11:10:42",
          "GmtModify": "2022-12-15 11:10:42"
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400AuthenticationFailedUser authentication failed.User authentication failed.
400AutoScheduleRuleExistThe auto schedule rule already exists.The scheduling rule already exists.
400AutoScheduleRuleNotExistThe auto schedule rule dose not exist.The scheduling rule does not exist.
400BlackHoleConfigurationErrorA black hole configuration error occurred.The blackhole filtering configuration is invalid.
400CleanConfigurationErrorA clean configuration error occurred.The traffic scrubbing configuration is invalid.
400CoveredNetThe CIDR block is overwritten.The specified CIDR block overlaps with another CIDR block.
400DatabaseErrorA database error.The database is invalid.
400DeclaredNetThe CIDR block has been advertised.The CIDR block is in the Advertising state.
400DefenseConfigurationErrorA defense configuration error occurred.The mitigation settings are invalid.
400ForwardConfigurationNotExistThe CIDR block forwarding configuration is not found.The forwarding configuration of the CIDR block does not exist.
400ForwardNotExistThe CIDR block zone forwarding configuration is not found.The zone forwarding configuration of the CIDR block does not exist.
400ForwardRuleNotExistThe CIDR block forwarding rule is not found.The CIDR block forwarding rule does not exist.
400HttpFailedHTTP request failed.The HTTP request failed.
400IDNSubnetsCountLimitThe maximum number of IDCs of the instance is exceeded.The number of data centers for the instance has reached the upper limit.
400InstanceExistThe instance already exists.The instance already exists.
400InstanceNetConfigurationExistThe instance CIDR block configuration already exists.The CIDR block configuration of the instance already exists.
400InstanceNotExistThe instance is not found.The instance does not exist.
400InstanceUpstreamLimitThe maximum number of reinjection configurations for the instance is exceeded.The number of reinjection configurations of the instance is limited.
400InternalErrorAn internal error occurred.An internal error occurred.
400InvalidNetInvalid CIDR block.The CIDR block is invalid.
400InvalidParamInvalid parameter value.The parameter is invalid.
400IPSubnetsCountLimitThe maximum number of CIDR blocks of the instance is exceeded.The number of CIDR blocks of the instance has reached the upper limit.
400JsonDecodeErrorJson string decoding failed.Failed to convert JSON string to JSON object.
400NetCannotExtendThe CIDR block cannot be extended.The CIDR block cannot be expanded.
400NetConfigurationExistThe CIDR block configuration already exists.The CIDR block configuration already exists.
400NetConfigurationNotExistThe CIDR block configuration is not found.The CIDR block configuration does not exist.
400NetForwardDeleteThe CIDR block forwarding is being deleted.The forwarding configuration of the CIDR block is being deleted.
400NetMaskOutOfRangeThe subnet mask of the CIDR block is invalid.The subnet mask exceeds the upper limit.
400NetNeedExtendThe CIDR block needs to be extended.The CIDR block needs to be expanded.
400NetStatusNotReadyThe CIDR block reinjection configuration has not been completed.Failed to complete the reinjection configuration of the CIDR block.
400NetworkDeclearedFailedFailed to advertise the CIDR block.Failed to advertise the CIDR block.
400NetWorkNotExistThe CIDR block is not found.The CIDR block does not exist.
400NetworkUndeclearedFailedFailed to cancel the advertisement of the CIDR block.Failed to withdraw the advertising of the CIDR block.
400ParameterNotEnoughRequired parameters are not specified.A required parameter is not specified.
400ParameterOutOfRangeInvalid parameter value.The value of the parameter is invalid.
400RegionNotExistThe region does not exist.The zone does not exist.
400RequestMethodErrorAn incorrect request method.The request method is invalid.
400SubnetCountLimitThe maximum number of subnets is exceeded.The number of subnets has reached the upper limit.
400UnKnownErrorAn unknown error occurred.An unknown error occurred.
400UpsteamNotCompleteThe reinjection configuration has not been completed.Failed to complete the reinjection configuration of the CIDR block.
400UpstreamConfigurationNotExistThe reinjection configuration is not found.The reinjection configuration does not exist.

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

Change history

Change timeSummary of changesOperation
2024-04-28The Error code has changed. The response structure of the API has changedView Change Details
2023-12-11The Error code has changedView Change Details