DescribeIpInfo - 查询 IP 地址归属的 CDN 节点--视频直播-火山引擎

文档中心

立即注册

导航

DescribeIpInfo - 查询 IP 地址归属的 CDN 节点

最近更新时间：2024.12.09 11:16:51首次发布时间：2023.09.25 14:36:18

调用 DescribeIpInfo 接口，查询 IP 地址是否为火山引擎归属的 CDN 节点，以及节点的区域和运营商信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

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

返回参数

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

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

LiveIpInfo

参数	类型	示例值	描述
Ip	String	`186.199.***.1`	IP 地址。
LiveCdnIp	Boolean	`false`	当前 IP 地址是否是归属于火山引擎的 CDN 节点 IP。 `true`：属于； `false`：不属于。
Location	String	`中国`	CDN 节点所属国家或地区信息。非归属火山引擎的 CDN 节点 IP 时，返回“-”。
Province	String	`河北`	CDN 节点所属省份信息。非归属火山引擎 CDN 节点的 IP 时，返回“-”。
City	String	`廊坊`	CDN 节点所属城市信息。非归属火山引擎的 CDN 节点 IP 时，返回“-”。
Isp	String	`telecom`	CDN 节点所属网络运营商。非归属火山引擎 CDN 节点的 IP 时，返回”-“。您可以通过 DescribeLiveISPData 接口查看运营商标识符对应的运营商名称。

请求示例

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"
        }
    ]
}

错误码

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

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

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。