All Products
Search

This Product

    Smart Access Gateway:UpdateSmartAccessGatewayAdminPassword

    Document Center

    Smart Access Gateway:UpdateSmartAccessGatewayAdminPassword

    Last Updated:Mar 29, 2024

    Modifies the password that is used to log on to an SCG5000 or SCG5000-5G device whose version is 3.4.2 or later.

    Operation description

    You can modify passwords that are used to log on to only SCG5000 and SCG5000-5G devices whose version is 3.4.2 or later.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    SagInsIdstringYes

    The ID of the Smart Access Gateway (SAG) instance.

    		sag-sv487b7lno6go5****
    SagSnstringYes

    The serial number of the SAG device.

    		sagf4ea****
    RegionIdstringYes

    The region ID of the SAG instance.

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

    		cn-shanghai
    PasswordstringYes

    The new password used to log on to 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.
    		1234****
    CrossAccountbooleanNo

    Specifies whether to query only the SAG instances that belong to another Alibaba Cloud account. Valid values:

    • false (default)
    • true
    		false
    ResourceUidstringNo

    The ID of the Alibaba Cloud account to which the SAG instance belongs.

    		147304382796****

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codestring

    The response code. A value of 200 indicates that the task is successful.

    		200
    Successboolean

    Indicates whether the call is successful. Valid values:

    • true
    • false
    		true
    RequestIdstring

    The request ID.

    		EC8487CD-9338-5FCF-896A-B6D1BB1646A7
    Messagestring

    The response message. A value of Successful indicates that the task is successful.

    		Successful

    Examples

    Sample success responses

    JSONformat

    {
  "Code": "200",
  "Success": true,
  "RequestId": "EC8487CD-9338-5FCF-896A-B6D1BB1646A7",
  "Message": "Successful"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400GATEWAY.InvalidSNThe specified gateway serial number does not exist.-
    400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
    400SAG.SoftwareNotSupportThe specified software instance does not support ACL.-
    400SmartAccessGatewayNotActivatedThe specified Smart Access Gateway has not been activated.The specified SAG instance is inactive. You must activate the instance first.
    400MissParameter.GatewayIdThe input parameter GatewayId that is mandatory for processing this model is not supplied.-
    400MissParameter.PasswordThe input parameter Password that is mandatory for processing this model is not supplied.-
    400InvalidParameter.PasswordThe input parameter Password is not legal, please check your input.-
    400InvalidSpec.FeatureNotSupportThe current edition of the cloudbranch does not support this feature.-
    400FeatureNotSupportCloud Box Not Support the Feature-
    400DeviceNotExistThe specified device does not exist-
    400SmartAccessGatewayNotOnlineThe specified instance is not online.-

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

    Change history

    Change timeSummary of changesOperation
    No change history