ADC NITRO APIs

gslbdomain_lbmonitor_binding

May 23, 2024

Contributed by:

Binding object showing the lbmonitor that can be bound to gslbdomain.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	Name of the Domain. Minimum length = 1
monitorname	Read-write	Monitor name.
monstatcode	Read-only	The code indicating the monitor response.
customheaders	Read-only	The string that is sent to the service. Applicable to HTTP ,HTTP-ECV and RTSP monitor types.
iptunnel	Read-only	The state of the monitor for tunneled devices. Possible values = YES, NO
responsetime	Read-only	Response time of this monitor.
monstate	Read-only	Monitor state. Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
lastresponse	Read-only	The string form of monstatcode.
grpcservicename	Read-only	The gRPC service name.
servicename	Read-only	The service name.
vservername	Read-only	.
respcode	Read-only	The response codes.
monitortotalprobes	Read-only	Total monitor probes.
httprequest	Read-only	HTTP request to the backend server.
grpcstatuscode	Read-only	The gRPC status codes.
grpchealthcheck	Read-only	The gRPC health check service status. Default value: NO Possible values = YES, NO
monitortotalfailedprobes	Read-only	Total probes failed.
monitorcurrentfailedprobes	Read-only	Total number of current failed probes.
__count	Read-only	count parameter

Operations

(click to see Properties )

GET
GET (ALL)
COUNT

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:* Mandatory parameters are marked in red and placeholder content is marked in green

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbdomain_lbmonitor_binding/ name_value<String> Query-parameters: filter http:// <netscaler-ip-address> /nitro/v1/config/gslbdomain_lbmonitor_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of gslbdomain_lbmonitor_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

pagination http:// <netscaler-ip-address> /nitro/v1/config/gslbdomain_lbmonitor_binding/ name_value<String> ? pagesize=#no;pageno=#no

Use this query-parameter to get the gslbdomain_lbmonitor_binding resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "gslbdomain_lbmonitor_binding": [ {
"name":<String_value>,
"monitorname":<String_value>,
"monstatcode":<Integer_value>,
"customheaders":<String_value>,
"iptunnel":<String_value>,
"responsetime":<Double_value>,
"monstate":<String_value>,
"lastresponse":<String_value>,
"grpcservicename":<String_value>,
"servicename":<String_value>,
"vservername":<String_value>,
"respcode":<String_value>,
"monitortotalprobes":<Double_value>,
"httprequest":<String_value>,
"grpcstatuscode":<Double_value>,
"grpchealthcheck":<String_value>,
"monitortotalfailedprobes":<Double_value>,
"monitorcurrentfailedprobes":<Double_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbdomain_lbmonitor_binding HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters: bulkbindings http:// <netscaler-ip-address> /nitro/v1/config/gslbdomain_lbmonitor_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "gslbdomain_lbmonitor_binding": [ {
"name":<String_value>,
"monitorname":<String_value>,
"monstatcode":<Integer_value>,
"customheaders":<String_value>,
"iptunnel":<String_value>,
"responsetime":<Double_value>,
"monstate":<String_value>,
"lastresponse":<String_value>,
"grpcservicename":<String_value>,
"servicename":<String_value>,
"vservername":<String_value>,
"respcode":<String_value>,
"monitortotalprobes":<Double_value>,
"httprequest":<String_value>,
"grpcstatuscode":<Double_value>,
"grpchealthcheck":<String_value>,
"monitortotalfailedprobes":<Double_value>,
"monitorcurrentfailedprobes":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbdomain_lbmonitor_binding/ name_value<String> ? count=yes HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{"gslbdomain_lbmonitor_binding": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

gslbdomain_lbmonitor_binding

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

gslbdomain_lbmonitor_binding

Properties

Operations

get

get (all)

count

In this article