文档

DiscribeSmartAccessGatewayDiagnosisReport - 查询一键诊断报告

更新时间:

调用DiscribeSmartAccessGatewayDiagnosisReport接口查询智能接入网关SAG(Smart Access Gateway)设备诊断报告。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:DiscribeSmartAccessGatewayDiagnosisReportRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
SmartAGIdstring

智能接入网关实例 ID。

sag-1um5x5nwhilymw****
SmartAGSnstring

智能接入网关设备序列号。

sage62x022502****
RegionIdstring

智能接入网关实例所属地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-shanghai

返回参数

名称类型描述示例值
object

诊断结果。

RequestIdstring

请求 ID。

D7D6E3AB-D41A-42E3-8D4E-97B145F4B7C3
DiagnoseResultobject

智能接入网关设备诊断报告。

Percentinteger

诊断报告完成度百分比。

100
SNstring

智能接入网关设备序列号。

sag42c3****
DiagnoseIdstring

诊断 ID。

dia-sag42c3t703trh02olv5rf****
Statestring

诊断状态。

  • processing:诊断进行中。
  • finished:诊断成功。
  • failed:诊断失败。
  • error:诊断过程出现错误。
  • upload_to_sls_fail:诊断报告上传失败。
finished
UserLevelstring

发起诊断的用户类型。取值:user

user
BoxVersionstring

智能接入网关设备运行的软件版本。

2.1.0
InstanceIdstring

智能接入网关实例 ID。

sag-0nnteglltw6z4b***
BoxTypestring

智能接入网关设备类型。

  • sag-1000
  • sag-100WM
sag-1000
MonitorVersionstring

智能接入网关设备使用的监控版本。

2.0.2.9
FinishedNumberinteger

已完成的诊断项个数。

15
Detailsobject []

诊断结果信息列表。

Typestring

诊断类型。

  • config:SAG 配置。
  • internet:全网质量。
  • biz:业务质量。
config
Itemsobject []

诊断项详细信息列表。

Typestring

诊断项所属诊断类型。

  • config:SAG 配置。
  • internet:全网质量。
  • biz:业务质量。
config
EndTimelong

诊断项诊断结束时间戳。

1602741570596
StartTimelong

诊断项诊断开始时间戳。

1602741570567
CNobject

中文版诊断结果。

Advicearray

诊断建议。

string

诊断建议。

请先检查专线端口链路接线,然后进入本地“专线管理”页面进行配置。
ItemNamestring

诊断项名称。

专线口配置检查
ItemLevelstring

诊断项的诊断结果等级。

  • 严重:标识该诊断项问题可能会影响业务运行,建议优先处理。
  • 警告:标识该诊断项有问题,请依据建议酌情处理。
  • 正常:标识该诊断项正常运行,无需任何操作。
正常
ItemTypestring

诊断项所属诊断类型。

  • 配置:标识属于 SAG 配置类型。
  • 业务:标识属于业务质量类型。
  • 公网:标识属于全网质量类型。
配置
Detailsarray

诊断结果

string

诊断结果。

所有专线端口存在链路异常或缺少端口IP:端口4
ItemNamestring

诊断项名称,为诊断项唯一标识。

eccConfigCheck
ENobject

英文版诊断结果。

Advicearray

诊断建议。

string

诊断建议。

Check the physical connections to all Express connect ports and configure these ports on the 'Physical connection port' page.
ItemNamestring

诊断项名称。

Express Connect Port Configuration
ItemLevelstring

诊断项的诊断结果等级。

  • ERROR:标识该诊断项问题可能会影响业务运行,建议优先处理。
  • WARNING:标识该诊断项有问题,请依据建议酌情处理。
  • INFO:标识该诊断项正常运行,无需任何操作。
ERROR
ItemTypestring

诊断项所属诊断类型。

  • Config:标识属于 SAG 配置类型。
  • Service:标识属于业务质量类型。
  • Internet:标识属于全网质量类型。
Config
Detailsarray

诊断结果。

string

诊断结果。

