Updating a Bandwidth Auto Scaling Policy
Function
This API is used to update a bandwidth auto scaling policy. Automatic bandwidth decreases are not supported.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/instances/{instance_id}/autoscaling-policy/bandwidth
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
window_size |
Yes |
Integer |
Monitoring period of bandwidth increases, in minutes. The value can be 1, 5, 10, 15, or 30. |
bandwidth_usage_upper_threshold |
Yes |
Integer |
Threshold percentage of the average bandwidth usage that triggers an auto bandwidth increase. The value can be 50, 60, 70, 80, 90, or 95. |
scale_out_cooldown |
No |
Integer |
Silence time (minimum interval) between two bandwidth increases, in seconds. Default value: 0 Value range: 0–86,400. |
scale_in_enabled |
No |
Boolean |
Whether to enable automatic bandwidth decrease. Default value: false This parameter is reserved. |
bandwidth_usage_lower_threshold |
No |
Integer |
Threshold percentage of average bandwidth usage that triggers an automatic bandwidth decrease. The value can be 10, 20, or 30. This parameter is reserved. |
scale_in_cooldown |
No |
Integer |
Silence time (minimum interval) between two bandwidth decreases, in seconds. This parameter is reserved. Default value: 300 Value range: 0–86,400 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
window_size |
Integer |
Monitoring period of bandwidth increases, in minutes. The value can be 1, 5, 10, 15, or 30. |
bandwidth_usage_upper_threshold |
Integer |
Threshold percentage of the average bandwidth usage that triggers an auto bandwidth increase. The value can be 50, 60, 70, 80, 90, or 95. |
scale_out_cooldown |
Integer |
Silence time (minimum interval) between two bandwidth increases, in seconds. Default value: 0 Value range: 0–86,400. |
scale_in_enabled |
Boolean |
Whether to enable automatic bandwidth decrease. Default value: false This parameter is reserved. |
bandwidth_usage_lower_threshold |
Integer |
Threshold percentage of average bandwidth usage that triggers an automatic bandwidth decrease. The value can be 10, 20, or 30. This parameter is reserved. |
scale_in_cooldown |
Integer |
Silence time (minimum interval) between two bandwidth decreases, in seconds. This parameter is reserved. Default value: 300 Value range: 0–86,400 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Example Requests
PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/autoscaling-policy/bandwidth { "window_size" : 5, "bandwidth_usage_upper_threshold" : 70, "scale_out_cooldown" : 0, "scale_in_enabled" : true, "bandwidth_usage_lower_threshold" : 30, "scale_in_cooldown" : 300 }
Example Responses
Status code: 200
Response body for updating a bandwidth auto scaling policy.
{ "window_size" : 5, "bandwidth_usage_upper_threshold" : 70, "scale_out_cooldown" : 0, "scale_in_enabled" : true, "bandwidth_usage_lower_threshold" : 30, "scale_in_cooldown" : 300 }
Status code: 400
Invalid request.
{ "error_code" : "DCS.4063", "error_msg" : "Invalid window_size parameter in the request." }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class UpdateInstanceBandwidthAutoScalingPolicySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); UpdateInstanceBandwidthAutoScalingPolicyRequest request = new UpdateInstanceBandwidthAutoScalingPolicyRequest(); request.withInstanceId("{instance_id}"); UpdateInstanceBandwidthAutoScalingPolicyRequestBody body = new UpdateInstanceBandwidthAutoScalingPolicyRequestBody(); body.withScaleInCooldown(300); body.withScaleOutCooldown(0); body.withBandwidthUsageLowerThreshold(30); body.withScaleInEnabled(true); body.withBandwidthUsageUpperThreshold(UpdateInstanceBandwidthAutoScalingPolicyRequestBody.BandwidthUsageUpperThresholdEnum.NUMBER_70); body.withWindowSize(UpdateInstanceBandwidthAutoScalingPolicyRequestBody.WindowSizeEnum.NUMBER_5); request.withBody(body); try { UpdateInstanceBandwidthAutoScalingPolicyResponse response = client.updateInstanceBandwidthAutoScalingPolicy(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateInstanceBandwidthAutoScalingPolicyRequest() request.instance_id = "{instance_id}" request.body = UpdateInstanceBandwidthAutoScalingPolicyRequestBody( scale_in_cooldown=300, scale_out_cooldown=0, bandwidth_usage_lower_threshold=30, scale_in_enabled=True, bandwidth_usage_upper_threshold=70, window_size=5 ) response = client.update_instance_bandwidth_auto_scaling_policy(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateInstanceBandwidthAutoScalingPolicyRequest{} request.InstanceId = "{instance_id}" scaleInCooldownUpdateInstanceBandwidthAutoScalingPolicyRequestBody:= int32(300) scaleOutCooldownUpdateInstanceBandwidthAutoScalingPolicyRequestBody:= int32(0) bandwidthUsageLowerThresholdUpdateInstanceBandwidthAutoScalingPolicyRequestBody:= int32(30) scaleInEnabledUpdateInstanceBandwidthAutoScalingPolicyRequestBody:= true request.Body = &model.UpdateInstanceBandwidthAutoScalingPolicyRequestBody{ ScaleInCooldown: &scaleInCooldownUpdateInstanceBandwidthAutoScalingPolicyRequestBody, ScaleOutCooldown: &scaleOutCooldownUpdateInstanceBandwidthAutoScalingPolicyRequestBody, BandwidthUsageLowerThreshold: &bandwidthUsageLowerThresholdUpdateInstanceBandwidthAutoScalingPolicyRequestBody, ScaleInEnabled: &scaleInEnabledUpdateInstanceBandwidthAutoScalingPolicyRequestBody, BandwidthUsageUpperThreshold: model.GetUpdateInstanceBandwidthAutoScalingPolicyRequestBodyBandwidthUsageUpperThresholdEnum().E_70, WindowSize: model.GetUpdateInstanceBandwidthAutoScalingPolicyRequestBodyWindowSizeEnum().E_5, } response, err := client.UpdateInstanceBandwidthAutoScalingPolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class UpdateInstanceBandwidthAutoScalingPolicySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); UpdateInstanceBandwidthAutoScalingPolicyRequest request = new UpdateInstanceBandwidthAutoScalingPolicyRequest(); request.withInstanceId("{instance_id}"); UpdateInstanceBandwidthAutoScalingPolicyRequestBody body = new UpdateInstanceBandwidthAutoScalingPolicyRequestBody(); body.withScaleInCooldown(300); body.withScaleOutCooldown(0); body.withBandwidthUsageLowerThreshold(30); body.withScaleInEnabled(true); body.withBandwidthUsageUpperThreshold(UpdateInstanceBandwidthAutoScalingPolicyRequestBody.BandwidthUsageUpperThresholdEnum.NUMBER_70); body.withWindowSize(UpdateInstanceBandwidthAutoScalingPolicyRequestBody.WindowSizeEnum.NUMBER_5); request.withBody(body); try { UpdateInstanceBandwidthAutoScalingPolicyResponse response = client.updateInstanceBandwidthAutoScalingPolicy(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateInstanceBandwidthAutoScalingPolicyRequest() request.instance_id = "{instance_id}" request.body = UpdateInstanceBandwidthAutoScalingPolicyRequestBody( scale_in_cooldown=300, scale_out_cooldown=0, bandwidth_usage_lower_threshold=30, scale_in_enabled=True, bandwidth_usage_upper_threshold=70, window_size=5 ) response = client.update_instance_bandwidth_auto_scaling_policy(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateInstanceBandwidthAutoScalingPolicyRequest{} request.InstanceId = "{instance_id}" scaleInCooldownUpdateInstanceBandwidthAutoScalingPolicyRequestBody:= int32(300) scaleOutCooldownUpdateInstanceBandwidthAutoScalingPolicyRequestBody:= int32(0) bandwidthUsageLowerThresholdUpdateInstanceBandwidthAutoScalingPolicyRequestBody:= int32(30) scaleInEnabledUpdateInstanceBandwidthAutoScalingPolicyRequestBody:= true request.Body = &model.UpdateInstanceBandwidthAutoScalingPolicyRequestBody{ ScaleInCooldown: &scaleInCooldownUpdateInstanceBandwidthAutoScalingPolicyRequestBody, ScaleOutCooldown: &scaleOutCooldownUpdateInstanceBandwidthAutoScalingPolicyRequestBody, BandwidthUsageLowerThreshold: &bandwidthUsageLowerThresholdUpdateInstanceBandwidthAutoScalingPolicyRequestBody, ScaleInEnabled: &scaleInEnabledUpdateInstanceBandwidthAutoScalingPolicyRequestBody, BandwidthUsageUpperThreshold: model.GetUpdateInstanceBandwidthAutoScalingPolicyRequestBodyBandwidthUsageUpperThresholdEnum().E_70, WindowSize: model.GetUpdateInstanceBandwidthAutoScalingPolicyRequestBodyWindowSizeEnum().E_5, } response, err := client.UpdateInstanceBandwidthAutoScalingPolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Response body for updating a bandwidth auto scaling policy. |
400 |
Invalid request. |
401 |
Invalid authentication information. |
403 |
Access denied. |
404 |
The requested resource could not be found. |
500 |
Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot