All Products
Search
Document Center

Smart Access Gateway:CreateServiceAddress

Last Updated:Mar 29, 2024

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

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
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.