All Products
Search

This Product

    Smart Access Gateway:DescribeSagWan4G

    Document Center

    Smart Access Gateway:DescribeSagWan4G

    Last Updated:Mar 29, 2024

    Queries the information about the 4G subscriber identity module (SIM) card used by the WAN port of 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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    smartag:DescribeSagWan4GRead
    • SmartAccessGateway
      acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the SAG instance.

    		cn-shanghai
    SmartAGIdstringYes

    The SAG instance ID.

    		sag-whfn****
    SmartAGSnstringYes

    The serial number of the SAG device associated with the SAG instance.

    		sag32a30****

    Response parameters

    ParameterTypeDescriptionExample
    object
    Statusstring

    The status of the 4G SIM card. Valid value:

    • Normal: The 4G SIM card is available.
    • Abnormal: The 4G SIM card encountered an error.
    • Unavailable: No 4G SIM card is inserted.
    		Normal
    TrafficStatestring

    The network status of the 4G SIM card. Valid values:

    • active: The 4G SIM card is used to establish the active connection. Network traffic is transmitted over the 4G SIM card first.
    • standby: The 4G SIM card is used to establish a standby connection. Network traffic is not transmitted over the 4G SIM card unless the active connection fails.
    		active
    RequestIdstring

    The request ID.

    		CE6642D4-21EB-4168-9BF9-F217953F9892
    Priorityinteger

    The priority of the 4G SIM card. The default value is 99, which indicates the lowest priority and cannot be modified.

    		99
    Ipstring

    The IP address of the 4G SIM card.

    		192.XX.XX.1
    Strengthstring

    The signal strength of the 4G network. Valid values:

    • High: strong signals.
    • Middle: medium-strength signals.
    • Low: weak signals.
    • Unavailable: no signal.
    		High
    Macstring

    The MAC address of the 4G SIM card.

    		c4:00:ad:a2:f5:****

    Examples

    Sample success responses

    JSONformat

    {
  "Status": "Normal",
  "TrafficState": "active",
  "RequestId": "CE6642D4-21EB-4168-9BF9-F217953F9892",
  "Priority": 99,
  "Ip": "192.XX.XX.1",
  "Strength": "High",
  "Mac": "c4:00:ad:a2:f5:****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
    400SAG.SoftwareNotSupportThe specified SAG software edition instance does not support ACL.The specified SAG software edition instance does not support ACL.
    400InstanceNotExitThe specified instance does not exist.The specified instance does not exist.
    400ConfigUnsynchronizedThe network configuration is not synchronized.Network settings are not synchronized.
    400SmartAccessGatewayInArrearsThe specified Smart Access Gateway has expired.The specified Smart Access Gateway has expired.
    400SmartAccessGatewayNotActivatedThe specified Smart Access Gateway has not been activated.The specified SAG instance is inactive. You must activate the instance first.
    400SmartAccessGatewayOfflineThe request cannot be completed. The Smart Access Gateway is offline.The SAG device is disconnected. The request cannot be processed.
    403SmartAccessGatewayNotOnlineThe specified smart access gateway is not online.The specified SAG device is disconnected. The operation cannot be processed.
    403FeatureNotSupportThe current edition of the smart access gateway does not support this feature.The current version of Smart Access Gateway does not support this feature.
    403FeatureNotSupportForActiveSmartAGThe current edition of the active smart access gateway does not support this feature.The current edition of the active SAG instance does not support this feature.
    403FeatureNotSupportForStandBySmartAGThe current edition of the standby smart access gateway does not support this feature.The current version of Smart Access Gateway does not support this feature.

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