All Products
Search
Document Center

Smart Access Gateway:UpdateProbeTask

Last Updated:Jul 31, 2025

Modifies a probe task.

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:UpdateProbeTask
*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
SagIdstringYes

The ID of the Smart Access Gateway (SAG) instance.

sag-****
SnstringYes

The serial number of the SAG device.

sag****
ProbeTaskIdstringYes

The ID of the probe task.

probe-****
TaskNamestringNo

The name of the probe task.

test-ping
ProtocolstringNo

The protocol of the probe task. Valid values:

  • ICMP
  • TCP
  • HTTP
Note Tasks that probe private networks support only ICMP and TCP.
ICMP
DomainstringNo

The domain name that is probed by the task.

If the protocol of the probe task is ICMP or TCP, set the value to the IP address or domain name of the service that you want to probe. If the protocol of the probe task is HTTP, set the value to the URL of the service that you want to probe.

www.example.com
PortintegerNo

The port that is probed by the task.

Note This parameter is required if the protocol of the probe task is TCP. Ignore this parameter if the protocol of the probe task is not TCP.
80
PacketNumberintegerNo

The number of probe packets transmitted by the probe task per minute.

Valid values: 1 to 60.

Note This parameter is required if the protocol of the probe task is ICMP. Ignore this parameter if the protocol of the probe task is not ICMP.
10
ProbeTaskSourceAddressstringNo

The source address of the probe task.

Note This parameter is required if the task probes private networks.
192.168.1.1
EnablebooleanNo

Specifies whether to enable the probe task. Valid values:

  • true: yes
  • false: no
true

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
400InstanceNotExitThe specified instance does not exist.The specified instance does not exist.
400InvalidNameThe specified name is not valid.The specified name is invalid.
400InvalidProbeProtocolThe specified probe task protocol is invalid.The protocol of the probing task is invalid.
400InvalidProbeDomainThe specified probe task domain is invalid.The domain name of the probing task is invalid.
400InvalidProbePortThe specified probe task port is invalid.The port of the probing task is invalid.
400InvalidPacketNumberThe specified probe task packet number is invalid.The number of probe packets specified for the probing task is invalid.
400InvalidProbeSourceIPThe specified probe task source ip is invalid.The source IP address of the probing task is invalid.
400ExistSameParamTaskExist task with same params.The parameters of the probing task are the same as another probing task.
400SagConfiguringSag is configuring. -

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