Help Center/ Auto Scaling/ API Reference/ APIs/ AS Policies/ Executing, Enabling, or Disabling an AS Policy

Updated on 2023-04-21 GMT+08:00

View PDF

Executing, Enabling, or Disabling an AS Policy

This interface is used to immediately execute, enable, or disable a specified AS policy.

An AS policy can be executed only when the AS group and AS policy are in the INSERVICE state. Otherwise, the execution fails.

POST /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}/action

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
scaling_policy_id	Yes	String	Specifies the AS policy ID.

Request parameters

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Specifies the operation for an AS policy. execute: immediately executes the AS policy. resume: enables the AS group. pause: disables the AS group.

Example request

This example shows how to immediately execute the AS policy with ID 906f73ff-56e8-41b2-a005-8157d0c60361.

POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action

{
    "action": "execute"
}

Abnormal

Returned Value	Description
400 Bad Request	The server failed to process the request.
401 Unauthorized	You must enter the username and password to access the requested page.
403 Forbidden	You are forbidden to access the requested page.
404 Not Found	The server could not find the requested page.
405 Method Not Allowed	You are not allowed to use the method specified in the request.
406 Not Acceptable	The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required	You must use the proxy server for authentication to process the request.
408 Request Timeout	The request timed out.
409 Conflict	The request could not be processed due to a conflict.
500 Internal Server Error	Failed to complete the request because of an internal service error.
501 Not Implemented	Failed to complete the request because the server does not support the requested function.
502 Bad Gateway	Failed to complete the request because the request is invalid.
503 Service Unavailable	Failed to complete the request because the system is unavailable.
504 Gateway Timeout	A gateway timeout error occurred.