You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询 IP 地址归属的 CDN 节点

最近更新时间：2023.10.23 16:15:05

首次发布时间：2023.09.25 14:36:18

我的收藏

本接口用于查询指定 IP 地址是否属于火山引擎 CDN 节点。

注意事项

请求频率：单用户请求频率限制为 10QPS。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=DescribeIpInfo&Version=2023-01-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是DescribeIpInfo接口名称。当前 API 的名称为 DescribeIpInfo。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
IpsArray of String是["186.199.***.1"]待查询的 IP 地址列表。支持 IPv4 和 IPv6 地址，一次最多查询 50 个 IP 地址。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数类型示例值描述
ListArray of LiveIpInfo-IP 详情列表。

LiveIpInfo

参数类型示例值描述
IpString186.199.***.1IP 地址

LiveCdnIp

Boolean

false

是否归属于火山引擎 CDN 节点。

  • true：属于；
  • false：不属于。
LocationString中国IP 所属国家或地区。非归属火山引擎视频直播的 IP，返回“-”。
ProvinceString河北IP 所属省。非归属火山引擎视频直播的 IP，返回“-”。
CityString廊坊IP 所属地区。非归属火山引擎视频直播的 IP，返回“-”。

Isp

String

telecom

IP 所属运营商。非归属火山引擎视频直播的 IP，返回”-“。

  • telecom：中国电信；
  • unicom：中国联通；
  • mobile：中国移动；
  • btvn：广电网；
  • drpeng：鹏博士；
  • other：其他。

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeIpInfo&Version=2023-01-01
{
  "Ips": [
    "186.199.***.1"
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "2021072818053901022706413520787",
        "Action": "Ips",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "List": [
        {
            "Ip": "186.199.***.1",
            "LiveCdnIp": "false",
            "Location":"中国",
            "Province":"河北",
            "City": "廊坊", 
            "Isp": "telecom"
        }
    ]
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
400InvalidParam.Format%s format error参数格式错误，请检查错误消息中指定参数中是否存在非法字符或 URL 格式错误。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。