Call the BindSerialNumber API to associate an SAG device with an SAG instance - Smart Access Gateway - Alibaba Cloud - Smart Access Gateway

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 supports 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:BindSerialNumber

update

*SmartAccessGateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Smart Access Gateway instance.	cn-hangzhou
SmartAGId	string	Yes	The instance ID of the Smart Access Gateway.	sag-r79m060r6oy55******
SerialNumber	string	Yes	The serial number of the Smart Access Gateway device.	sage62x021922****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	61C33444-D8C5-4018-A06C-BA8C8812BEF6

Examples

Success response

JSON format

{
  "RequestId": "61C33444-D8C5-4018-A06C-BA8C8812BEF6"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	You must specify the SAG instance ID.
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	The specified SAG instance does not exist.
400	SAG.SnOverLimit	The maximum number of serial numbers bound to the SAG instance is exceeded.	The maximum number of serial numbers bound to the SAG instance is exceeded.
400	SAG.SnConflict	The specified SerialNumber has been bound to another SAG instance.	The specified SerialNumber has been bound to another SAG instance.
400	ResourceInOperating	The specified resource is being used. Please try later.	The specified resource is being used. Please try later.
400	SAG.InvalidSerialNumber	The specified SerialNumber is invalid.	The specified SN is invalid.
500	SmartAccessGatewayInArrears	The specified Smart Access Gateway has expired.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.