Skip to main content
API Explorer|API Explorer
Platform O&M/Cloud Monitoring/Monitoring and Alarm/SNS/ZWatch Operations/Text Template Operations
POSTText Template OperationsSince 3.7.0SynchronousAuth Required

CreateAliyunSmsSNSTextTemplate

CreateAliyunSmsSNSTextTemplate

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • signStringRequired

      The SMS signature.

    • alarmTemplateCodeStringRequired

      The resource alarm template code.

    • eventTemplateCodeStringRequired

      The event alarm template code.

    • eventTemplateString

      Optional. The event alarm template text.

    • nameStringRequired

      The template name.

    • descriptionString

      Optional. The detailed description of the template.

    • applicationPlatformTypeStringRequired

      The type of the SNS application platform.

    • templateStringRequired

      The resource alarm template text.

    • recoveryTemplateString

      Optional. The recovery template text.

    • defaultTemplateBoolean

      Optional. Whether to set the template as the default template.

    • resourceUuidString

      Optional.

    • tagUuidsList

      Optional. The tag UUID list.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventorySNSTextTemplateInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      Th resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • applicationPlatformTypeStringRequired

      The application platform type.

    • templateStringRequired

      The template text.

    • recoveryTemplateStringRequired

      The recovery template text.

    • defaultTemplateBooleanRequired

      Whether to set the template as the default template.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

Endpoint

POST/zstack/v1/zwatch/alarms/sns/text-templates/aliyun-sms

/zstack/v1/zwatch/alarms/sns/text-templates/aliyun-sms

Operation ID

CreateAliyunSmsSNSTextTemplate

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/zwatch/alarms/sns/text-templates/aliyun-sms' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"sign":"<sign>","alarmTemplateCode":"<alarmTemplateCode>","eventTemplateCode":"<eventTemplateCode>","eventTemplate":"<eventTemplate>","name":"<name>","description":"<description>","applicationPlatformType":"<applicationPlatformType>","template":"<template>","recoveryTemplate":"<recoveryTemplate>","defaultTemplate":true,"resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "335d5580cfad41d98e699d5d80830818", "name": "email template", "applicationPlatformType": "Email", "template": "Alarm ${ALARM_NAME} changes status to ${ALARM_CURRENT_STATUS}", "recoveryTemplate": "Resource ${EVENT_RESOURCE_ID} changes status to ${ALARM_CURRENT_STATUS}", "defaultTemplate": false, "createDate": "Oct 8, 2019 5:31:52 PM", "lastOpDate": "Oct 8, 2019 5:31:52 PM" } }

Change History

This API has no change history records yet.

View all change history