All Products
Search
Document Center

Smart Access Gateway:UpdateSmartAGAccessPoint

Last Updated:Mar 29, 2024

Switches the access point of a Smart Access Gateway (SAG) instance.

Operation description

Prerequisites

Before you call this operation, you can call the ListAccessPoints operation to view the switchable access points of the SAG instance.

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:UpdateSmartAGAccessPointWrite
  • 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
AccessPointIdintegerYes

The ID of the access point to which you want to switch.

10
SmartAGIdstringYes

The ID of the SAG instance.

sag-far8v6owtdxlua****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

E26DBAAE-A796-4A48-98B4-B45AFCD1F299

Examples

Sample success responses

JSONformat

{
  "RequestId": "E26DBAAE-A796-4A48-98B4-B45AFCD1F299"
}

Error codes

HTTP status codeError codeError messageDescription
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
400SAG.SoftwareNotSupportFeatureThe specified SAG Software instance does not support this feature.The specified SAG Software instance does not support this feature.
400SAG.NoActiveThe specified SAG instance has not been activated.The specified SAG instance has not been activated.
403InvalidId.SMARTAGThe specified smart access gateway instance id is invalid.The SAG instance ID is invalid.
403SmartAccessGatewayNotOnlineThe specified smart access gateway is not online.The specified SAG device is disconnected. The operation cannot be processed.
403NotBoundCCNThe specified smart access gateway has not bound CCN; please bind CCN first.The SAG instance is not associated with a CCN instance. You must associate the SAG instance with a CCN instance first.
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.
500UpgradingThe specified Smart Access Gateway is being upgraded.The SAG instance is being upgraded. Try again later.

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