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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DiscribeSmartAccessGatewayDiagnosisReport

要执行的操作。取值:DiscribeSmartAccessGatewayDiagnosisReport

SmartAGId String sag-1um5x5nwhilymw****

智能接入网关实例ID。

SmartAGSn String sage62x022502****

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

RegionId String cn-shanghai

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

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

返回数据

名称 类型 示例值 描述
RequestId String D7D6E3AB-D41A-42E3-8D4E-97B145F4B7C3

请求ID。

DiagnoseResult Object

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

Percent Integer 100

诊断报告完成度百分比。

SN String sag42c3****

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

DiagnoseId String dia-sag42c3t703trh02olv5rf****

诊断ID。

State String finished

诊断状态。

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

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

BoxVersion String 2.1.0

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

InstanceId String sag-0nnteglltw6z4b***

智能接入网关实例ID。

BoxType String sag-1000

智能接入网关设备类型。

  • sag-1000
  • sag-100WM
MonitorVersion String 2.0.2.9

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

FinishedNumber Integer 15

已完成的诊断项个数。

Details Array of Detail

诊断结果信息列表。

Type String config

诊断类型。

  • config:SAG配置。
  • internet:全网质量。
  • biz:业务质量。
Items Array of Item

诊断项详细信息列表。

Type String config

诊断项所属诊断类型。

  • config:SAG配置。
  • internet:全网质量。
  • biz:业务质量。
EndTime Long 1602741570596

诊断项诊断结束时间戳。

StartTime Long 1602741570567

诊断项诊断开始时间戳。

CN Object

中文版诊断结果。

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

诊断建议。

ItemName String 专线口配置检查

诊断项名称。

ItemLevel String 正常

诊断项的诊断结果等级。

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

诊断项所属诊断类型。

  • 配置:标识属于SAG配置类型。
  • 业务:标识属于业务质量类型。
  • 公网:标识属于全网质量类型。
Details Array of String 所有专线端口存在链路异常或缺少端口IP:端口4

诊断结果。

ItemName String eccConfigCheck

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

EN Object

英文版诊断结果。

Advice Array of String Check the physical connections to all Express connect ports and configure these ports on the 'Physical connection port' page.

诊断建议。

ItemName String Express Connect Port Configuration

诊断项名称。

ItemLevel String ERROR

诊断项的诊断结果等级。

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

诊断项所属诊断类型。

  • Config:标识属于SAG配置类型。
  • Service:标识属于业务质量类型。
  • Internet:标识属于全网质量类型。
Details Array of String The connection states of all Express connect ports are down and no IP address is specified for these ports: Port4

诊断结果。

Level String error

诊断项诊断结果等级。

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

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

Warning Integer 2

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

Error Integer 5

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

Total Integer 10

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

Info Integer 3

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

UId String 1688000000000000

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

EndTime Integer 160274157

诊断结束时间戳。

StartTime Integer 160274157

诊断开始时间戳。

StoreType String both

存储类型。

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

ReportSLSSuccess Integer 0

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

  • 0:上传失败。
  • 1:上传成功。
TotalNumber Integer 15

诊断结果条目总数。

Level Object

诊断结果等级。

Configuration String info

SAG配置诊断结果等级。

Total String error

整体诊断结果等级。

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

业务质量诊断结果等级。

Statistics Object

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

Warning Integer 3

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

Error Integer 2

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

Total Integer 10

全部诊断项总数。

Info Integer 5

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

示例

请求示例

