type AlarmAction

  • Trust token for executing actions

    The trust token of the user executing the API is created during the API call for new alarm registration or alarm updating (only for the first-time execution as that user).

    This trust token is used for the execution of actions and should not be deleted. The trust token will be created with the following values for their attributes (refer to the management API for details on the trust token):

    • expires_at: null
    • impersonation: false
    • project_id: Project ID of the user that executed the API for creating an alarm or updating an alarm
    • remaining_uses: null
    • trustee_user_id: User ID of the monitoring service (trustee)
    • trustor_user_id: ID of the user (trustor) that executed the API for creating an alarm or updating an alarm

    If this trust token is deleted by mistake, if the trust token trustor user (trustor_user_id) is deleted, or if the user role of the trust token trustor user (trustor_user_id) is changed or deleted, action execution results in an error.

    In that event, re-create a trust token by executing the API for new alarm registration or alarm updating.

  • Email recipients of email send actions

    Email recipients must be users assigned to the following roles in their own domain:

    • Contractor (cpf_org_manager)
    • Administrator (cpf_admin)
  • The alarm setting method for virtual server auto scaling and automatic recovery by scaling group (AutoScalingGroup) definition

    must be configured using a Heat template. Refer to the "Features Handbook" and the "Heat Template Specifications" for details.

service

Specifies the target service of an action.
  • compute: Compute
  • mail: Email
Data type Cardinality Parent element Child element
Enum 0..1 None None

action

Specifies the action to be executed.

The actions that can be specified differ for each service.
  • If the service is compute:

    stop: Stop the instance

    terminate: Terminate the instance

  • If the service is mail:

    send: Send an email

Data type Cardinality Parent element Child element
String 0..1 None None

parameters

Specifies the parameters of an action.

The content to be specified differs for each service.
  • If the service is compute:

    server_id: ID of the target instance.

  • If the service is mail:

    Specify a null object ({}) for the value.

Data type Cardinality Parent element Child element
String 0..1 None None