All Products
Search

This Product

    Anti-DDoS:QueryNetList

    Document Center

    Anti-DDoS:QueryNetList

    最終更新日:Oct 17, 2024

    Queries the CIDR blocks of an anti-DDoS diversion instance.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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
    NetstringNo

    The CIDR block of the anti-DDoS diversion instance.

    Note If no extended CIDR blocks are configured for the anti-DDoS diversion instance, this parameter specifies the CIDR block of the instance. If an extended CIDR block is configured for the anti-DDoS diversion instance, this parameter specifies the extended CIDR block that is configured for the instance. If this parameter is specified, the MainNet parameter is required.
    		192.168.XX.XX/24
    ModestringNo

    The scheduling mode. Valid values:

    • manual: manual scheduling
    • netflow-auto: automatic scheduling
    		netflow-auto
    MainNetstringNo

    The primary CIDR block of the anti-DDoS diversion instance for which an extended CIDR block is configured. If no extended CIDR blocks are configured for the anti-DDoS diversion instance, leave this parameter empty.

    		192.168.XX.XX/22
    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.

    		24B652B5-AEFF-3F03-9114-00D053C42277
    Messagestring

    The response parameters.

    		successful
    Dataobject

    The CIDR blocks.

    Totallong

    The total number of entries returned.

    		1
    Pagelong

    The page number.

    		1
    Numlong

    The number of entries per page. Valid values: 1 to 100. Default value: 100.

    		100
    Netsarray<object>

    The CIDR blocks.

    netsobject
    UserIdstring

    The user ID.

    		177xxxxxxxxxxxxx
    SaleIdstring

    The ID of the anti-DDoS diversion instance.

    		ddos_diversion_public_cn-xxxxxxxxxxxxx
    UpstreamTypestring

    The reinjection type. Valid values:

    • aliyun_line
    • pccw_line
    • gre_line
    • private_line
    		aliyun_line
    Netstring

    The CIDR block of the anti-DDoS diversion instance.

    		192.168.XX.XX/24
    NetTypestring

    The type of the CIDR block.

    		ipv4
    Modestring

    The scheduling mode. Valid values:

    • netflow-auto
    • manual
    		manual
    DeclaredStateinteger

    The advertising status of the CIDR block. Valid values:

    • 0: The CIDR block is not advertised.
    • 1: The CIDR block is advertised.
    		1
    Declaredarray<object>

    The advertising details.

    declaredobject
    Regionstring

    The region in which the CIDR block is advertised. Valid values:

    • oe26: China (Hong Kong).
    • us50: US (Virginia).
    • oe24: US (Silicon Valley).
    • oe28: Singapore.
    • jp141: Japan (Tokyo).
    • Gb145: UK (London).
    • oi39: Germany (Frankfurt).
    		oe26
    Declaredstring

    Indicates whether the CIDR block is advertised. Valid values:

    • 0: The CIDR block is not advertised.
    • 1: The CIDR block is advertised.
    		0
    GmtCreatestring

    The creation time.

    		2023-02-23 00:00:00
    GmtModifystring

    The modification time.

    		2023-02-24 00:00:00
    NetExtendstring

    Indicates whether the CIDR block needs to be extended. Valid values:

    • 0: The CIDR block does not need to be extended.
    • 1: The CIDR block needs to be extended.
    		1
    DDoSDefenseobject

    The DDoS mitigation configuration of the CIDR block.

    DjPolicyobject

    The configuration of the mitigation policy.

    PolicyNamestring

    The name of the mitigation policy.

    		test_polilciy-xxx
    CleanThobject

    The configuration of traffic scrubbing.

    Mbpsinteger

    The traffic scrubbing threshold in Mbit/s.

    		0
    Ppsinteger

    The traffic scrubbing threshold in packets per second (pps).

    		0
    HoleThobject

    The configuration of blackhole filtering.

    ThreshMbpsinteger

    The blackhole filtering threshold in Mbit/s. The value 0 indicates best-effort protection.

    		0
    FwdEffectlong

    Indicates whether the forwarding configuration takes effect. Valid values:

    • 0: The forwarding configuration does not take effect.
    • 1: The forwarding configuration takes effect.
    		1
    NetMaininteger

    The primary CIDR block of the anti-DDoS diversion instance for which an extended CIDR block is configured. If no extended CIDR blocks are configured for the anti-DDoS diversion instance, this parameter is left empty.

    		192.168.XX.XX/22
    Permitinteger

    The review status. Valid values:

    • 0: not reviewed.
    • 1: reviewed.
    • 2: under review.
    		2

    Examples

    Sample success responses

    JSONformat

    {
  "Code": 200,
  "RequestId": "24B652B5-AEFF-3F03-9114-00D053C42277",
  "Message": "successful",
  "Data": {
    "Total": 1,
    "Page": 1,
    "Num": 100,
    "Nets": [
      {
        "UserId": "177xxxxxxxxxxxxx\n",
        "SaleId": "ddos_diversion_public_cn-xxxxxxxxxxxxx",
        "UpstreamType": "aliyun_line\n",
        "Net": "192.168.XX.XX/24\n",
        "NetType": "ipv4\n",
        "Mode": "manual\n",
        "DeclaredState": 1,
        "Declared": [
          {
            "Region": "oe26\n",
            "Declared": "0"
          }
        ],
        "GmtCreate": "2023-02-23 00:00:00\n",
        "GmtModify": "2023-02-24 00:00:00\n",
        "NetExtend": "1",
        "DDoSDefense": {
          "DjPolicy": {
            "PolicyName": "test_polilciy-xxx"
          },
          "CleanTh": {
            "Mbps": 0,
            "Pps": 0
          },
          "HoleTh": {
            "ThreshMbps": 0
          }
        },
        "FwdEffect": 1,
        "NetMain": 0,
        "Permit": 2
      }
    ]
  }
}

    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-09-18The Error code has changed. The response structure of the API has changedView Change Details
    2024-09-05The Error code has changed. The response structure of the API has changedView Change Details
    2024-04-28The Error code has changed. The response structure of the API has changedView Change Details
    2023-12-12The Error code has changedView Change Details
    2023-12-11The Error code has changedView Change Details