48 lines
52 KiB
HTML
48 lines
52 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>autoscalegroup</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">autoscalegroup</p>
|
|
<P>Configuration for Autoscale Group details resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">memory_min<span class="property_type"><Double></span></p><p class="property_description">Minimum Memory Threshold Limit.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">access_profile_id<span class="property_type"><String></span></p><p class="property_description">The access profile id.<br> Maximum length = 128</p>
|
|
<p class="property_name">cpu_threshold_enabled<span class="property_type"><Boolean></span></p><p class="property_description">Status of CPU Threshold Config.</p>
|
|
<p class="property_name">cloud_type<span class="property_type"><String></span></p><p class="property_description">Type of cloud (AWS/Azure).<br> Maximum length = 64</p>
|
|
<p class="property_name">status<span class="property_type"><Boolean></span></p><p class="property_description">Status of Auto-Scale Group (Enable/Disable).</p>
|
|
<p class="property_name">activity_id<span class="property_type"><String></span></p><p class="property_description">Most recent activity_id of this autoscalegroup.<br> Maximum length = 128</p>
|
|
<p class="property_name">cool_down_period<span class="property_type"><Integer></span></p><p class="property_description">Cool Down Period (Waiting time in minutes after triggering scale up/down before initiating next provisioning/de-provisioing.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">throughput_min<span class="property_type"><Double></span></p><p class="property_description">Minimum Throughput Threshold Limit.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">site_id<span class="property_type"><String></span></p><p class="property_description">site.<br> Maximum length = 128</p>
|
|
<p class="property_name">no_of_cold_nodes<span class="property_type"><Integer></span></p><p class="property_description">No of cold node supported per AutoscaleGroup.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">min_node<span class="property_type"><Integer></span></p><p class="property_description">Minimum number of nodes.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">watch_time<span class="property_type"><Integer></span></p><p class="property_description">Watch Time (No of intervels before triggering auto scale up/down).<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">drain_connection_timeout<span class="property_type"><Integer></span></p><p class="property_description">Drain Connection Timeout in minutes.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">mode<span class="property_type"><Integer></span></p><p class="property_description">Mode (1.DNS/2.NLB/3.ALB/4.GLB).<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">memory_max<span class="property_type"><Double></span></p><p class="property_description">Maximum Memory Threshold Limit.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">cpu_max<span class="property_type"><Double></span></p><p class="property_description">Maximum CPU Threshold Limit.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">auto_retry_count<span class="property_type"><Integer></span></p><p class="property_description">Max auto retry count for retryable errors in an ASG..<br> Maximum value = </p>
|
|
<p class="property_name">ttl_timeout<span class="property_type"><Integer></span></p><p class="property_description">TTL Timeout in seconds.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">enable_cold_node<span class="property_type"><Boolean></span></p><p class="property_description">Enable/Disable Autoscale cold node support.</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key for all the auto-scale groups.</p>
|
|
<p class="property_name">throughput_threshold_enabled<span class="property_type"><Boolean></span></p><p class="property_description">Status of Throughput Threshold Config.</p>
|
|
<p class="property_name">cpu_min<span class="property_type"><Double></span></p><p class="property_description">Minimum CPU Threshold Limit.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">throughput_max<span class="property_type"><Double></span></p><p class="property_description">Maximum Throughput Threshold Limit.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">mem_threshold_enabled<span class="property_type"><Boolean></span></p><p class="property_description">Status of Memory Threshold Config.</p>
|
|
<p class="property_name">is_autoupgrade_enabled<span class="property_type"><Boolean></span></p><p class="property_description">Enabled when autoupgrade for autoscalegroup is in progress..</p>
|
|
<p class="property_name">agent_id<span class="property_type"><String></span></p><p class="property_description">The ID of Agent.<br> Maximum length = 128</p>
|
|
<p class="property_name">provision_profile_map<span class="property_type"><autoscalegroup_profile_map[]></span></p><p class="property_description">Provision profile map for Availability Zone.</p>
|
|
<p class="property_name">max_node<span class="property_type"><Integer></span></p><p class="property_description">Maximum number of nodes.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Auto-Scale Group Name.<br> Minimum length = 1<br> Maximum length = 40</p>
|
|
<p class="property_name">auto_retry_interval<span class="property_type"><Integer></span></p><p class="property_description">Delay between two auto retries in minutes..<br> Minimum value = 3<br> Maximum value = </p>
|
|
<p class="property_name">tags<span class="property_type"><property_map[]></span></p><p class="property_description">Array of tag_name and tag_value pair associated with the autoscalegroup.</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#add" class="operation">add</a><a href="#delete" class="operation">delete</a><a href="#update" class="operation">update</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/autoscalegroup?onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"autoscalegroup": {<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#000000> "min_node":<Integer_value></font>,<br><font color=#000000> "no_of_cold_nodes":<Integer_value></font>,<br><font color=#000000> "watch_time":<Integer_value></font>,<br><font color=#000000> "cpu_threshold_enabled":<Boolean_value></font>,<br><font color=#000000> "status":<Boolean_value></font>,<br><font color=#000000> "memory_min":<Double_value></font>,<br><font color=#000000> "cool_down_period":<Integer_value></font>,<br><font color=#000000> "tags":[{<br><font color=#000000> "prop_value":<String_value></font>,<br><font color=#000000> "prop_key":<String_value></font>}]</font>,<br><font color=#000000> "is_autoupgrade_enabled":<Boolean_value></font>,<br><font color=#000000> "auto_retry_interval":<Integer_value></font>,<br><font color=#000000> "max_node":<Integer_value></font>,<br><font color=#000000> "enable_cold_node":<Boolean_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "mode":<Integer_value></font>,<br><font color=#000000> "drain_connection_timeout":<Integer_value></font>,<br><font color=#000000> "cloud_type":<String_value></font>,<br><font color=#000000> "access_profile_id":<String_value></font>,<br><font color=#000000> "throughput_min":<Double_value></font>,<br><font color=#000000> "site_id":<String_value></font>,<br><font color=#000000> "activity_id":<String_value></font>,<br><font color=#000000> "agent_id":<String_value></font>,<br><font color=#000000> "provision_profile_map":[{<br><font color=#000000> "node_count":<Integer_value></font>,<br><font color=#000000> "is_availability_set":<Boolean_value></font>,<br><font color=#000000> "error_type":<Integer_value></font>,<br><font color=#000000> "is_active_node_prov":<Boolean_value></font>,<br><font color=#000000> "az_version":<String_value></font>,<br><font color=#000000> "az_type":<Integer_value></font>,<br><font color=#000000> "availability_zone":<String_value></font>,<br><font color=#000000> "bandwidth_limit":<Integer_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "provision_job_id":<String_value></font>,<br><font color=#000000> "retry_err_type":<String_value></font>,<br><font color=#000000> "provision_request_id":<String_value></font>,<br><font color=#000000> "error_message":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "retry_count":<Integer_value></font>,<br><font color=#000000> "delay":<Integer_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "node_id":<String_value></font>,<br><font color=#000000> "activity_id":<String_value></font>,<br><font color=#000000> "autoscalegroup_name":<String_value></font>,<br><font color=#000000> "provision_profile_id":<String_value></font>,<br><font color=#000000> "cluster_id":<String_value></font>,<br><font color=#000000> "azure_resource_group_name":<String_value></font>}]</font>,<br><font color=#000000> "mem_threshold_enabled":<Boolean_value></font>,<br><font color=#000000> "ttl_timeout":<Integer_value></font>,<br><font color=#000000> "cpu_max":<Double_value></font>,<br><font color=#000000> "memory_max":<Double_value></font>,<br><font color=#000000> "auto_retry_count":<Integer_value></font>,<br><font color=#000000> "throughput_max":<Double_value></font>,<br><font color=#000000> "cpu_min":<Double_value></font>,<br><font color=#000000> "throughput_threshold_enabled":<Boolean_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "autoscalegroup":[{<br> "memory_min":<Double_value></font>,<br> "access_profile_id":<String_value></font>,<br> "cpu_threshold_enabled":<Boolean_value></font>,<br> "cloud_type":<String_value></font>,<br> "status":<Boolean_value></font>,<br> "activity_id":<String_value></font>,<br> "cool_down_period":<Integer_value></font>,<br> "throughput_min":<Double_value></font>,<br> "site_id":<String_value></font>,<br> "no_of_cold_nodes":<Integer_value></font>,<br> "min_node":<Integer_value></font>,<br> "dummy_ip":<String_value></font>,<br> "watch_time":<Integer_value></font>,<br> "drain_connection_timeout":<Integer_value></font>,<br> "do_create_ipset":<Boolean_value></font>,<br> "mode":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "memory_max":<Double_value></font>,<br> "cpu_max":<Double_value></font>,<br> "auto_retry_count":<Integer_value></font>,<br> "ttl_timeout":<Integer_value></font>,<br> "enable_cold_node":<Boolean_value></font>,<br> "is_ipset_created":<Boolean_value></font>,<br> "id":<String_value></font>,<br> "throughput_threshold_enabled":<Boolean_value></font>,<br> "cpu_min":<Double_value></font>,<br> "throughput_max":<Double_value></font>,<br> "customer_name":<String_value></font>,<br> "mem_threshold_enabled":<Boolean_value></font>,<br> "is_autoupgrade_enabled":<Boolean_value></font>,<br> "agent_id":<String_value></font>,<br> "state":<String_value></font>,<br> "provision_profile_map":[{<br> "node_count":<Integer_value></font>,<br> "is_availability_set":<Boolean_value></font>,<br> "is_active_node_prov":<Boolean_value></font>,<br> "az_version":<String_value></font>,<br> "az_type":<Integer_value></font>,<br> "provision_state":<String_value></font>,<br> "cluster_ip_address":<String_value></font>,<br> "availability_zone":<String_value></font>,<br> "bandwidth_limit":<Integer_value></font>,<br> "id":<String_value></font>,<br> "is_cool_down_period":<Boolean_value></font>,<br> "provision_job_id":<String_value></font>,<br> "retry_err_type":<String_value></font>,<br> "provision_request_id":<String_value></font>,<br> "error_message":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "retry_count":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "parent_id":<String_value></font>,<br> "node_id":<String_value></font>,<br> "is_drain_connection_timeout_period":<Boolean_value></font>,<br> "provision_failure_timeout":<Integer_value></font>,<br> "activity_id":<String_value></font>,<br> "provision_profile_id":<String_value></font>,<br> "cluster_id":<String_value></font>,<br> "azure_resource_group_name":<String_value></font><br> "delay":<Integer_value></font><br> "recreate_cluster":<Boolean_value></font><br> "autoscalegroup_name":<String_value></font><br> "az_activity_id":<String_value></font><br> "error_type":<Integer_value></font><br> "is_auto_upgrade":<Boolean_value></font><br> "is_graceful_delete":<Boolean_value></font><br> "force_delete":<Boolean_value></font>}],<br> "max_node":<Integer_value></font>,<br> "name":<String_value></font>,<br> "auto_retry_interval":<Integer_value></font>,<br> "site_in_use":<Boolean_value></font>,<br> "tags":[{<br> "prop_value":<String_value></font>,<br> "prop_key":<String_value></font>}],<br> "force_delete":<Boolean_value></font>,<br> "do_provision":<Boolean_value></font>,<br> "agent_in_use":<Boolean_value></font>,<br> "no_of_cluster_instances":<Integer_value></font>}]}</p><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/autoscalegroup/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value> }</p><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/autoscalegroup/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"autoscalegroup":{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "auto_retry_interval":<Integer_value></font>,<br><font color=#000000> "max_node":<Integer_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "agent_id":<String_value></font>,<br><font color=#000000> "is_autoupgrade_enabled":<Boolean_value></font>,<br><font color=#000000> "provision_profile_map":[{<br><font color=#000000> "node_count":<Integer_value></font>,<br><font color=#000000> "is_availability_set":<Boolean_value></font>,<br><font color=#000000> "error_type":<Integer_value></font>,<br><font color=#000000> "is_active_node_prov":<Boolean_value></font>,<br><font color=#000000> "az_version":<String_value></font>,<br><font color=#000000> "az_type":<Integer_value></font>,<br><font color=#000000> "availability_zone":<String_value></font>,<br><font color=#000000> "bandwidth_limit":<Integer_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "provision_job_id":<String_value></font>,<br><font color=#000000> "retry_err_type":<String_value></font>,<br><font color=#000000> "provision_request_id":<String_value></font>,<br><font color=#000000> "error_message":<String_value></font>,<br><font color=#000000> "parent_name":<String_value></font>,<br><font color=#000000> "retry_count":<Integer_value></font>,<br><font color=#000000> "delay":<Integer_value></font>,<br><font color=#000000> "parent_id":<String_value></font>,<br><font color=#000000> "node_id":<String_value></font>,<br><font color=#000000> "activity_id":<String_value></font>,<br><font color=#000000> "autoscalegroup_name":<String_value></font>,<br><font color=#000000> "provision_profile_id":<String_value></font>,<br><font color=#000000> "cluster_id":<String_value></font>,<br><font color=#000000> "azure_resource_group_name":<String_value></font>}]</font>,<br><font color=#000000> "mem_threshold_enabled":<Boolean_value></font>,<br><font color=#000000> "throughput_max":<Double_value></font>,<br><font color=#000000> "throughput_threshold_enabled":<Boolean_value></font>,<br><font color=#000000> "cpu_min":<Double_value></font>,<br><font color=#000000> "ttl_timeout":<Integer_value></font>,<br><font color=#000000> "enable_cold_node":<Boolean_value></font>,<br><font color=#000000> "memory_max":<Double_value></font>,<br><font color=#000000> "cpu_max":<Double_value></font>,<br><font color=#000000> "auto_retry_count":<Integer_value></font>,<br><font color=#000000> "mode":<Integer_value></font>,<br><font color=#000000> "drain_connection_timeout":<Integer_value></font>,<br><font color=#000000> "min_node":<Integer_value></font>,<br><font color=#000000> "no_of_cold_nodes":<Integer_value></font>,<br><font color=#000000> "watch_time":<Integer_value></font>,<br><font color=#000000> "site_id":<String_value></font>,<br><font color=#000000> "throughput_min":<Double_value></font>,<br><font color=#000000> "cool_down_period":<Integer_value></font>,<br><font color=#000000> "activity_id":<String_value></font>,<br><font color=#000000> "tags":[{<br><font color=#000000> "prop_value":<String_value></font>,<br><font color=#000000> "prop_key":<String_value></font>}]</font>,<br><font color=#000000> "cloud_type":<String_value></font>,<br><font color=#000000> "cpu_threshold_enabled":<Boolean_value></font>,<br><font color=#000000> "status":<Boolean_value></font>,<br><font color=#000000> "memory_min":<Double_value></font>,<br><font color=#000000> "access_profile_id":<String_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "autoscalegroup":[{<br> "memory_min":<Double_value></font>,<br> "access_profile_id":<String_value></font>,<br> "cpu_threshold_enabled":<Boolean_value></font>,<br> "cloud_type":<String_value></font>,<br> "status":<Boolean_value></font>,<br> "activity_id":<String_value></font>,<br> "cool_down_period":<Integer_value></font>,<br> "throughput_min":<Double_value></font>,<br> "site_id":<String_value></font>,<br> "no_of_cold_nodes":<Integer_value></font>,<br> "min_node":<Integer_value></font>,<br> "dummy_ip":<String_value></font>,<br> "watch_time":<Integer_value></font>,<br> "drain_connection_timeout":<Integer_value></font>,<br> "do_create_ipset":<Boolean_value></font>,<br> "mode":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "memory_max":<Double_value></font>,<br> "cpu_max":<Double_value></font>,<br> "auto_retry_count":<Integer_value></font>,<br> "ttl_timeout":<Integer_value></font>,<br> "enable_cold_node":<Boolean_value></font>,<br> "is_ipset_created":<Boolean_value></font>,<br> "id":<String_value></font>,<br> "throughput_threshold_enabled":<Boolean_value></font>,<br> "cpu_min":<Double_value></font>,<br> "throughput_max":<Double_value></font>,<br> "customer_name":<String_value></font>,<br> "mem_threshold_enabled":<Boolean_value></font>,<br> "is_autoupgrade_enabled":<Boolean_value></font>,<br> "agent_id":<String_value></font>,<br> "state":<String_value></font>,<br> "provision_profile_map":[{<br> "node_count":<Integer_value></font>,<br> "is_availability_set":<Boolean_value></font>,<br> "is_active_node_prov":<Boolean_value></font>,<br> "az_version":<String_value></font>,<br> "az_type":<Integer_value></font>,<br> "provision_state":<String_value></font>,<br> "cluster_ip_address":<String_value></font>,<br> "availability_zone":<String_value></font>,<br> "bandwidth_limit":<Integer_value></font>,<br> "id":<String_value></font>,<br> "is_cool_down_period":<Boolean_value></font>,<br> "provision_job_id":<String_value></font>,<br> "retry_err_type":<String_value></font>,<br> "provision_request_id":<String_value></font>,<br> "error_message":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "retry_count":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "parent_id":<String_value></font>,<br> "node_id":<String_value></font>,<br> "is_drain_connection_timeout_period":<Boolean_value></font>,<br> "provision_failure_timeout":<Integer_value></font>,<br> "activity_id":<String_value></font>,<br> "provision_profile_id":<String_value></font>,<br> "cluster_id":<String_value></font>,<br> "azure_resource_group_name":<String_value></font><br> "delay":<Integer_value></font><br> "recreate_cluster":<Boolean_value></font><br> "autoscalegroup_name":<String_value></font><br> "az_activity_id":<String_value></font><br> "error_type":<Integer_value></font><br> "is_auto_upgrade":<Boolean_value></font><br> "is_graceful_delete":<Boolean_value></font><br> "force_delete":<Boolean_value></font>}],<br> "max_node":<Integer_value></font>,<br> "name":<String_value></font>,<br> "auto_retry_interval":<Integer_value></font>,<br> "site_in_use":<Boolean_value></font>,<br> "tags":[{<br> "prop_value":<String_value></font>,<br> "prop_key":<String_value></font>}],<br> "force_delete":<Boolean_value></font>,<br> "do_provision":<Boolean_value></font>,<br> "agent_in_use":<Boolean_value></font>,<br> "no_of_cluster_instances":<Integer_value></font>}]}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/autoscalegroup</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/autoscalegroup<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of autoscalegroup resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/autoscalegroup<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the autoscalegroup resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/autoscalegroup<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of autoscalegroup resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "autoscalegroup":[{<br> "memory_min":<Double_value></font>,<br> "access_profile_id":<String_value></font>,<br> "cpu_threshold_enabled":<Boolean_value></font>,<br> "cloud_type":<String_value></font>,<br> "status":<Boolean_value></font>,<br> "activity_id":<String_value></font>,<br> "cool_down_period":<Integer_value></font>,<br> "throughput_min":<Double_value></font>,<br> "site_id":<String_value></font>,<br> "no_of_cold_nodes":<Integer_value></font>,<br> "min_node":<Integer_value></font>,<br> "dummy_ip":<String_value></font>,<br> "watch_time":<Integer_value></font>,<br> "drain_connection_timeout":<Integer_value></font>,<br> "do_create_ipset":<Boolean_value></font>,<br> "mode":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "memory_max":<Double_value></font>,<br> "cpu_max":<Double_value></font>,<br> "auto_retry_count":<Integer_value></font>,<br> "ttl_timeout":<Integer_value></font>,<br> "enable_cold_node":<Boolean_value></font>,<br> "is_ipset_created":<Boolean_value></font>,<br> "id":<String_value></font>,<br> "throughput_threshold_enabled":<Boolean_value></font>,<br> "cpu_min":<Double_value></font>,<br> "throughput_max":<Double_value></font>,<br> "customer_name":<String_value></font>,<br> "mem_threshold_enabled":<Boolean_value></font>,<br> "is_autoupgrade_enabled":<Boolean_value></font>,<br> "agent_id":<String_value></font>,<br> "state":<String_value></font>,<br> "provision_profile_map":[{<br> "node_count":<Integer_value></font>,<br> "is_availability_set":<Boolean_value></font>,<br> "is_active_node_prov":<Boolean_value></font>,<br> "az_version":<String_value></font>,<br> "az_type":<Integer_value></font>,<br> "provision_state":<String_value></font>,<br> "cluster_ip_address":<String_value></font>,<br> "availability_zone":<String_value></font>,<br> "bandwidth_limit":<Integer_value></font>,<br> "id":<String_value></font>,<br> "is_cool_down_period":<Boolean_value></font>,<br> "provision_job_id":<String_value></font>,<br> "retry_err_type":<String_value></font>,<br> "provision_request_id":<String_value></font>,<br> "error_message":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "retry_count":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "parent_id":<String_value></font>,<br> "node_id":<String_value></font>,<br> "is_drain_connection_timeout_period":<Boolean_value></font>,<br> "provision_failure_timeout":<Integer_value></font>,<br> "activity_id":<String_value></font>,<br> "provision_profile_id":<String_value></font>,<br> "cluster_id":<String_value></font>,<br> "azure_resource_group_name":<String_value></font><br> "delay":<Integer_value></font><br> "recreate_cluster":<Boolean_value></font><br> "autoscalegroup_name":<String_value></font><br> "az_activity_id":<String_value></font><br> "error_type":<Integer_value></font><br> "is_auto_upgrade":<Boolean_value></font><br> "is_graceful_delete":<Boolean_value></font><br> "force_delete":<Boolean_value></font>}],<br> "max_node":<Integer_value></font>,<br> "name":<String_value></font>,<br> "auto_retry_interval":<Integer_value></font>,<br> "site_in_use":<Boolean_value></font>,<br> "tags":[{<br> "prop_value":<String_value></font>,<br> "prop_key":<String_value></font>}],<br> "force_delete":<Boolean_value></font>,<br> "do_provision":<Boolean_value></font>,<br> "agent_in_use":<Boolean_value></font>,<br> "no_of_cluster_instances":<Integer_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/autoscalegroup/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "autoscalegroup":[{<br> "memory_min":<Double_value></font>,<br> "access_profile_id":<String_value></font>,<br> "cpu_threshold_enabled":<Boolean_value></font>,<br> "cloud_type":<String_value></font>,<br> "status":<Boolean_value></font>,<br> "activity_id":<String_value></font>,<br> "cool_down_period":<Integer_value></font>,<br> "throughput_min":<Double_value></font>,<br> "site_id":<String_value></font>,<br> "no_of_cold_nodes":<Integer_value></font>,<br> "min_node":<Integer_value></font>,<br> "dummy_ip":<String_value></font>,<br> "watch_time":<Integer_value></font>,<br> "drain_connection_timeout":<Integer_value></font>,<br> "do_create_ipset":<Boolean_value></font>,<br> "mode":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "memory_max":<Double_value></font>,<br> "cpu_max":<Double_value></font>,<br> "auto_retry_count":<Integer_value></font>,<br> "ttl_timeout":<Integer_value></font>,<br> "enable_cold_node":<Boolean_value></font>,<br> "is_ipset_created":<Boolean_value></font>,<br> "id":<String_value></font>,<br> "throughput_threshold_enabled":<Boolean_value></font>,<br> "cpu_min":<Double_value></font>,<br> "throughput_max":<Double_value></font>,<br> "customer_name":<String_value></font>,<br> "mem_threshold_enabled":<Boolean_value></font>,<br> "is_autoupgrade_enabled":<Boolean_value></font>,<br> "agent_id":<String_value></font>,<br> "state":<String_value></font>,<br> "provision_profile_map":[{<br> "node_count":<Integer_value></font>,<br> "is_availability_set":<Boolean_value></font>,<br> "is_active_node_prov":<Boolean_value></font>,<br> "az_version":<String_value></font>,<br> "az_type":<Integer_value></font>,<br> "provision_state":<String_value></font>,<br> "cluster_ip_address":<String_value></font>,<br> "availability_zone":<String_value></font>,<br> "bandwidth_limit":<Integer_value></font>,<br> "id":<String_value></font>,<br> "is_cool_down_period":<Boolean_value></font>,<br> "provision_job_id":<String_value></font>,<br> "retry_err_type":<String_value></font>,<br> "provision_request_id":<String_value></font>,<br> "error_message":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "retry_count":<Integer_value></font>,<br> "last_updated_time":<Double_value></font>,<br> "parent_id":<String_value></font>,<br> "node_id":<String_value></font>,<br> "is_drain_connection_timeout_period":<Boolean_value></font>,<br> "provision_failure_timeout":<Integer_value></font>,<br> "activity_id":<String_value></font>,<br> "provision_profile_id":<String_value></font>,<br> "cluster_id":<String_value></font>,<br> "azure_resource_group_name":<String_value></font><br> "delay":<Integer_value></font><br> "recreate_cluster":<Boolean_value></font><br> "autoscalegroup_name":<String_value></font><br> "az_activity_id":<String_value></font><br> "error_type":<Integer_value></font><br> "is_auto_upgrade":<Boolean_value></font><br> "is_graceful_delete":<Boolean_value></font><br> "force_delete":<Boolean_value></font>}],<br> "max_node":<Integer_value></font>,<br> "name":<String_value></font>,<br> "auto_retry_interval":<Integer_value></font>,<br> "site_in_use":<Boolean_value></font>,<br> "tags":[{<br> "prop_value":<String_value></font>,<br> "prop_key":<String_value></font>}],<br> "force_delete":<Boolean_value></font>,<br> "do_provision":<Boolean_value></font>,<br> "agent_in_use":<Boolean_value></font>,<br> "no_of_cluster_instances":<Integer_value></font>}]}</p>
|
|
</body>
|
|
</html>
|