DiscribeSmartAccessGatewayDiagnosisReport - Smart Access Gateway

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:DiscribeSmartAccessGatewayDiagnosisReport	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
SmartAGId	string	Yes	The ID of the SAG instance.	sag-1um5x5nwhilymw****
SmartAGSn	string	Yes	The serial number of the SAG device.	sage62x022502****
RegionId	string	Yes	The ID of the region where the SAG instance is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	D7D6E3AB-D41A-42E3-8D4E-97B145F4B7C3
DiagnoseResult	object	The diagnosis report of the SAG device.
Percent	integer	The completion percentage of the diagnosis report.	100
SN	string	The serial number of the SAG device.	sag42c3****
DiagnoseId	string	The ID of the diagnosis.	dia-sag42c3t703trh02olv5rf****
State	string	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.	finished
UserLevel	string	The type of user that initiated the diagnostics. The value is set to user.	user
BoxVersion	string	The version of the SAG device.	2.1.0
InstanceId	string	The ID of the SAG instance.	sag-0nnteglltw6z4b***
BoxType	string	The model of the SAG device. sag-1000 sag-100WM	sag-1000
MonitorVersion	string	The version of the monitoring feature that is used by the SAG device.	2.0.2.9
FinishedNumber	integer	The number of items that are diagnosed.	15
Details	object []	The list of diagnoses that are returned.
Type	string	The type of the diagnosis. Valid values: config: SAG configuration internet: quality of connections to the Internet biz: service quality	config
Items	object []	The list of items diagnosed.
Type	string	The type of the item. Valid values: config: SAG configuration internet: quality of connections to the Internet biz: service quality	config
EndTime	long	The timestamp when the system finishes diagnosing the item.	1602741570596
StartTime	long	The timestamp when the system starts to diagnose the item.	1602741570567
CN	object	The diagnosis report in Chinese.
Advice	array	The suggestion for the diagnosis.
	string
ItemName	string	The name of the item.
ItemLevel	string	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	The type of the item. Valid values: Config: SAG configuration Service: service quality Internet: quality of connections to the Internet
Details	array	The diagnosis.
	string
ItemName	string	The name of the item, which is the unique identifier of the item.	eccConfigCheck
EN	object	The diagnosis report in English.
Advice	array	The suggestion for the diagnosis.
	string		Check the physical connections to all Express connect ports and configure these ports on the 'Physical connection port' page.
ItemName	string	The name of the item.	Express Connect Port Configuration
ItemLevel	string	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.	ERROR
ItemType	string	The type of the item. Valid values: Config: SAG configuration Service: service quality Internet: quality of connections to the Internet	Config
Details	array	The diagnosis.
	string		The connection states of all Express connect ports are down and no IP address is specified for these ports: Port4
Level	string	The diagnosis level of the item. Valid values: error: severe warning: warning info: normal	error
Statistics	object	The information about items of each diagnosis level for the current diagnosis type.
Warning	integer	The number of items of the WARNING level.	2
Error	integer	The number of items of the ERROR level.	5
Total	integer	The total number of items for the current diagnosis type.	10
Info	integer	The number of items of the INFO level.	3
UId	string	The user ID (UID) of the Alibaba Cloud account to which the SAG instance belongs.	1688000000000000
EndTime	integer	The timestamp when the system finishes diagnosing the item.	160274157
StartTime	integer	The timestamp when the system starts to diagnose the item.	160274157
StoreType	string	The storage type. The value is set to both, which indicates that the data is stored in the SAG device and Log Service.	both
ReportSLSSuccess	integer	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.	0
TotalNumber	integer	The total number of entries returned.	15
Level	object	The diagnosis level.
Configuration	string	The diagnosis level of the SAG configuration.	info
Total	string	The overall diagnosis level. error: severe warning: warning info: normal	error
Biz	string	The diagnosis level of the service quality.	warning
Statistics	object	The overall diagnosis level.
Warning	integer	The number of items of the WARNING level.	3
Error	integer	The number of items of the ERROR level.	2
Total	integer	The total number of items.	10
Info	integer	The number of items of the INFO level.	5

Examples

Sample success responses

JSONformat

{
  "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": [
                ""
              ]
            },
            "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
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	MissingParameter	The input parameter is missing, please check your input.	Missing parameters. Check whether all required parameters are set.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history