All Products
Search

This Product

    Smart Access Gateway:CreateProbeTask

    Document Center

    Smart Access Gateway:CreateProbeTask

    Last Updated:Mar 29, 2024

    Creates a probing task for a Smart Access Gateway (SAG) device.

    Operation description

    • Only SAG-1000 devices whose software version is 2.7.0 or later support the probing feature.
    • The SAG instance must have the deep packet inspection (DPI) feature enabled. You can call the SetAdvancedMonitorState operation to enable or disable the DPI feature.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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:
      • The required resource types are displayed in bold characters.
      • 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:CreateProbeTaskWrite
    • 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 SAG instance.

    		sag-asdfz6ac74oj5v****
    SnstringYes

    The serial number of the SAG device.

    		sag****
    TaskNamestringYes

    The name of the probe task.

    		test-ping
    TypestringYes

    The type of the probe task. Valid values:

    • Internet: probes a public network.
    • Intranet: probes a private network.
    		Internet
    ProtocolstringYes

    The protocol of the probe task. Valid values:

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

    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
    PortintegerYes

    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
    PacketNumberintegerYes

    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
    ProbeTaskSourceAddressstringYes

    The source address of the probe task.

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

    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
    Datastring

    The ID of the probe task.

    		probe-****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidProbeDomainThe specified probe task domain is invalid.The domain name of the probing task is invalid.
    400InvalidNameThe specified name is not valid.The specified name is invalid.
    400InvalidProbeTypeThe specified probe task type is invalid.The type of the probing task is invalid.
    400InvalidProbeProtocolThe specified probe task protocol is invalid.The protocol 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. -
    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.