返回结果

发送请求消息后，您会收到服务端的响应，返回结果中包含状态码、响应消息头和响应消息体。

状态码

状态码表示请求响应的状态，是一组1XX到5XX的数字代码。

• 状态码为 200，则表示接口请求成功。
• 非 200 状态码均表示接口请求失败。具体信息，以 JSON 格式返回。

响应 Header

对应请求 Header，响应同样也有 Header，如Content-Type。

响应 Body

响应 Body 通常以JSON结构化格式返回，与响应 Header 中Content-Type对应，传递除响应消息头之外的内容。

• 状态码为 200，表示请求成功。此时服务端返回结果中包含 ResponseMetadata 和 Result 两部分。
• 所有非 200 的状态码，表示请求失败。失败信息以 JSON 格式返回，返回内容中包括 Error 字段，Error 字段由 Code 和 Message 组成。

返回示例

请求成功返回示例

{
    "ResponseMetadata": {
        "RequestId": "202311161734246BEE1DD4ED914596****",
        "Action": "DescAttackEvent",
        "Version": "2022-01-01",
        "Service": "origin_defence",
        "Region": "cn-beijing"
    },
    "Result": {
        "AttackedIpNum": 1,
        "TotalIpNum": 3,
        "AttackCount": 3,
        "Attacks": [
            {
                "Id": 606,
                "AttackType": "SYN Flood",
                "Ip": "180.184.**.**",
                "Status": 2,
                "PeakDropKbps": 80817,
                "PeakDropPps": 152646,
                "Duration": 4269,
                "StartTime": 1693920180,
                "EndTime": 1693924449
            },
            {
                "Id": 604,
                "AttackType": "SYN Flood",
                "Ip": "180.184.**.**",
                "Status": 2,
                "PeakDropKbps": 32796,
                "PeakDropPps": 61950,
                "Duration": 1869,
                "StartTime": 1693915020,
                "EndTime": 1693916890
            },
            {
                "Id": 603,
                "AttackType": "SYN Flood",
                "Ip": "180.184.**.**",
                "Status": 2,
                "PeakDropKbps": 32998,
                "PeakDropPps": 62005,
                "Duration": 14319,
                "StartTime": 1693832970,
                "EndTime": 1693847290
            }
        ]
    },
    "PageInfo": {
        "TotalCount": 3,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 3
    }
}

• ResponseMetadata及其内部的RequestId、Action、Version、Service、Region是固定的字段，无论请求成功与否，只要发起了 API 请求，必定会返回。
• RequestId是一个 API 请求的唯一标识，如果 API 出现异常，您可以通过该 ID 来帮助定位问题。
• Result是固定字段，字段内容由不同的产品自行定义。

请求失败返回示例

{
    "ResponseMetadata": {
        "RequestId": "202311162217351213A5DE0CBE8B9F053E",
        "Action": "DescInstanceLit",
        "Version": "2022-01-01",
        "Service": "origin_defence",
        "Region": "cn-beijing",
        "Error": {
            "CodeN": 100008,
            "Code": "InvalidActionOrVersion",
            "Message": "Could not find operation DescInstanceLit for version 2022-01-01"
        }
    }
}

• 请求调用失败时，不会返回Result字段。
• 请求调用失败会出现Error字段，Error 字段由 Code 和 Message 组成，其中：
  • Code表示具体出错的错误码，您可根据错误码自助解决问题。
  • Message表示错误信息，描述了错误发生的具体原因，供您排查问题参考。随着业务发展或体验优化，此文本可能会经常保持变更或更新，不建议完全依赖这个返回值。