Generates a diagnosis report for a Smart Access Gateway (SAG) device.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DiscribeSmartAccessGatewayDiagnosisReport

The operation that you want to perform. Set the value to DiscribeSmartAccessGatewayDiagnosisReport.

SmartAGId String Yes sag-1um5x5nwhilymw****

The ID of the SAG instance.

SmartAGSn String Yes sage62x022502****

The serial number of the SAG device.

RegionId String Yes cn-shanghai

The ID of the region where the SAG instance is deployed.

You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter Type Example Description
RequestId String D7D6E3AB-D41A-42E3-8D4E-97B145F4B7C3

The ID of the request.

DiagnoseResult Object

The diagnosis report of the SAG device.

Percent Integer 100

The completion percentage of the diagnosis report.

SN String sag42c3****

The serial number of the SAG device.

DiagnoseId String dia-sag42c3t703trh02olv5rf****

The ID of the diagnosis.

State String finished

The diagnosis status. Valid values:

  • processing: The SAG device is being diagnosed.
  • finished: The SAG device is diagnosed.
  • failed: The system failed to diagnose the SAG device.
  • error: A diagnostic error occurred.
  • upload_to_sls_fail: The system failed to upload the diagnosis report.
UserLevel String user

The type of user that initiated the diagnostics. The value is set to user.

BoxVersion String 2.1.0

The version of the SAG device.

InstanceId String sag-0nnteglltw6z4b***

The ID of the SAG instance.

BoxType String sag-1000

The model of the SAG device.

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

The version of the monitoring feature that is used by the SAG device.

FinishedNumber Integer 15

The number of items that are diagnosed.

Details Array of Detail

The list of diagnoses that are returned.

Type String config

The type of the diagnosis. Valid values:

  • config: SAG configuration
  • internet: quality of connections to the Internet
  • biz: service quality
Items Array of Item

The list of items diagnosed.

Type String config

The type of the item. Valid values:

  • config: SAG configuration
  • internet: quality of connections to the Internet
  • biz: service quality
EndTime Long 1602741570596

The timestamp when the system finishes diagnosing the item.

StartTime Long 1602741570567

The timestamp when the system starts to diagnose the item.

CN Object

The diagnosis report in Chinese.

Advice Array of String Check the Express Connect circuit, and perform operations on the Management page.

The suggestion for the diagnosis.

ItemName String Dedicated connection port check

The name of the item.

ItemLevel String INFO

The diagnosis level of the item. Valid values:

  • ERROR: indicates that the item has an issue that may affect your services. We recommend that you handle the issue at the earliest opportunity.
  • WARNING: indicates that the item has an issue. You can handle the issue based on your business requirements.
  • INFO: indicates that the item is working as expected. No additional operation is required.
ItemType String Config

The type of the item. Valid values:

  • Config: SAG configuration
  • Service: service quality
  • Internet: quality of connections to the Internet
Details Array of String Port 4 has an abnormal Express Connect circuit or lacks a port IP address.

The diagnosis.

ItemName String eccConfigCheck

The name of the item, which is the unique identifier of the item.

EN Object

The diagnosis report in English.

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

The suggestion for the diagnosis.

ItemName String Express Connect Port Configuration

The name of the item.

ItemLevel String ERROR

The diagnosis level of the item. Valid values:

  • ERROR: indicates that the item has an issue that may affect your services. We recommend that you handle the issue at the earliest opportunity.
  • WARNING: indicates that the item has an issue. You can handle the issue based on your business requirements.
  • INFO: indicates that the item is working as expected. No additional operation is required.
ItemType String Config

The type of the item. Valid values:

  • Config: SAG configuration
  • Service: service quality
  • Internet: quality of connections to the 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

The diagnosis.

Level String error

The diagnosis level of the item. Valid values:

  • error: severe
  • warning: warning
  • info: normal
Statistics Object

The information about items of each diagnosis level for the current diagnosis type.

Warning Integer 2

The number of items of the WARNING level.

Error Integer 5

The number of items of the ERROR level.

Total Integer 10

The total number of items for the current diagnosis type.

Info Integer 3

The number of items of the INFO level.

UId String 1688000000000000

The user ID (UID) of the Alibaba Cloud account to which the SAG instance belongs.

EndTime Integer 160274157

The timestamp when the system finishes diagnosing the item.

StartTime Integer 160274157

The timestamp when the system starts to diagnose the item.

StoreType String both

The storage type.