The connection states of all Express connect ports are down and no IP address is specified for these ports: Port4
Levelstring

诊断项诊断结果等级。

  • error:严重。
  • warning:警告。
  • info:正常。
error
Statisticsobject

当前诊断类型下的诊断项等级统计信息列表。

Warninginteger

诊断结果等级为警告的诊断项数量。

2
Errorinteger

诊断结果等级为严重的诊断项数量。

5
Totalinteger

当前诊断类型下的诊断项总数。

10
Infointeger

诊断结果等级为正常的诊断项数量。

3
UIdstring

智能接入网关实例所属账号 ID。

1688000000000000
EndTimeinteger

诊断结束时间戳。

160274157
StartTimeinteger

诊断开始时间戳。

160274157
StoreTypestring

存储类型。

取值:both,表示同时存储在智能接入网关设备和日志服务 SLS(Log Service)中。

both
ReportSLSSuccessinteger

诊断报告上传至 SLS 中的状态。

  • 0:上传失败。
  • 1:上传成功。
0
TotalNumberinteger

诊断结果条目总数。

15
Levelobject

诊断结果等级。

Configurationstring

SAG 配置诊断结果等级。

info
Totalstring

整体诊断结果等级。

  • error:严重。
  • warning:警告。
  • info:正常。
error
Bizstring

业务质量诊断结果等级。

warning
Statisticsobject

整体诊断项结果统计信息。

Warninginteger

诊断结果等级为警告的诊断项总数量。

3
Errorinteger

诊断结果等级为严重的诊断项总数量。

2
Totalinteger

全部诊断项总数。

10
Infointeger

诊断结果等级为正常的诊断项总数量。

5

示例

正常返回示例

JSON格式

{
  "RequestId": "D7D6E3AB-D41A-42E3-8D4E-97B145F4B7C3",
  "DiagnoseResult": {
    "Percent": 100,
    "SN": "sag42c3****",
    "DiagnoseId": "dia-sag42c3t703trh02olv5rf****",
    "State": "finished",
    "UserLevel": "user",
    "BoxVersion": "2.1.0",
    "InstanceId": "sag-0nnteglltw6z4b***",
    "BoxType": "sag-1000",
    "MonitorVersion": "2.0.2.9",
    "FinishedNumber": 15,
    "Details": [
      {
        "Type": "config",
        "Items": [
          {
            "Type": "config",
            "EndTime": 1602741570596,
            "StartTime": 1602741570567,
            "CN": {
              "Advice": [
                "请先检查专线端口链路接线,然后进入本地“专线管理”页面进行配置。"
              ],
              "ItemName": "专线口配置检查",
              "ItemLevel": "正常",
              "ItemType": "配置",
              "Details": [
                "所有专线端口存在链路异常或缺少端口IP:端口4"
              ]
            },
            "ItemName": "eccConfigCheck",
            "EN": {
              "Advice": [
                "Check the physical connections to all Express connect ports and configure these ports on the 'Physical connection port' page."
              ],
              "ItemName": "Express Connect Port Configuration",
              "ItemLevel": "ERROR",
              "ItemType": "Config",
              "Details": [
                "The connection states of all Express connect ports are down and no IP address is specified for these ports: Port4"
              ]
            },
            "Level": "error"
          }
        ],
        "Statistics": {
          "Warning": 2,
          "Error": 5,
          "Total": 10,
          "Info": 3
        }
      }
    ],
    "UId": "1688000000000000",
    "EndTime": 160274157,
    "StartTime": 160274157,
    "StoreType": "both",
    "ReportSLSSuccess": 0,
    "TotalNumber": 15,
    "Level": {
      "Configuration": "info",
      "Total": "error",
      "Biz": "warning"
    },
    "Statistics": {
      "Warning": 3,
      "Error": 2,
      "Total": 10,
      "Info": 5
    }
  }
}

错误码

HTTP status code错误码错误信息描述
403MissingParameterThe input parameter is missing, please check your input.输入参数缺失,请检查您的输入。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史