Configure a service address using CreateServiceAddress - 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:CreateServiceAddress

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Smart Access Gateway instance. You can call the DescribeRegions operation to query region IDs.	cn-shanghai
AddressType	string	Yes	The service address type of the Smart Access Gateway instance. Set the value to ProbeTask.	ProbeTask
Address	string	Yes	The service address of the Smart Access Gateway instance. Example: 192.168.1.1.	192.168.1.1
SagId	string	Yes	The instance ID of the Smart Access Gateway instance.	sag-****
Sn	string	Yes	The serial number of the Smart Access Gateway device.	sag****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	324223F3-93D3-4CE4-B26F-66C0C3809922
Code	string	The response code.	200
Message	string	The response message.	successful

Examples

Success response

JSON format

{
  "RequestId": "324223F3-93D3-4CE4-B26F-66C0C3809922",
  "Code": "200",
  "Message": "successful"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidServiceAddressType	The specified service address type is invalid.	The type of the service address is invalid.
400	InvalidParam.Ip	The specified IP address is invalid.	The specified IP address is invalid.
400	InstanceExists	The specified instance already exists.	The specified instance already exists.
403	FeatureNotSupport	The current edition of the smart access gateway does not support this feature.	The current version of Smart Access Gateway does not support this feature.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.