配置指南

API 文档

获取诊断报告

最近更新时间:2021-02-04 08:14:18

我的收藏

1. 接口描述

接口请求域名: cdn.tencentcloudapi.com 。

DescribeDiagnoseReport 用于获取指定报告id的内容

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDiagnoseReport。
Version String 公共参数,本接口取值:2018-06-06。
Region String 公共参数,本接口不需要传递此参数。
ReportId String 报告ID

3. 输出参数

参数名称 类型 描述
BaskInfo DiagnoseData 诊断报告基础信息
CnameInfo DiagnoseData CNAME检测信息
ClientInfo DiagnoseData 客户端检测信息
DnsInfo DiagnoseData DNS检测信息
NetworkInfo DiagnoseData 网络检测信息
OcNodeInfo DiagnoseData 边缘节点检测信息
MidNodeInfo DiagnoseData 中间源节点检测信息
OriginInfo DiagnoseData 源站检测信息
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取诊断报告

输入示例

https://cdn.tencentcloudapi.com/?Action=DescribeDiagnoseReport
&ReportId=123
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "b3eee570-0d5f-46b2-89a3-160f4e654eaf",
    "BaskInfo": {
      "Data": [
        {
          "Key": "report_id",
          "KeyText": "报告ID",
          "Value": "123",
          "ValueText": "123"
        },
        {
          "Key": "diagnose_url",
          "KeyText": "诊断URL",
          "Value": "http://www.test.com/1.txt",
          "ValueText": "http://www.test.com/1.txt"
        },
        {
          "Key": "diagnose_time",
          "KeyText": "诊断时间",
          "Value": "2020-09-21 12:00:16",
          "ValueText": "2020-09-21 12:00:16"
        }
      ],
      "Status": "ok"
    },
    "CnameInfo": {
      "Status": "ok",
      "Data": [
        {
          "Key": "cname",
          "KeyText": "解析配置",
          "Value": "CNAME www.test.com.cdn.dnsv1.com<br>",
          "ValueText": "CNAME www.test.com.cdn.dnsv1.com<br>"
        }
      ]
    },
    "ClientInfo": {
      "Status": "ok",
      "Data": [
        {
          "Key": "ip",
          "KeyText": "客户端IP",
          "Value": "1.1.1.1",
          "ValueText": "1.1.1.1"
        },
        {
          "Key": "prov_isp",
          "KeyText": "所在区域",
          "Value": "广东省-中国电信",
          "ValueText": "广东省-中国电信"
        },
        {
          "Key": "request",
          "KeyText": "请求详情",
          "Value": "--",
          "ValueText": "--"
        }
      ]
    },
    "DnsInfo": {
      "Data": [
        {
          "Key": "dns",
          "KeyText": "DNS IP",
          "Value": "183.3.229.15 广东省-中国电信<br>219.133.40.12 广东省-中国电信<br>",
          "ValueText": "183.3.229.15 广东省-中国电信<br>219.133.40.12 广东省-中国电信<br>"
        }
      ],
      "Status": "ok"
    },
    "NetworkInfo": {
      "Status": "ok",
      "Data": [
        {
          "Key": "network",
          "KeyText": "探测延迟",
          "Value": "123ms",
          "ValueText": "123ms"
        }
      ]
    },
    "OcNodeInfo": {
      "Status": "error",
      "Data": [
        {
          "Key": "ip",
          "KeyText": "节点IP",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "area",
          "KeyText": "所在区域",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "code",
          "KeyText": "状态码",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "md5",
          "KeyText": "文件MD5",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "hit",
          "KeyText": "命中情况",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "solution",
          "KeyText": "解决方案",
          "Value": "--",
          "ValueText": "--"
        }
      ]
    },
    "MidNodeInfo": {
      "Data": [
        {
          "Key": "ip",
          "KeyText": "节点IP",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "area",
          "KeyText": "所在区域",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "hit",
          "KeyText": "命中情况",
          "Value": "--",
          "ValueText": "--"
        }
      ],
      "Status": "initial"
    },
    "OriginInfo": {
      "Status": "initial",
      "Data": [
        {
          "Key": "ip",
          "KeyText": "源站IP",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "area",
          "KeyText": "所在区域",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "fwd_host",
          "KeyText": "回源host",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "code",
          "KeyText": "状态码",
          "Value": "--",
          "ValueText": "--"
        },
        {
          "Key": "md5",
          "KeyText": "文件MD5",
          "Value": "--",
          "ValueText": "--"
        }
      ]
    }
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.CdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.CdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InvalidParameter.CdnParamError 参数错误,请参考文档中示例参数填充。
ResourceNotFound.CdnUserNotExists 未开通CDN服务,请开通后使用此接口。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
目录