Help Center/ DataArts Fabric/ API Reference/ APIs/ Message Management/ Creating a Notification Policy

Updated on 2025-09-15 GMT+08:00

View PDF

Creating a Notification Policy

Function

This API is used to create a notification policy. You can call this API to create a message notification policy. After a job is complete, results will be sent as messages according to the matched notification policy. The API supports passing in SMN topics and job names matching regular expressions. This API is synchronous with no accompanying APIs or specific scenarios.

URI

POST /v1/workspaces/{workspace_id}/messages

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
workspace_id	Yes	String	Definition: Workspace ID. For how to obtain a workspace ID, see [Obtaining a Workspace ID] (dataartsfabric_03_0022.xml). Constraints: N/A. Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Definition: Tenant token. It is used for API calling authentication. For how to obtain a token, see [Authentication] (dataartsfabric_03_0005.xml). Constraints: N/A. Range: Up to 65,534 characters. Default Value: N/A.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
message_notification_policy_list	Yes	Array of CreateMessageNotificationPolicy objects	Definition: Notification policy. Constraints: N/A. Range: [0, 1000]. Default Value: N/A.

**Table 4** CreateMessageNotificationPolicy
Parameter	Mandatory	Type	Description
message_type	Yes	String	Definition: Message type. Constraints: N/A. Range: job: job execution result. Default Value: job.
name_pattern	Yes	String	Definition: Name pattern, which is used to match all messages that match this pattern within the message type. For example, if message_type is set to job and name_pattern is set to ray_job, messages sent by all jobs starting with ray_job* are matched. Constraints: N/A. Range: N/A. Default Value: N/A.
notification_types	Yes	Array of strings	Definition: Notification type. Constraints: SUCCESS (successful notification) or FAILED (failed notification).
topic_urn	Yes	String	Definition: Notification topic. Constraints: N/A. Range: N/A. Default Value: N/A.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
id	String	Definition: Notification policy ID. Constraints: N/A. Range: N/A. Default Value: N/A.
message_type	String	Definition: Message type. Constraints: N/A. Range: job: job execution result. Default Value: job.
name_pattern	String	Definition: Name pattern, which is used to match all messages that match this pattern within the message type. For example, if message_type is set to job and name_pattern is set to ray_job, all messages sent by jobs starting with ray_job* are matched. Constraints: N/A. Range: N/A. Default Value: N/A.
notification_types	Array of strings	Definition: Notification type. SUCCESS: successful notification; FAILED: failed notification. Constraints: [1, 2].
topic_urn	String	Definition: Notification topic. Constraints: N/A. Range: N/A. Default Value: N/A.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 408

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A.
error_msg	String	Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A.
solution_msg	String	Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A.

Example Requests

Create a notification policy. The following is an example request.

POST https://{endpoint}/v1/workspaces/{workspace_id}/messages

{
  "message_notification_policy_list" : [ {
    "message_type" : "job",
    "name_pattern" : "ray_job*",
    "notification_types" : [ "SUCCESS", "FAILED" ],
    "topic_urn" : "smn:topic:xxxxxxx"
  } ]
}

Example Responses

Status code: 200

A notification policy is created.

{
  "id" : "ray_job_123456789",
  "message_type" : "job",
  "name_pattern" : "ray_job*",
  "notification_types" : [ "SUCCESS", "FAILED" ],
  "topic_urn" : "smn:topic:xxxxxxx"
}

Status code: 400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code	Description
200	A notification policy is created.
400	BadRequest
401	Unauthorized
403	Forbidden
404	NotFound
408	Request Time-out
500	InternalServerError

Error Codes

See Error Codes.

Parent topic: Message Management

Previous topic: Message Management

Next topic: Querying the Notification Policy List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot