Updated on 2024-04-25 GMT+08:00

Querying AS Policies (V2)

Function

This API is used to query all AS policies for a tenant based on search criteria. The results are displayed by page.

  • Search criteria can be the AS resource ID, AS resource type, AS policy name, AS policy ID, alarm ID, start line number, number of records, and sorting method.
  • If no search criteria are specified, a maximum of 20 AS policies can be queried for a tenant by default.

URI

GET /autoscaling-api/v2/{project_id}/scaling_policy

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. AS policies can be searched by all optional parameters in the following table. For details, see the example request.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

scaling_resource_id

No

String

Specifies the scaling resource ID.

scaling_resource_type

No

String

Specifies the scaling resource type.

  • AS group: SCALING_GROUP
  • Bandwidth: BANDWIDTH

scaling_policy_name

No

String

Specifies the AS policy name.

Supports fuzzy search.

scaling_policy_id

No

String

Specifies the AS policy ID.

scaling_policy_type

No

String

Specifies the AS policy type.

  • ALARM: alarm policy
  • SCHEDULED: scheduled policy
  • RECURRENCE: periodic policy

start_number

No

Integer

Specifies the start line number. The default value is 0. The minimum parameter value is 0.

limit

No

Integer

Specifies the number of query records. The default value is 20. The value ranges from 0 to 100.

sort_by

No

String

Specifies the sorting method.

  • POLICY_NAME: AS policies are sorted by name.
  • TRIGGER_CONDITION: AS policies are sorted by trigger condition. For example, in ascending order, alarm policies are first, and others are sorted in ascending order based on the latest triggering time.
  • CREATE_TIME: AS policies are sorted based on the creation time.

order

No

String

Specifies the sorting order.

  • ASC: ascending order
  • DESC: descending order

alarm_id

No

String

Specifies the alarm rule ID.

Request

None

Example Request

This example queries all periodic AS policies for the resource with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6.
GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy?scaling_resource_id=8ade64b5-d685-40b8-8582-4ce306ea37a6&scaling_policy_type=RECURRENCE

Response

Table 2 Response parameters

Parameter

Type

Description

total_number

Integer

Specifies the total number of query records.

start_number

Integer

Specifies the start line number.

limit

Integer

Specifies the maximum number of resources to be queried.

scaling_policies

Array of scaling_policies objects

Specifies AS policies. For details, see Table 3.

Table 3 scaling_policies field description

Parameter

Type

Description

scaling_policy_name

String

Specifies the AS policy name.

scaling_policy_id

String

Specifies the AS policy ID.

scaling_resource_id

String

Specifies the scaling resource ID.

scaling_resource_type

String

Specifies the scaling resource type.

  • AS group: SCALING_GROUP
  • Bandwidth: BANDWIDTH

policy_status

String

Specifies the AS policy status.

  • INSERVICE: The AS policy is enabled.
  • PAUSED: The AS policy is disabled.
  • EXECUTING: The AS policy is being executed.

scaling_policy_type

String

Specifies the AS policy type.

  • ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.
  • SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.
  • RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id.

alarm_id

String

Specifies the alarm ID.

scheduled_policy

scheduled_policy object

Specifies the periodic or scheduled AS policy. For details, see Table 4.

scaling_policy_action

scaling_policy_action object

Specifies the scaling action of the AS policy. For details, see Table 5.

cool_down_time

Integer

Specifies the cooldown period (s).

create_time

String

Specifies the time when an AS policy was created. The time format complies with UTC.

meta_data

meta_data object

Provides additional information. For details, see Table 6.

description

String

Specifies the AS policy description.

Table 4 scheduled_policy field description

Parameter

Type

Description

launch_time

String

Specifies the time when the scaling action is triggered. The time format complies with UTC.

  • If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
  • If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.

recurrence_type

String

Specifies the type of a periodically triggered scaling action.

  • Daily: indicates that the scaling action is triggered once a day.
  • Weekly: indicates that the scaling action is triggered once a week.
  • Monthly: indicates that the scaling action is triggered once a month.

