All Products
Search

This Product

    Smart Access Gateway:ModifySAGAdminPassword

    Document Center

    Smart Access Gateway:ModifySAGAdminPassword

    Last Updated:Mar 29, 2024

    Modifies the logon password 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:ModifySAGAdminPasswordWrite
    • SmartAccessGateway
      acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    		cn-shanghai
    SmartAGIdstringYes

    The ID of the SAG instance.

    		sag-tq3sazs17smldn****
    SmartAGSnstringYes

    The serial number (SN) of the SAG device.

    		sag32a30****
    PasswordstringYes

    The new logon password for the SAG device.

    The password must be 8 to 30 characters in length and can contain letters, digits, and underscores (_).

    Note In the example, asterisks (*) are used to conceal the real password. This does not mean that the password supports asterisks (*). The actual format requirement prevails.
    		********

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		DB0A026C-A8E5-40AB-977E-3A87DD78F694

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "DB0A026C-A8E5-40AB-977E-3A87DD78F694"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParam.PasswordThe specified Password is invalid.The Password parameter is set to an invalid value.
    400MissingParam.PasswordYou must specify Password.You must set the Password parameter.
    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.
    400SAG.SoftwareNotSupportFeatureThe specified SAG Software instance does not support this feature.The specified SAG Software instance does not support this feature.
    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.
    400InstanceNotExitThe specified instance does not exist.The specified instance does not exist.
    400ConfigUnsynchronizedThe network configuration is not synchronized.Network settings are not synchronized.
    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.

    Change history

    Change timeSummary of changesOperation
    No change history