The value is set to both, which indicates that the data is stored in the SAG device and Log Service.

ReportSLSSuccess Integer 0

The status of the diagnosis report to be uploaded to Log Service.

  • 0: The system failed to upload the report.
  • 1: The system has uploaded the report to Log Service.
TotalNumber Integer 15

The total number of entries returned.

Level Object

The diagnosis level.

Configuration String info

The diagnosis level of the SAG configuration.

Total String error

The overall diagnosis level.

  • error: severe
  • warning: warning
  • info: normal
Biz String warning

The diagnosis level of the service quality.

Statistics Object

The overall diagnosis level.

Warning Integer 3

The number of items of the WARNING level.

Error Integer 2

The number of items of the ERROR level.

Total Integer 10

The total number of items.

Info Integer 5

The number of items of the INFO level.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DiscribeSmartAccessGatewayDiagnosisReport
&RegionId=cn-shanghai
&SmartAGId=sag-1um5x5nwhilymw****
&SmartAGSn=sage62x022502****
&<Common request parameters>

Sample success responses

XML format

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>ERROR</ItemLevel>
                    <Details>All dedicated connection ports have abnormal Express Connect circuits or lack port IP addresses:</Details>
                    <Details>Port 4</Details>
                    <ItemType>Configuration</ItemType>
                    <ItemName>Dedicated connection port check</ItemName>
                    <Advice>Check the Express Connect circuit, and perform operations on the Management page.</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>INFO</ItemLevel>
                    <Details>The high availability (HA) feature is correctly configured and the peer is working as expected</Details>
                    <ItemType>Configuration</ItemType>
                    <ItemName>HA configuration check</ItemName>
                    <Advice>None</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>INFO</ItemLevel>
                    <Details>The device is connected to Alibaba Cloud over TCP</Details>
                    <ItemType>Service</ItemType>
                    <ItemName>Connection check between the device and Alibaba Cloud over TCP</ItemName>
                    <Advice>None</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>INFO</ItemLevel>
                    <Details>The tunnels are working as expected:</Details>
                    <Details>The packet loss rate of the primary IPsec tunnel is 0.00% and the latency is 1.25 milliseconds</Details>
                    <Details>The packet loss rate of the secondary IPsec tunnel is 0.00% and the latency is 1.40 milliseconds</Details>
                    <ItemType>Service</ItemType>
                    <ItemName>Tunnel quality check</ItemName>
                    <Advice>None</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>INFO</ItemLevel>
                    <Details>DNS resolution is working as expected</Details>
                    <ItemType>Internet</ItemType>
                    <ItemName>DNS resolution check</ItemName>
                    <Advice>None</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 format

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" : "ERROR",
          "Details" : [ "All dedicated connection ports have abnormal Express Connect circuits or lack port IP addresses:", "Port 4" ],
          "ItemType" : "Configuration",
          "ItemName" : "Dedicated connection port check",
          "Advice" : [ "Check the Express Connect circuit, and perform operations on the Management page" ]
        }
      }, {
        "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" : "INFO",
          "Details" : [ "The HA configuration is correct and the peer is working as expected" ],
          "ItemType" : "Configuration",
          "ItemName" : "HA configuration check",
          "Advice" : [ "None" ]
        }
      } ],
      "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" : "INFO",
          "Details" : [ "The device is connected to Alibaba Cloud over TCP" ],
          "ItemType" : "Service",
          "ItemName" : "Connection check between the device and Alibaba Cloud over TCP",
          "Advice" : [ "None" ]
        }
      }, {
        "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" : "INFO",
          "Details" : [ "The tunnels are working as expected:", "The packet loss rate of the primary IPsec tunnel is 0.00% and the latency is 1.25 milliseconds", "The packet loss rate of the primary IPsec tunnel is 0.00% and the latency is 1.40 milliseconds" ],
          "ItemType" : "Service",
          "ItemName" : "Tunnel quality check",
          "Advice" : [ "None" ]
        }
      } ],
      "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" : "INFO",
          "Details" : [ "DNS resolution is working as expected" ],
          "ItemType" : "Internet",
          "ItemName" : "DNS resolution check",
          "Advice" : [ "None" ]
        }
      } ],
      "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****"
  }
}

Error codes

HttpCode Error code Error message Description
403 MissingParameter The input parameter is missing, please check your input. The error message returned because one or more required parameters are not set. Check whether you have set all required parameters.

For a list of error codes, visit the API Error Center.