查询消息通知服务器 IP

更新时间不可用

查询消息通知服务器的 IP 地址或 IP 地址列表。

GET
https://api.sd-rtn.com/v1/ncs/ip

背景:开通消息通知服务后,声网消息通知服务可以将云端转码业务中的一些事件以 HTTPS 请求的方式通知到你的服务器。声网会动态调整消息通知服务器的 IP 地址,周期为 24 小时。

用法:你可以通过本方法查询 IP 地址。查询后,需要将 IP 地址或 IP 地址列表添加到白名单中。

注意

我们强烈推荐你至少每 24 小时进行一次查询,并自动更新防火墙配置,否则可能会影响你接收通知。

鉴权

Basic Auth

声网云端转码 RESTful API 仅支持 HTTPS 协议。发送请求时,你需要使用声网提供的客户 ID 和客户密钥生成 Base64 编码凭证,并填入请求头部的 Authorization 字段中。详见实现 HTTP 基本认证。

响应

如果返回的 HTTP 状态码为 200,表示请求成功。

你只需关心响应 Body 中的 PrimaryIP 字段,无需关心响应 Header 以及响应 Body 中的其他字段。

响应 Body

字段

请求示例

Example Request
curl --request GET \
  --url "https://api.sd-rtn.com/v1/ncs/ip" \
  --header 'Authorization: Basic <credentials>'

响应示例

{
  "data": {
    "service": {
      "hosts": [
        {
          "primaryIP": "xxx.xxx.xxx.xxx"
        },
        {
          "primaryIP": "xxx.xxx.xxx.xxx"
        }
      ]
    }
  }
}