文档首页/ 消息通知服务 SMN/ API参考（联盟区域）/ API/ 发布消息操作/ 发布探测消息
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

发布探测消息

功能介绍

基于主题发送http/https探测消息，探测当前http/https 终端是否可用，SMN出口是否能够正常访问该终端。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/notifications/topics/{topic_urn}/detection

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。 获取项目ID请参考 获取项目ID。

topic_urn

是

String

Topic的唯一的资源标识，可通过查询主题列表获取该标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

protocol

是

String

协议类型，当前仅支持http/https，不可为空

endpoint

是

String

待探测的终端地址，当前仅支持以http:// 或https://开头，不可为空

extension

否

extension object

Http/Https协议可以指定多个K/V对，在发送Http/Https协议消息时会携带这些K/V对作为请求header。extension字段允许为空，header字段允许为空。
表4 extension

参数

是否必选

参数类型

描述

header

否

Map<String,String>

header应满足如下要求：

  1. key值限定为：包含英文字母([A-Za-z])、数字([0-9])、中划线(-)hyphens，中划线不得作为结尾，不得连续出现。

  2. K/V不得超过10个

  3. key需要以"x-"开头，不能以"x-smn"开头，正确示例：x-abc-cba, x-abc

  4. 所有K/V长度总和不得超过1024个字符

  5. key不区分大小写

  6. key值不可重复

  7. value值限定为ASCII码，不支持中文或其他Unicode，支持空格

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求ID

task_id

String

探测任务ID

状态码：400

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：403

表7 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：404

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：429

表9 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码：500

表10 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

正确调用接口示例

POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/detect

{
  "protocol" : "http",
  "endpoint" : "http://172.20.0.51:32000/http_notify",
  "extension" : {
    "header" : {
      "x-abc" : "1213",
      "x-abc-cba" : "test2"
    }
  }
}

响应示例

状态码：200

发送http探测成功

{
  "request_id" : "adc82efa7e0042899722531681b1959a",
  "task_id" : "adc82efa7e0042899722531681b1959a"
}

状态码：400

发送http探测失败

{
  "request_id" : "373cdb9696e44454832ea02e61a2c689",
  "error_code" : "SMN.00011004",
  "error_msg" : "Parameter: Extension is invalid. Http header key is invalid."
}

状态码

状态码

描述

200

发送http探测成功

400

发送http探测失败

403

Unauthorized

404

Not Found

429

Too Many Requests

500

Internal Server Error

错误码

请参见错误码。

父主题： 发布消息操作