DiscribeSmartAccessGatewayDiagnosisReport - Smart Access Gateway

Call the DescribeSmartAccessGatewayDiagnosisReport operation to query the diagnostic report for a Smart Access Gateway (SAG) device.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:DiscribeSmartAccessGatewayDiagnosisReport

get

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

None

Request parameters

Parameter	Type	Required	Description	Example
SmartAGId	string	Yes	The ID of the Smart Access Gateway instance.	sag-1um5x5nwhilymw****
SmartAGSn	string	Yes	The serial number of the Smart Access Gateway device.	sage62x022502****
RegionId	string	No	The ID of the region where the Smart Access Gateway instance is deployed. Call the DescribeRegions operation to obtain the region ID.	cn-shanghai

Response parameters

Parameter	Type	Description	Example
	object	The diagnostic results.
RequestId	string	The request ID.	D7D6E3AB-D41A-42E3-8D4E-97B145F4B7C3
DiagnoseResult	object	The diagnostic report of the Smart Access Gateway device.
Percent	integer	The completion percentage of the diagnostic report.	100
SN	string	The serial number of the Smart Access Gateway device.	sag42c3****
DiagnoseId	string	The diagnostic ID.	dia-sag42c3t703trh02olv5rf****
State	string	The diagnostic state. processing: The diagnosis is in progress. finished: The diagnosis is complete. failed: The diagnosis failed. error: An error occurred during the diagnosis. upload_to_sls_fail: The diagnostic report failed to be uploaded.	finished
UserLevel	string	The type of user that initiated the diagnosis. The value is user.	user
BoxVersion	string	The software version of the Smart Access Gateway device.	2.1.0
InstanceId	string	The ID of the Smart Access Gateway instance.	sag-0nnteglltw6z4b***
BoxType	string	The type of the Smart Access Gateway device. sag-1000 sag-100WM	sag-1000
MonitorVersion	string	The monitoring version used by the Smart Access Gateway device.	2.0.2.9
FinishedNumber	integer	The number of diagnostic items that are complete.	15
Details	array<object>	The list of diagnostic result details.
	object	The details of the diagnostic result.
Type	string	The diagnostic type. config: SAG configuration. internet: Internet quality. biz: service quality.	config
Items	array<object>	The list of diagnostic item details.
	object	The details of the diagnostic item.
Type	string	The type of the diagnosis to which the diagnostic item belongs. config: SAG configuration. internet: Internet quality. biz: service quality.	config
EndTime	integer	The timestamp when the diagnosis of the item ended.	1602741570596
StartTime	integer	The timestamp when the diagnosis of the item started.	1602741570567
CN	object	The diagnostic results in Chinese.
Advice	array	The diagnostic suggestions.
	string	The diagnostic suggestion.	请先检查专线端口链路接线，然后进入本地“专线管理”页面进行配置。
ItemName	string	The name of the diagnostic item.	专线口配置检查
ItemLevel	string	The level of the diagnostic result for the item. Critical: Indicates that the issue with the diagnostic item may affect service operations. Prioritize this issue. Warning: Indicates that the diagnostic item has an issue. Handle the issue as needed based on the suggestions. Normal: Indicates that the diagnostic item is running as expected. No action is required.	正常
ItemType	string	The type of the diagnosis to which the diagnostic item belongs. Configuration: indicates that the item belongs to the SAG configuration type. Service: indicates that the item belongs to the service quality type. Internet: indicates that the item belongs to the Internet quality type.	配置
Details	array	The diagnostic results
	string	The diagnostic result.	所有专线端口存在链路异常或缺少端口IP：端口4
ItemName	string	The name of the diagnostic item. This is the unique identifier of the diagnostic item.	eccConfigCheck
EN	object	The diagnostic results in English.
Advice	array	The diagnostic suggestions.
	string	The diagnostic suggestion.	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 diagnostic item.	Express Connect Port Configuration
ItemLevel	string	The level of the diagnostic result for the item. ERROR: Indicates that the issue with the diagnostic item may affect service operations. Prioritize this issue. WARNING: Indicates that the diagnostic item has an issue. Handle the issue as needed based on the suggestions. INFO: Indicates that the diagnostic item is running as expected. No action is required.	ERROR
ItemType	string	The type of the diagnosis to which the diagnostic item belongs. Config: indicates that the item belongs to the SAG configuration type. Service: indicates that the item belongs to the service quality type. Internet: indicates that the item belongs to the Internet quality type.	Config
Details	array	The diagnostic results.
	string	The diagnostic result.	The connection states of all Express connect ports are down and no IP address is specified for these ports: Port4
Level	string	The level of the diagnostic result for the item. error: critical. warning: warning. info: normal.	error
Statistics	object	The statistics about the levels of diagnostic items for the current diagnostic type.
Warning	integer	The number of diagnostic items at the Warning level.	2
Error	integer	The number of diagnostic items at the Error level.	5
Total	integer	The total number of diagnostic items of the current diagnostic type.	10
Info	integer	The number of diagnostic items at the Info level.	3
UId	string	The ID of the Alibaba Cloud account that owns the Smart Access Gateway instance.	1688000000000000
EndTime	integer	The timestamp when the diagnosis ended.	160274157
StartTime	integer	The timestamp when the diagnosis started.	160274157
StoreType	string	The storage class. The value is both, which indicates that the report is stored on both the Smart Access Gateway device and in Simple Log Service (SLS).	both
ReportSLSSuccess	integer	The status of the diagnostic report upload to SLS. 0: The upload failed. 1: The upload was successful.	0
TotalNumber	integer	The total number of entries in the diagnostic report.	15
Level	object	The level of the diagnostic result.
Configuration	string	The result level of the SAG configuration diagnosis.	info
Total	string	The overall level of the diagnostic result. error: critical. warning: warning. info: normal.	error
Biz	string	The result level of the service quality diagnosis.	warning
Statistics	object	The statistics for the overall diagnostic results.
Warning	integer	The total number of diagnostic items at the Warning level.	3
Error	integer	The total number of diagnostic items at the Error level.	2
Total	integer	The total number of diagnostic items.	10
Info	integer	The total number of diagnostic items at the Info level.	5

Examples

Success response

JSON format

{
  "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
    }
  }
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.