health monitor method sip

Configure a SIP type health monitor.

sip Specification

Type Configuration Resource
Element Name sip
Element URI /axapi/v3/health/monitor/{name}/method/sip
Element Attributes sip_attributes
Schema sip schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/health/monitor/{name}/method/sip

sip Attributes

Get Object

GET

/axapi/v3/health/monitor/{name}/method/sip

sip Attributes

Modify Object

POST

/axapi/v3/health/monitor/{name}/method/sip

sip Attributes

Replace Object

PUT

/axapi/v3/health/monitor/{name}/method/sip

sip Attributes

Delete Object

DELETE

/axapi/v3/health/monitor/{name}/method/sip

sip Attributes

sip Attributes

expect-response-code

Description: Specify a set of SIP status codes. In this case, a SIP health check is successful only if the server reply includes one of the specified SIP status codes, such as 200 , 400-430 , or any . The format is xxx, xxx-xxx, any (where xxx is between 100-899).

Type: string

Format: string-rlx

register

Description: Send a SIP REGISTER message. The default is to send an OPTION message.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sip

Description: Enable SIP type.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sip-port

Description: Specify the SIP port.

Type: number

Range: 1-65534

Default: 5060

sip-tcp

Description: Use the health method for SIP over TCP/TLS. Without this option, the health method is for SIP over UDP.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string