调用 DescribeLiveRegionData 接口，查询火山引擎视频直播服务覆盖的区域标识符。获取区域标识符后您可以在支持以区域为查询维度的接口中使用区域标识符查询指定区域的维度数据。
注意事项
请求频率：单用户请求频率限制为 30 次/秒。
请求说明
- 请求方式：POST
- 请求地址：https://live.volcengineapi.com?Action=DescribeLiveRegionData&Version=2023-01-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | DescribeLiveRegionData | 接口名称。当前 API 的名称为 DescribeLiveRegionData。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Areas | Array of Areas | - | 区域信息。 |
Areas
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Code | String | CN | 大区标识符。 |
| Name | String | 中国 | 大区名称。 |
| Countries | Array of Countries | - | 国家信息。 |
Countries
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Code | String | CN | 国家标识符。 |
| Name | String | 中国 | 国家名称。 |
| Provinces | Array of Provinces | - | 省份信息，国外暂不支持该参数。 |
Provinces
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Code | String | beijing | 省份标识符。 |
| Name | String | 北京 | 省份名称。 |
请求示例
POST https://live.volcengineapi.com?Action=DescribeLiveRegionData&Version=2023-01-01
返回示例
{
"ResponseMetadata": {
"RequestId": "20230831140335992B73F008D5242E199D",
"Action": "DescribeLiveRegionData",
"Version": "2023-01-01",
"Service": "live",
"Region": "cn-north-1"
},
"Result": {
"Areas": [
{
"Code": "CN",
"Name": "中国",
"Countries": [
{
"Code": "CN",
"Name": "中国",
"Provinces": [
{
"Code": "beijing",
"Name": "北京"
},
{
"Code": "shanghai",
"Name": "上海"
},
{
"Code": "tianjin",
"Name": "天津"
}
]
}
]
},
{
"Code": "AP1",
"Name": "亚太一区",
"Countries": [
{
"Code": "CN",
"Name": "中国",
"Provinces": [
{
"Code": "HK",
"Name": "香港"
},
{
"Code": "MO",
"Name": "澳门"
}
]
},
{
"Code": "TH",
"Name": "泰国",
"Provinces": []
},
{
"Code": "SG",
"Name": "新加坡",
"Provinces": []
}
]
},
{
"Code": "AP2",
"Name": "亚太二区",
"Countries": [
{
"Code": "CN",
"Name": "中国",
"Provinces": [
{
"Code": "TW",
"Name": "台湾"
}
]
},
{
"Code": "ID",
"Name": "印度尼西亚",
"Provinces": []
}
]
},
{
"Code": "AP3",
"Name": "亚太三区",
"Countries": [
{
"Code": "KR",
"Name": "韩国",
"Provinces": []
},
{
"Code": "AU",
"Name": "澳大利亚",
"Provinces": []
},
{
"Code": "NZ",
"Name": "新西兰",
"Provinces": []
}
]
},
{
"Code": "NA",
"Name": "北美",
"Countries": [
{
"Code": "US",
"Name": "美国",
"Provinces": []
},
{
"Code": "CA",
"Name": "加拿大",
"Provinces": []
},
{
"Code": "MX",
"Name": "墨西哥",
"Provinces": []
}
]
},
{
"Code": "SA",
"Name": "南美",
"Countries": [
{
"Code": "BR",
"Name": "巴西",
"Provinces": []
},
{
"Code": "AR",
"Name": "阿根廷",
"Provinces": []
},
{
"Code": "CL",
"Name": "智利",
"Provinces": []
}
]
},
{
"Code": "EU",
"Name": "欧洲",
"Countries": [
{
"Code": "GB",
"Name": "英国",
"Provinces": []
},
{
"Code": "NL",
"Name": "荷兰",
"Provinces": []
},
{
"Code": "FR",
"Name": "法国",
"Provinces": []
}
]
},
{
"Code": "MEAA",
"Name": "中东",
"Countries": [
{
"Code": "TR",
"Name": "土耳其",
"Provinces": []
},
{
"Code": "SA",
"Name": "沙特阿拉伯",
"Provinces": []
},
{
"Code": "BH",
"Name": "巴林",
"Provinces": []
}
]
},
{
"Code": "OTHER",
"Name": "其他",
"Countries": []
}
]
}
}
错误码
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|
| 200 | CommonErr | - | 未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 400 | InvalidParam | - | 输入的参数无效或不符合要求，请参照请求参数说明进行检查。 |
| 400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验，请检查参数类型是否正确。 |
| 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. | 出现内部错误，请联系技术支持。 |
| 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。