获取 IP 归属信息--视频点播-火山引擎

文档中心

立即注册

导航

获取 IP 归属信息

最近更新时间：2024.09.26 14:37:05首次发布时间：2022.06.21 20:11:03

此接口用于查询一个或者多个 IP 地址是否为火山引擎 CDN 节点的 IP 地址。

请求说明

请求地址：https://vod.volcengineapi.com?Action=DescribeIpInfo&Version=2022-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeIpInfo`	接口名称。当前 API 的名称为 `DescribeIpInfo`。
Version	String	是	`2022-01-01`	接口版本。当前 API 的版本为 `2022-01-01`。
Ips	String	是	`1.1.1.1`	IP 地址列表。多个 IP 地址之间使用换行符或者英文逗号分隔。最多支持 50 个 IP 地址。

返回参数

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

参数	类型	示例值	描述
Ip	String	`1.1.1.1`	IP 地址。
Isp	String	`电信`	IP 所属运营商。当前仅支持返回中国内地的网络运营商。如果 `CdnIp` 为 `false`，该参数值为 `"-"`。如果 `CdnIp` 为 `true` 并且 `Location` 不属于中国内地，该参数值无效。
CdnIp	Boolean	`true`	是否归属于火山引擎 CDN 服务。取值如下： `true`：属于火山引擎 CDN 的节点 IP。 `false`：不属于火山引擎 CDN 的节点 IP。
Location	String	`中国-山东省-青岛市`	IP 地址所属的国家或地区。如果 `CdnIp` 为 `false`，该参数值为 `"-"`。对于归属地属于中国内地的 IP 地址：如果归属地所属城市是一个直辖市，`Location` 展示到区级别。如果归属地所属城市不是直辖市，`Location` 展示到城市级别。

请求示例

https://vod.volcengineapi.com?Action=DescribeIpInfo&Version=2022-01-01

返回示例

{
    "Result": [
        {
            "Ip": "1.1.1.1",
            "Isp": "电信",
            "CdnIp": true,
            "Location": "中国-山东省-青岛市"
        }
    ],
    "ResponseMetadata": {
        "Action": "DescribeIpInfo",
        "Region": "cn-north-1",
        "Service": "vod",
        "Version": "2022-01-01",
        "RequestId": "20230604110420****100232280022D31"
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：