http(s)://[Endpoint]/?Action=DiscribeSmartAccessGatewayDiagnosisReport
&RegionId=cn-shanghai
&SmartAGId=sag-1um5x5nwhilymw****
&SmartAGSn=sage62x022502****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DiscribeSmartAccessGatewayDiagnosisReportResponse>
    <RequestId>1BC73F52-5104-4E77-8F4C-80E5B1ED9D21</RequestId>
    <DiagnoseResult>
        <EndTime>1602741571690</EndTime>
        <Percent>100</Percent>
        <UserLevel>user</UserLevel>
        <InstanceId>sag-0nnteglltw6z4b****</InstanceId>
        <FinishedNumber>5</FinishedNumber>
        <StartTime>1602741570554</StartTime>
        <BoxType>sag-1000</BoxType>
        <Statistics>
            <Warning>0</Warning>
            <Total>5</Total>
            <Error>1</Error>
            <Info>4</Info>
        </Statistics>
        <StoreType>both</StoreType>
        <MonitorVersion>2.0.2.9</MonitorVersion>
        <UId>1688000000000000</UId>
        <ReportSLSSuccess>0</ReportSLSSuccess>
        <Details>
            <Type>config</Type>
            <Items>
                <Type>config</Type>
                <EndTime>1602741570596</EndTime>
                <StartTime>1602741570567</StartTime>
                <ItemName>eccConfigCheck</ItemName>
                <EN>
                    <ItemLevel>ERROR</ItemLevel>
                    <Details>The connection states of all Express connect ports are down and no IP address is specified for these ports: </Details>
                    <Details>Port4</Details>
                    <ItemType>Config</ItemType>
                    <ItemName>Express Connect Port Configuration</ItemName>
                    <Advice>Check the physical connections to all Express connect ports and configure these ports on the 'Physical connection port' page.</Advice>
                </EN>
                <Level>error</Level>
                <CN>
                    <ItemLevel>严重</ItemLevel>
                    <Details>所有专线端口存在链路异常或缺少端口IP:</Details>
                    <Details>端口4</Details>
                    <ItemType>配置</ItemType>
                    <ItemName>专线口配置检查</ItemName>
                    <Advice>请先检查专线端口链路接线,然后进入本地'专线管理'页面进行配置</Advice>
                </CN>
            </Items>
            <Items>
                <Type>config</Type>
                <EndTime>1602741570600</EndTime>
                <StartTime>1602741570587</StartTime>
                <ItemName>haConfigCheck</ItemName>
                <EN>
                    <ItemLevel>INFO</ItemLevel>
                    <Details>The configurations for HA are correct and the state of the peer is normal.</Details>
                    <ItemType>Config</ItemType>
                    <ItemName>HA Configuration</ItemName>
                    <Advice>N/A</Advice>
                </EN>
                <Level>info</Level>
                <CN>
                    <ItemLevel>正常</ItemLevel>
                    <Details>HA配置正确且对端状态正常</Details>
                    <ItemType>配置</ItemType>
                    <ItemName>HA配置检查</ItemName>
                    <Advice>无</Advice>
                </CN>
            </Items>
            <Statistics>
                <Warning>0</Warning>
                <Total>2</Total>
                <Error>1</Error>
                <Info>1</Info>
            </Statistics>
        </Details>
        <Details>
            <Type>biz</Type>
            <Items>
                <Type>biz</Type>
                <EndTime>1602741570641</EndTime>
                <StartTime>1602741570610</StartTime>
                <ItemName>ctrlConnState</ItemName>
                <EN>
                    <ItemLevel>INFO</ItemLevel>
                    <Details>The state of the TCP connection to the management console is normal.</Details>
                    <ItemType>Service</ItemType>
                    <ItemName>Management Console Connection</ItemName>
                    <Advice>N/A</Advice>
                </EN>
                <Level>info</Level>
                <CN>
                    <ItemLevel>正常</ItemLevel>
                    <Details>与管控TCP连接状态正常</Details>
                    <ItemType>业务</ItemType>
                    <ItemName>管控TCP连接检查</ItemName>
                    <Advice>无</Advice>
                </CN>
            </Items>
            <Items>
                <Type>biz</Type>
                <EndTime>1602741570829</EndTime>
                <StartTime>1602741570803</StartTime>
                <ItemName>agwTunnelQuality</ItemName>
                <EN>
                    <ItemLevel>INFO</ItemLevel>
                    <Details>The tunnel quality is high:</Details>
                    <Details>The packet loss rate for the primary IPSec tunnel is 0.00% and the latency is 1.25 ms.</Details>
                    <Details>The packet loss rate for the backup IPSec tunnel is 0.00% and the latency is 1.40 ms.</Details>
                    <ItemType>Service</ItemType>
                    <ItemName>Tunnel Quality</ItemName>
                    <Advice>N/A</Advice>
                </EN>
                <Level>info</Level>
                <CN>
                    <ItemLevel>正常</ItemLevel>
                    <Details>隧道质量良好:</Details>
                    <Details>IPSec主隧道丢包率0.00%,时延1.25ms</Details>
                    <Details>IPSec备隧道丢包率0.00%,时延1.40ms</Details>
                    <ItemType>业务</ItemType>
                    <ItemName>隧道质量检查</ItemName>
                    <Advice>无</Advice>
                </CN>
            </Items>
            <Statistics>
                <Warning>0</Warning>
                <Total>2</Total>
                <Error>0</Error>
                <Info>2</Info>
            </Statistics>
        </Details>
        <Details>
            <Type>internet</Type>
            <Items>
                <Type>internet</Type>
                <EndTime>1602741570637</EndTime>
                <StartTime>1602741570607</StartTime>
                <ItemName>dnsResolve</ItemName>
                <EN>
                    <ItemLevel>INFO</ItemLevel>
                    <Details>The domain names are resolved.</Details>
                    <ItemType>Internet</ItemType>
                    <ItemName>DNS Resolution</ItemName>
                    <Advice>N/A</Advice>
                </EN>
                <Level>info</Level>
                <CN>
                    <ItemLevel>正常</ItemLevel>
                    <Details>DNS解析正常</Details>
                    <ItemType>公网</ItemType>
                    <ItemName>DNS解析检查</ItemName>
                    <Advice>无</Advice>
                </CN>
            </Items>
            <Statistics>
                <Warning>1</Warning>
                <Total>1</Total>
                <Error>0</Error>
                <Info>1</Info>
            </Statistics>
        </Details>
        <State>finished</State>
        <DiagnoseId>dia-sag42c3t703frrpjsoezf********</DiagnoseId>
        <TotalNumber>5</TotalNumber>
        <Level>
            <Biz>info</Biz>
            <Configuration>error</Configuration>
            <Total>error</Total>
        </Level>
        <BoxVersion>2.1.0</BoxVersion>
        <SN>sag42c3****</SN>
    </DiagnoseResult>
