Querying Scaling Action Logs

Function

This API is used to query scaling action logs based on search criteria. The results are displayed by page.

URI

GET /autoscaling-api/v1/{project_id}/scaling_activity_log/{scaling_group_id}

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. Scaling action logs 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_group_id

Yes

String

Specifies the AS group ID.

start_time

No

String

Specifies the start time that complies with UTC for querying scaling action logs. The format of the start time is yyyy-MM-ddThh:mm:ssZ.

end_time

No

String

Specifies the end time that complies with UTC for querying scaling action logs. The format of the end time is yyyy-MM-ddThh:mm:ssZ.

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.

Request

None

Example Request

This example queries the scaling action logs of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a.
GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_activity_log/e5d27f5c-dd76-4a61-b4bc-a67c5686719a

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_activity_log

Array of scaling_activity_log objects

Specifies scaling action logs. For details, see Table 3.

Table 3 scaling_activity_log field description

Parameter

Type

Description

status

String

Specifies the status of the scaling action.

  • SUCCESS: The scaling action has been performed.
  • FAIL: Performing the scaling action failed.
  • DOING: The scaling action is being performed.

start_time

String

Specifies the start time of the scaling action. The time format must comply with UTC.

end_time

String

Specifies the end time of the scaling action. The time format must comply with UTC.

id

String

Specifies the scaling action log ID.

instance_removed_list

String

Specifies the names of the instances removed from the AS group after the scaling action is complete. The instance names are separated using commas (,).

instance_deleted_list

String

Specifies the names of the instances removed and deleted from the AS group after the scaling action is complete. The instance names are separated using commas (,).

instance_added_list

String

Specifies the names of the instances added to the AS group after the scaling action is complete. The instance names are separated using commas (,).

scaling_value

Integer

Specifies the number of added or removed instances in the scaling action.

description

String

Specifies the description of the scaling action.

instance_value

Integer

Specifies the number of instances in the AS group.

desire_value

Integer

Specifies the expected number of instances for the scaling action.

Example Response

{
  "limit": 20,
  "scaling_activity_log": [
    {
      "id": "66e0f775-c4ac-4b52-9d5c-f93ba217aa5f",
      "instance_value": 1,
      "desire_value": 0,
      "scaling_value": 1,
      "start_time": "2019-03-18T16:00:11Z",
      "end_time": "2019-03-18T16:00:32Z",
      "instance_added_list": null,
      "instance_deleted_list": "as-config-bblh-ONQE551S",
      "instance_removed_list": null,
      "status": "SUCCESS",
      "description": "{\"reason\":[{\"change_reason\":\"RECURRENCE\",\"old_value\":1,\"scaling_policy_name\":\"as-policy-bvfk\",\"change_time\":\"2019-03-18T16:00:00Z\",\"new_value\":0,\"scaling_policy_id\":\"05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6\"}]}"
    },
    {
      "id": "c3a1fff6-84a3-4cbc-8ac0-e3b0f645ecd8",
      "instance_value": 0,
      "desire_value": 1,
      "scaling_value": 1,
      "start_time": "2019-03-16T10:21:11Z",
      "end_time": "2019-03-16T10:25:12Z",
      "instance_added_list": "as-config-bblh-ONQE551S",
      "instance_deleted_list": null,
      "instance_removed_list": null,
      "status": "SUCCESS",
      "description": "{\"reason\":[{\"change_reason\":\"DIFF\",\"old_value\":0,\"change_time\":\"2019-03-16T10:21:11Z\",\"new_value\":1}]}"
    }],
    "total_number": 2,
    "start_number": 0
}

Returned Values

Error Codes

See Error Codes.