Skip to main content
API Explorer|API Explorer
O&M Management/Monitoring APIs/Monitoring and Alarm APIs/Alarm Text Template (Text Template)
PUTAlarm Text Template (Text Template)Since 2.3SynchronousAuth Required

Update Alarm Message Template

Update Alarm Message Template

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    The UUID of the resource. Uniquely identifies the resource

Body Fields

  • updatesnstexttemplateObjectRequired

    updatesnstexttemplate request body object.

    • nameString

      The resource name

    • descriptionString

      The detailed description of the resource

    • templateString

      The alarm message template text

    • recoveryTemplateString

      The recovery alarm message template text

    • defaultTemplateBoolean

      Whether it is the default template

  • systemTagsList

    System tags

  • userTagsList

    User tags

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation failed. This field is null on success. See error

    • codeStringRequired

      The error code number. A globally unique identifier for the error, such as SYS.1000, HOST.1001

    • descriptionStringRequired

      A brief description of the error

    • detailsStringRequired

      The detailed error information

    • elaborationStringRequired

      Reserved field. Default is null

    • opaqueLinkedHashMapRequired

      Reserved field. Default is null

    • causeErrorCodeRequired

      The root error. The source error that caused the current error. This field is null if there is no root error

  • inventorySNSTextTemplateInventoryRequired

    See inventory

    • uuidStringRequired

      The UUID of the resource. Uniquely identifies the resource

    • nameStringRequired

      The resource name

    • descriptionStringRequired

      The detailed description of the resource

    • applicationPlatformTypeStringRequired

      The application platform type

    • templateStringRequired

      The template text

    • recoveryTemplateStringRequired

      The template text

    • defaultTemplateBooleanRequired

      Whether it is the default template

    • createDateTimestampRequired

      The creation time

    • lastOpDateTimestampRequired

      The last modification time

Endpoint

PUT/zstack/v1/zwatch/alarms/sns/text-templates/{uuid}/actions

/zstack/v1/zwatch/alarms/sns/text-templates/{uuid}/actions

Operation ID

UpdateSNSTextTemplate

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/zwatch/alarms/sns/text-templates/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updatesnstexttemplate":{"name":"<name>","description":"<description>","template":"<template>","recoveryTemplate":"<recoveryTemplate>","defaultTemplate":true},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "cc881c03f4c04ea9a0e0dda61f4c2f00", "name": "email template", "applicationPlatformType": "Email", "template": "Alarm ${ALARM_NAME} changes status to ${ALARM_CURRENT_STATUS}", "recoveryTemplate": "Alarm ${ALARM_NAME} Resource ${ALARM_RESOURCE_NAME} changes status to ${ALARM_CURRENT_STATUS}", "defaultTemplate": false, "createDate": "Jul 6, 2018 1:51:22 PM", "lastOpDate": "Jul 6, 2018 1:51:22 PM" } }

Change History

This API has no change history records yet.

View all change history