文档首页/ 数智融合计算服务 DataArtsFabric/ API参考/ API/ 消息管理/ 查询消息通知策略列表
更新时间：2025-04-28 GMT+08:00
查看PDF
分享

查询消息通知策略列表

功能介绍

查询消息通知策略。用户通过调用该接口查询已创建的消息通知策略。支持分页查询，根据传入的工作空间ID，消息匹配样式来查询。此接口为同步接口，无配套使用接口和特殊场景。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET https://localhost.com/v1/workspaces/{workspace_id}/messages

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

  • 参数解释：工作空间ID，获取方法，请参见获取工作空间ID。

  • 约束限制：不涉及。

  • 取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。

  • 默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

  • 参数解释：偏移量，表示从此偏移量开始查询。

  • 约束限制：不涉及。

  • 取值范围：[0,1000000000]。

  • 默认取值：0。

limit

否

Integer

  • 参数解释：指定每一页返回的最大条目数。

  • 约束限制：不涉及。

  • 取值范围：[1,100]。

  • 默认取值：10。

message_type

否

String

  • 参数解释：消息类型。

  • 约束限制：不可修改。

  • 取值范围：job：任务执行结果消息。

  • 默认取值：不涉及。

name_pattern

否

String

  • 参数解释：名称样式。

  • 约束限制：支持模糊匹配，区分大小写。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

notify_type

否

String

  • 参数解释：消息类型。

  • 约束限制：不涉及。

  • 取值范围：

    • SUCCESS：成功通知；

    • FAILED：失败通知。

  • 默认取值：不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

  • 参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。

  • 约束限制：不涉及。

  • 取值范围：长度不超过65534个字符。

  • 默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

  • 参数解释：符合条件的消息通知策略总数。

  • 约束限制：不涉及。

  • 取值范围：[0,10000]。

  • 默认取值：不涉及。

policies

Array of MessageNotificationPolicy objects

  • 参数解释：消息通知策略列表信息。

  • 约束限制：不涉及。

  • 取值范围：[0,10000]。

  • 默认取值：不涉及。
表5 MessageNotificationPolicy

参数

参数类型

描述

id

String

  • 参数解释：消息通知策略ID。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

message_type

String

  • 参数解释：消息类型。

  • 约束限制：不涉及。

  • 取值范围：

    • job：任务执行结果。

  • 默认取值：job。

name_pattern

String

  • 参数解释：名称样式，用来匹配消息类型中所有符合该样式的消息。例如：message_type设置为job，name_pattern设置为ray_job*，表示匹配到所有以"ray_job"开头的job发出的消息

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

notification_types

Array of strings

  • 参数解释：通知类型。SUCCESS：成功通知；FAILED：失败通知。

  • 约束限制：不涉及。

  • 取值范围：[1,2]。

  • 默认取值：不涉及。

topic_urn

String

  • 参数解释：消息通知主题。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：不涉及。

  • 取值范围：长度为[8,36]个字符。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：不涉及。

  • 取值范围：长度为[2,512]个字符。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：不涉及。

  • 取值范围：长度为[0,4096]个字符。

  • 默认取值：不涉及。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：不涉及。

  • 取值范围：长度为[8,36]个字符。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：不涉及。

  • 取值范围：长度为[2,512]个字符。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：不涉及。

  • 取值范围：长度为[0,4096]个字符。

  • 默认取值：不涉及。

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：不涉及。

  • 取值范围：长度为[8,36]个字符。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：不涉及。

  • 取值范围：长度为[2,512]个字符。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：不涉及。

  • 取值范围：长度为[0,4096]个字符。

  • 默认取值：不涉及。

状态码：408

表9 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：不涉及。

  • 取值范围：长度为[8,36]个字符。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：不涉及。

  • 取值范围：长度为[2,512]个字符。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：不涉及。

  • 取值范围：长度为[0,4096]个字符。

  • 默认取值：不涉及。

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：不涉及。

  • 取值范围：长度为[8,36]个字符。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：不涉及。

  • 取值范围：长度为[2,512]个字符。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：不涉及。

  • 取值范围：长度为[0,4096]个字符。

  • 默认取值：不涉及。

请求示例

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

响应示例

状态码：200

查询消息通知策略列表响应体。

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

状态码：400

BadRequest

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

状态码：401

Unauthorized

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

状态码：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"
}

状态码：404

NotFound

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

状态码：408

Request Time-out

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

状态码：500

InternalServerError

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

状态码

状态码

描述

200

查询消息通知策略列表响应体。

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

408

Request Time-out

500

InternalServerError

错误码

请参见错误码。

父主题： 消息管理

相关文档