All Products
Search
Document Center

Smart Access Gateway:CreateServiceAddress

Last Updated:Jul 31, 2025

Configures a service address for a Smart Access Gateway (SAG) device.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:CreateServiceAddress
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the SAG instance.

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

cn-shanghai
AddressTypestringYes

The type of service address. Set the value to ProbeTask.

ProbeTask
AddressstringYes

The service address. Example: 192.168.1.1.

192.168.1.1
SagIdstringYes

The ID of the SAG instance.

sag-****
SnstringYes

The serial number of the SAG device.

sag****

Response parameters

ParameterTypeDescriptionExample
object

The response.

RequestIdstring

The ID of the request.

324223F3-93D3-4CE4-B26F-66C0C3809922
Codestring

The response code.

200
Messagestring

The response message.

successful

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidServiceAddressTypeThe specified service address type is invalid.The type of the service address is invalid.
400InvalidParam.IpThe specified IP address is invalid.The specified IP address is invalid.
400InstanceExistsThe specified instance already exists.The specified instance already exists.
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.

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