</DiscribeSmartAccessGatewayDiagnosisReportResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1BC73F52-5104-4E77-8F4C-80E5B1ED9D21",
  "DiagnoseResult" : {
    "EndTime" : 1602741571690,
    "Percent" : 100,
    "UserLevel" : "user",
    "InstanceId" : "sag-0nnteglltw6z4b****",
    "FinishedNumber" : 5,
    "StartTime" : 1602741570554,
    "BoxType" : "sag-1000",
    "Statistics" : {
      "Warning" : 0,
      "Total" : 5,
      "Error" : 1,
      "Info" : 4
    },
    "StoreType" : "both",
    "MonitorVersion" : "2.0.2.9",
    "UId" : "1688000000000000",
    "ReportSLSSuccess" : 0,
    "Details" : [ {
      "Type" : "config",
      "Items" : [ {
        "Type" : "config",
        "EndTime" : 1602741570596,
        "StartTime" : 1602741570567,
        "ItemName" : "eccConfigCheck",
        "EN" : {
          "ItemLevel" : "ERROR",
          "Details" : [ "The connection states of all Express connect ports are down and no IP address is specified for these ports: ", "Port4" ],
          "ItemType" : "Config",
          "ItemName" : "Express Connect Port Configuration",
          "Advice" : [ "Check the physical connections to all Express connect ports and configure these ports on the 'Physical connection port' page." ]
        },
        "Level" : "error",
        "CN" : {
          "ItemLevel" : "严重",
          "Details" : [ "所有专线端口存在链路异常或缺少端口IP:", "端口4" ],
          "ItemType" : "配置",
          "ItemName" : "专线口配置检查",
          "Advice" : [ "请先检查专线端口链路接线,然后进入本地'专线管理'页面进行配置" ]
        }
      }, {
        "Type" : "config",
        "EndTime" : 1602741570600,
        "StartTime" : 1602741570587,
        "ItemName" : "haConfigCheck",
        "EN" : {
          "ItemLevel" : "INFO",
          "Details" : [ "The configurations for HA are correct and the state of the peer is normal." ],
          "ItemType" : "Config",
          "ItemName" : "HA Configuration",
          "Advice" : [ "N/A" ]
        },
        "Level" : "info",
        "CN" : {
          "ItemLevel" : "正常",
          "Details" : [ "HA配置正确且对端状态正常" ],
          "ItemType" : "配置",
          "ItemName" : "HA配置检查",
          "Advice" : [ "无" ]
        }
      } ],
      "Statistics" : {
        "Warning" : 0,
        "Total" : 2,
        "Error" : 1,
        "Info" : 1
      }
    }, {
      "Type" : "biz",
      "Items" : [ {
        "Type" : "biz",
        "EndTime" : 1602741570641,
        "StartTime" : 1602741570610,
        "ItemName" : "ctrlConnState",
        "EN" : {
          "ItemLevel" : "INFO",
          "Details" : [ "The state of the TCP connection to the management console is normal." ],
          "ItemType" : "Service",
          "ItemName" : "Management Console Connection",
          "Advice" : [ "N/A" ]
        },
        "Level" : "info",
        "CN" : {
          "ItemLevel" : "正常",
          "Details" : [ "与管控TCP连接状态正常" ],
          "ItemType" : "业务",
          "ItemName" : "管控TCP连接检查",
          "Advice" : [ "无" ]
        }
      }, {
        "Type" : "biz",
        "EndTime" : 1602741570829,
        "StartTime" : 1602741570803,
        "ItemName" : "agwTunnelQuality",
        "EN" : {
          "ItemLevel" : "INFO",
          "Details" : [ "The tunnel quality is high:", "The packet loss rate for the primary IPSec tunnel is 0.00% and the latency is 1.25 ms.", "The packet loss rate for the backup IPSec tunnel is 0.00% and the latency is 1.40 ms." ],
          "ItemType" : "Service",
          "ItemName" : "Tunnel Quality",
          "Advice" : [ "N/A" ]
        },
        "Level" : "info",
        "CN" : {
          "ItemLevel" : "正常",
          "Details" : [ "隧道质量良好:", "IPSec主隧道丢包率0.00%,时延1.25ms", "IPSec备隧道丢包率0.00%,时延1.40ms" ],
          "ItemType" : "业务",
          "ItemName" : "隧道质量检查",
          "Advice" : [ "无" ]
        }
      } ],
      "Statistics" : {
        "Warning" : 0,
        "Total" : 2,
        "Error" : 0,
        "Info" : 2
      }
    }, {
      "Type" : "internet",
      "Items" : [ {
        "Type" : "internet",
        "EndTime" : 1602741570637,
        "StartTime" : 1602741570607,
        "ItemName" : "dnsResolve",
        "EN" : {
          "ItemLevel" : "INFO",
          "Details" : [ "The domain names are resolved." ],
          "ItemType" : "Internet",
          "ItemName" : "DNS Resolution",
          "Advice" : [ "N/A" ]
        },
        "Level" : "info",
        "CN" : {
          "ItemLevel" : "正常",
          "Details" : [ "DNS解析正常" ],
          "ItemType" : "公网",
          "ItemName" : "DNS解析检查",
          "Advice" : [ "无" ]
        }
      } ],
      "Statistics" : {
        "Warning" : 1,
        "Total" : 1,
        "Error" : 0,
        "Info" : 1
      }
    } ],
    "State" : "finished",
    "DiagnoseId" : "dia-sag42c3t703frrpjsoezf********",
    "TotalNumber" : 5,
    "Level" : {
      "Biz" : "info",
      "Configuration" : "error",
      "Total" : "error"
    },
    "BoxVersion" : "2.1.0",
    "SN" : "sag42c3****"
  }
}

错误码

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

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