recurrence_value

String

Specifies the frequency at which scaling actions are triggered.

  • If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.
  • If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
  • If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.

start_time

String

Specifies the start time of the scaling action triggered periodically. The time format complies with UTC.

The time format is YYYY-MM-DDThh:mmZ.

end_time

String

Specifies the end time of the scaling action triggered periodically. The time format complies with UTC.

The time format is YYYY-MM-DDThh:mmZ.

Table 5 scaling_policy_action field description

Parameter

Type

Description

operation

String

Specifies the scaling action.

  • ADD: indicates adding instances.
  • REDUCE: indicates reducing instances.
  • SET: indicates setting the number of instances to a specified value.

size

Integer

Specifies the number of instances to be operated.

percentage

Integer

Specifies the percentage of instances to be operated.

limits

Integer

Specifies the operation restrictions.

Table 6 meta_data field description

Parameter

Type

Description

metadata_bandwidth_share_type

String

Specifies the bandwidth sharing type in the bandwidth scaling policy.

metadata_eip_id

String

Specifies the EIP ID for the bandwidth in the bandwidth scaling policy.

metadata_eip_address

String

Specifies the EIP for the bandwidth in the bandwidth scaling policy.

Example Response

{
    "limit": 20,
    "total_number": 3,
    "start_number": 0,
    "scaling_policies": [
        {
            "scaling_policy_id": "803a35a5-38fb-4d27-a042-496c14bc1fb8",
            "scaling_policy_name": "as-policy-7a75",
            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
            "scaling_resource_type": "SCALING_GROUP",
            "scaling_policy_type": "RECURRENCE",
            "scheduled_policy": {
                "launch_time": "03:30",
                "recurrence_type": "Daily",
                "start_time": "2017-08-28T03:08Z",
                "end_time": "2017-09-01T03:08Z"
            },
            "cool_down_time": 900,
            "scaling_policy_action": {
                "operation": "ADD",
                "size": 1
            },
            "policy_status": "INSERVICE",
            "create_time": "2017-08-31T03:02:41Z"
        },
        {
            "scaling_policy_id": "535fd67e-276b-409c-879e-52f4e09e14bb",
            "scaling_policy_name": "as-policy-7a75",
            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
            "scaling_resource_type": "SCALING_GROUP",
            "scaling_policy_type": "RECURRENCE",
            "scheduled_policy": {
                "launch_time": "21:30",
                "recurrence_type": "Daily",
                "start_time": "2017-08-27T21:08Z",
                "end_time": "2017-08-31T21:08Z"
            },
            "cool_down_time": 900,
            "scaling_policy_action": {
                "operation": "ADD",
                "size": 1
            },
            "policy_status": "INSERVICE",
            "create_time": "2017-08-31T07:35:05Z",
"meta_data": {
                "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
                "metadata_eip_address": "255.255.255.255"
            }
        },
        {
            "scaling_policy_id": "37df92f8-73cb-469e-a420-c15f445d2ee1",
            "scaling_policy_name": "as-policy-7a75",
            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
            "scaling_resource_type": "SCALING_GROUP",
            "scaling_policy_type": "RECURRENCE",
            "scheduled_policy": {
                "launch_time": "22:30",
                "recurrence_type": "Daily",
                "start_time": "2017-08-27T22:08Z",
                "end_time": "2017-08-31T22:08Z"
            },
            "cool_down_time": 900,
            "scaling_policy_action": {
                "operation": "ADD",
                "size": 1
            },
            "policy_status": "INSERVICE",
            "create_time": "2017-08-31T07:41:06Z",
"meta_data": {
                "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
                "metadata_eip_address": "255.255.255.255"
            }
        }
    ]
}

Returned Values

  • Normal

    200

  • Abnormal

    Returned Values

    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.

Error Codes

See Error Codes.